\n\nPM2 is a General Purpose Process Manager and a Production Runtime for Node.js apps with a built-in Load Balancer.\n\nKey features:\n- Simple and efficient process management (start/stop/restart/delete/show/monit)\n- Keep your application ALWAYS ONLINE with auto restarts and init system script generation\n- Clusterize Node.js Applications without code change to increase performance and reliability\n- Hot Reload Node.js Applications without extra configuration\n\nStarting an application in production mode is as easy as:\n\n```bash\n$ pm2 start app.js\n```\n\nPM2 is constantly assailed by [more than 1800 tests](https://travis-ci.org/Unitech/pm2).\n\nOfficial website: [http://pm2.keymetrics.io/](http://pm2.keymetrics.io/)\n\nWorks on Linux (stable) & macOS (stable) & Windows (stable).\nAll Node.js versions are supported starting Node.js 0.12.\n\n[](https://nodei.co/npm/pm2/)\n\n### Installing PM2\n\n```bash\n$ npm install pm2 -g\n```\n\n*npm is a builtin CLI when you install Node.js - [Installing Node.js with NVM](https://keymetrics.io/2015/02/03/installing-node-js-and-io-js-with-nvm/)*\n\n### Start an application\n\nYou can start any application (Node.js, Python, Ruby, binaries in $PATH...) like that:\n\n```bash\n$ pm2 start app.js\n```\n\nYour app is now daemonized, monitored and kept alive forever.\n\n[More about Process Management](http://pm2.keymetrics.io/docs/usage/process-management/)\n\n### Managing a Process\n\nOnce applications are started you can manage them easily:\n\n\n\nTo list all running processes:\n\n```bash\n$ pm2 list\n```\n\nManaging processes is straightforward:\n\n```bash\n$ pm2 stop \n$ pm2 restart \n$ pm2 delete \n```\n\nTo have more details on a specific process:\n\n```bash\n$ pm2 describe \n```\n\nTo monitor logs, custom metrics, process information:\n\n```bash\n$ pm2 monit\n```\n\n[More about Process Management](http://pm2.keymetrics.io/docs/usage/process-management/)\n\n### Cluster Mode: Node.js Load Balancing & Hot Reload\n\nThe Cluster mode is a special mode when starting a Node.js application, it starts multiple processes and load-balance HTTP/TCP/UDP queries between them. This increase overall performance (by a factor of x10 on 16 cores machines) and reliability (faster socket re-balancing in case of unhandled errors).\n\nStarting a Node.js application in cluster mode that will leverage all CPUs available:\n\n```bash\n$ pm2 start api.js -i \n```\n\n`` can be `'max'`, `-1` (all cpu minus 1) or a specified number of instances to start.\n\n**Hot Reload**\n\nHot Reload allows to update an application without any downtime:\n\n```bash\n$ pm2 reload all\n```\n\nSeamlessly supported by all major Node.js frameworks and any Node.js applications without any code change:\n\n\n\n[More informations about how PM2 make clustering easy](https://keymetrics.io/2015/03/26/pm2-clustering-made-easy/)\n\n### Container Support\n\nWith the drop-in replacement command for `node`, called `pm2-runtime`, run your Node.js application in a proper production environment.\nWe also offer an [officialy supported Docker image](https://hub.docker.com/r/keymetrics/pm2/).\n\nUsing it is seamless:\n\n```\nFROM keymetrics/pm2:latest-alpine\n[...]\nCMD [ \"pm2-runtime\", \"npm\", \"--\", \"start\" ]\n```\n\n[Read More about the dedicated integration](http://pm2.keymetrics.io/docs/usage/docker-pm2-nodejs/)\n\n### Terminal Based Monitoring\n\n\n\nMonitor all processes launched straight from the command line:\n\n```bash\n$ pm2 monit\n```\n\n### Monitor PM2 and Applications with our SaaS\n\nOnce you deploy your application in production, you can monitor, debug and profile it externally with our [SaaS Monitoring](https://keymetrics.io).\n\nTo start monitoring applications from the terminal:\n\n```bash\n$ pm2 register\n```\n\n[More about PM2 Monitoring](http://docs.keymetrics.io/)\n\n### Expose Custom Metrics\n\nTo get more insights on how your application behave, plug custom metrics inside your code and monitor them with the `pm2 monit` command:\n\nIn your project install [pmx](https://github.com/keymetrics/pmx):\n\n```bash\n$ npm install pmx --save\n```\n\nThen plug a custom metric:\n\n```javascript\nvar Probe = require('pmx').probe();\n\nvar counter = 1;\n\nvar metric = Probe.metric({\n name : 'Counter',\n value : function() {\n return counter;\n }\n});\n\nsetInterval(function() {\n counter++;\n}, 1000);\n```\n\nThen to see the metric type from in the terminal:\n\n```bash\n$ pm2 monitor\n```\n\nMetric, Counter, Histogram and Meters are [available](http://pm2.keymetrics.io/docs/usage/process-metrics/)\n\n### Log facilities\n\n\n\nDisplaying logs of a specified process or all processes, in real time is easy:\n\n```bash\n$ pm2 logs ['all'|app_name|app_id] [--json] [--format] [--raw]\n```\n\nStandard, Raw, JSON and formated output are available.\n\nExamples:\n\n```bash\n$ pm2 logs APP-NAME # Display APP-NAME logs\n$ pm2 logs --json # JSON output\n$ pm2 logs --format # Formated output\n\n$ pm2 flush # Flush all logs\n$ pm2 reloadLogs # Reload all logs\n```\n\n[More about log management](http://pm2.keymetrics.io/docs/usage/log-management/)\n\n### Startup script generation\n\nPM2 can generates and configure a startup script to keep PM2 and your processes alive at every server restart.\n\nSupports init systems like: **systemd** (Ubuntu 16, CentOS, Arch), **upstart** (Ubuntu 14/12), **launchd** (MacOSx, Darwin), **rc.d** (FreeBSD).\n\n```bash\n# Auto detect init system + generate and setup PM2 boot at server startup\n$ pm2 startup\n\n# Manually specify the startup system\n# Can be: systemd, upstart, launchd, rcd\n$ pm2 startup [platform]\n\n# Disable and remove PM2 boot at server startup\n$ pm2 unstartup\n```\n\nTo save/freeze a process list on reboot:\n\n```bash\n$ pm2 save\n```\n\n[More about startup scripts](http://pm2.keymetrics.io/docs/usage/startup/)\n\n### Commands Cheatsheet\n\n```bash\n# General\n$ npm install pm2 -g # Install PM2\n$ pm2 start app.js # Start, Daemonize and auto-restart application (Node)\n$ pm2 start app.py # Start, Daemonize and auto-restart application (Python)\n$ pm2 start npm -- start # Start, Daemonize and auto-restart Node application\n\n# Cluster Mode (Node.js only)\n$ pm2 start app.js -i 4 # Start 4 instances of application in cluster mode\n # it will load balance network queries to each app\n$ pm2 reload all # Zero Second Downtime Reload\n$ pm2 scale [app-name] 10 # Scale Cluster app to 10 process\n\n# Process Monitoring\n$ pm2 list # List all processes started with PM2\n$ pm2 list --sort= # Sort all processes started with PM2\n$ pm2 monit # Display memory and cpu usage of each app\n$ pm2 show [app-name] # Show all information about application\n\n# Log management\n$ pm2 logs # Display logs of all apps\n$ pm2 logs [app-name] # Display logs for a specific app\n$ pm2 logs --json # Logs in JSON format\n$ pm2 flush\n$ pm2 reloadLogs\n\n# Process State Management\n$ pm2 start app.js --name=\"api\" # Start application and name it \"api\"\n$ pm2 start app.js -- -a 34 # Start app and pass option \"-a 34\" as argument\n$ pm2 start app.js --watch # Restart application on file change\n$ pm2 start script.sh # Start bash script\n$ pm2 start app.json # Start all applications declared in app.json\n$ pm2 reset [app-name] # Reset all counters\n$ pm2 stop all # Stop all apps\n$ pm2 stop 0 # Stop process with id 0\n$ pm2 restart all # Restart all apps\n$ pm2 gracefulReload all # Gracefully reload all apps in cluster mode\n$ pm2 delete all # Kill and delete all apps\n$ pm2 delete 0 # Delete app with id 0\n\n# Startup/Boot management\n$ pm2 startup # Detect init system, generate and configure pm2 boot on startup\n$ pm2 save # Save current process list\n$ pm2 resurrect # Restore previously saved processes\n$ pm2 unstartup # Disable and remove startup system\n\n$ pm2 update # Save processes, kill PM2 and restore processes\n$ pm2 init # Generate a sample js configuration file\n\n# Deployment\n$ pm2 deploy app.json prod setup # Setup \"prod\" remote server\n$ pm2 deploy app.json prod # Update \"prod\" remote server\n$ pm2 deploy app.json prod revert 2 # Revert \"prod\" remote server by 2\n\n# Module system\n$ pm2 module:generate [name] # Generate sample module with name [name]\n$ pm2 install pm2-logrotate # Install module (here a log rotation system)\n$ pm2 uninstall pm2-logrotate # Uninstall module\n$ pm2 publish # Increment version, git push and npm publish\n```\n\nAlso check out the [example folder](https://github.com/Unitech/pm2/tree/master/examples) to discover all features.\n\n## Updating PM2\n\n```bash\n# Install latest PM2 version\n$ npm install pm2@latest -g\n# Save process list, exit old PM2 & restore all processes\n$ pm2 update\n```\n\n*PM2 updates are seamless*\n\n## Module system\n\nPM2 embeds a simple and powerful module system. Installing a module is straightforward:\n\n```bash\n$ pm2 install \n```\n\nHere are some PM2 compatible modules (standalone Node.js applications managed by PM2):\n\n[**pm2-logrotate**](https://github.com/pm2-hive/pm2-logrotate) auto rotate logs of PM2 and applications managed \n[**pm2-webshell**](https://github.com/pm2-hive/pm2-webshell) expose a fully capable terminal in browsers \n[**pm2-server-monit**](https://github.com/pm2-hive/pm2-server-monit) monitor your server health \n\n[Writing your own module](http://pm2.keymetrics.io/docs/advanced/pm2-module-system/)\n\n## Keymetrics monitoring\n\n[](https://app.keymetrics.io/#/register)\n\nIf you manage your NodeJS app with PM2, Keymetrics makes it easy to monitor and manage apps across servers.\nFeel free to try it:\n\n[Discover the monitoring dashboard for PM2](https://app.keymetrics.io/#/register)\n\nThanks in advance and we hope that you like PM2!\n\n## More about PM2\n\n- [Application Declaration via JS files](http://pm2.keymetrics.io/docs/usage/application-declaration/)\n- [Watch & Restart](http://pm2.keymetrics.io/docs/usage/watch-and-restart/)\n- [PM2 API](http://pm2.keymetrics.io/docs/usage/pm2-api/)\n- [Deployment workflow](http://pm2.keymetrics.io/docs/usage/deployment/)\n- [PM2 on Heroku/Azure/App Engine](http://pm2.keymetrics.io/docs/usage/use-pm2-with-cloud-providers/)\n- [PM2 auto completion](http://pm2.keymetrics.io/docs/usage/auto-completion/)\n- [Using PM2 in ElasticBeanStalk](http://pm2.keymetrics.io/docs/tutorials/use-pm2-with-aws-elastic-beanstalk/)\n- [PM2 Tutorial Series](https://futurestud.io/tutorials/pm2-utility-overview-installation)\n\n## CHANGELOG\n\n[CHANGELOG](https://github.com/Unitech/PM2/blob/master/CHANGELOG.md)\n\n## Contributors\n\n[Contributors](http://pm2.keymetrics.io/hall-of-fame/)\n\n## License\n\nPM2 is made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0).\nWe can deliver other licenses, for more informations [contact sales](mailto:sales@keymetrics.io).\n\n[](https://github.com/igrigorik/ga-beacon)\n","readmeFilename":"README.md"}
![\"pm2](\"https://raw.githubusercontent.com/Unitech/pm2/master/pres/pm2-v4.png\")
\n \n ![\"npm](\"https://badge.fury.io/js/pm2.svg\"){kind=icon}
\n\n\n\n ![\"NPM](\"https://img.shields.io/npm/dm/pm2.svg?style=flat-square\"/)
\n\n\n\n ![\"Build](\"https://travis-ci.org/Unitech/pm2.svg?branch=master\")
\n\n\n\n