@imskully/pm2-auto-pull

PM2 Auto Pull

A simple and efficient PM2 module that automatically pulls the latest git version for your pm2 processes, an improved implementation of keymetrics/pm2-auto-pull.

• ⚡️ Fast and lightweight with minimal overhead!
• 🔧 Easy to install, ready to go immediately after installation
• 📝 Adjustable update-check interval to pull at specific intervals
• 🖱️ PM2 Dashboard action to manually trigger update fetches

Installation & Setup

1. Install the module via pm2:

   pm2 install @imskully/pm2-auto-pull

   [!IMPORTANT]
   Use pm2 install, not npm install!

2. (Optional) The default fetch interval is 30 seconds, configure the update interval with the following command:

   pm2 set @imskully@pm2-auto-pull:interval <ms>

3. The module should restart and begin fetching on the configured interval!

Usage

Once the module is installed and configured, it will automatically begin checking for any updates for all running processes from their respective connected git version controls, any offline processes will be skipped.

[!WARNING]
This module will git reset --hard to the latest version (HEAD) from your configured git remote and will overwrite any local changes that have not been committed or stashed!

You can optionally enable verbose logging to see when an interval check is run along with an output of all processes that were checked, skipped, and updated:

pm2 set @imskully/pm2-auto-pull:logging true

At any time, you can view when the last update check has run and other configured settings with:

pm2 show @imskully/pm2-auto-pull

Uninstalling

To uninstall the module, simply run:

pm2 uninstall @imskully/pm2-auto-pull

This will remove the module from your PM2 configuration and stop it from running, you may also want to remove any configuration variables that were set:

pm2 unset @imskully/pm2-auto-pull:interval
pm2 unset @imskully/pm2-auto-pull:logging