PM2 Command List
PM2
PM2 is a production-grade Node.js (and now Python) server, which can track changes in files, automatically restart services, remain running when logged out, and provide centralized logs.
To start a Node application, follow the instructions at Node.js Web Applications on Tux.
For Python applications, follow the instructions at Python Web Applications on Tux.
For more information on how to use PM2 to manage your application, continue reading.
pm2 start
pm2 start {{app-name}} [--interpreter {{interpreter}}] [--watch]pm2 start is the command used to start your application and add it to your managed process list. Once you start an application, pm2 can remember that it's running and automatically restart it for you.
When used with Node.js applications, no additional options are required.
When used with Python applications, you'll need to include the option --interpreter {{interpreter}} , replacing {{interpreter}} with the path to your Python binary, typically in the virtual environment you've created.
You can append the option --watch to have pm2 monitor the file for changes, allowing you to edit your code on Tux and it should automatically reload when you save your changes.
pm2 status
pm2 statuspm2 status gives you information about the processes you have running.
The id and name fields are interchangeable and can be used to identify processes for commands like pm2 logs, pm2 stop, and pm2 delete.
The status field tells you if your process is running - if it is in errored state, you should examine the logs to determine why the app has failed.
pm2 logs
pm2 logs [{{application_name}}]To view logs for your applications, run the command "pm2 logs". This will show a live view of logs for all of your processes, which can be helpful for troubleshooting
If you are running multiple processes, append the name of your application (or the process number retrieved through pm2 status) to see logs for only that process.
To exit the log viewer, type ctrl-c.
pm2 stop
pm2 stop {{app-name}}pm2 stop can be used to stop a process that's currently running. Stopped processes can be resumed later and will remain in pm2 status output in stopped state.
pm2 delete
pm2 delete {{app-name}}pm2 delete can be used to stop a process and remove it from your process list. You should run this command when your project is complete and you no longer need to run your processes.
pm2 save
pm2 savepm2 save will save the current status of your processes and will automatically resume them if the system needs to be rebooted. This should be run after you modify the processes you have running. pm2 status will often tell you to run pm2 save if the saved list is out of sync with your current running processes.