docs · pre-release
Menu
Get it running / pm2 verb reference

pm2 verb reference

Every pm2 verb and what to type instead. Where the two differ in behaviour rather than in spelling, the note says so.

The table

pm2shepnote
pm2 start <script>shep start <script>
pm2 start ecosystem.config.jsshep import pm2, then shep start Flockfile.tomlshep never reads a pm2 ecosystem file directly
pm2 stopshep stop
pm2 restartshep restart
pm2 reloadshep reloadN instances on one port need the app to set SO_REUSEPORT: see below
pm2 deleteshep delete
pm2 list / ls / statusshep flockalias: list, ls
pm2 describeshep describe
pm2 logsshep bleatsalias: logs
pm2 scale <name> <n>shep stock <name> <n>alias: scale (always an absolute count in both)
pm2 saveshep saveoptional: shep keeps the roll current itself
pm2 resurrectshep musterhidden alias: resurrect
pm2 startupshep startup
pm2 unstartupshep unstartup
pm2 killshep kill
pm2 flushshep flush
pm2 serve <dir>shep serve <dir>three defaults flip: see below
pm2-runtimeshep runtimeor the shep-runtime alias binary
pm2 sendSignalshep signal
-shep whisperno pm2 equivalent: writes a line to an app's stdin
pm2 triggershep triggerdifferent mechanism: pm2 calls a module method, shep sends over the app's own shepherd channel
pm2 monitshep lookoutalias: dash (a fuller dashboard, not a straight swap). shep flock --follow redraws the same table in place, if that is all you want
pm2-server-monitshep flock --followa separately installed pm2 module. In shep the host line comes with the followed listing
-shep enable / disable / adopt / rehomedogs have no pm2 analogue
-shep set / get / unsetthe KV store; nothing in pm2 does this