How do I use the EASY API/CLI with PM2?

[smashah]

It would be useful to not need to worry about the process stopping once i stop my terminal. PM2 is also useful on reboots.

[smashah]

@github-actions run

⚡ Release! ⚡

(async () => {
function exec(cmd) {
  console.log(execSync(cmd).toString());
}
//set the version type
process.env.VERS = "minor"

// Config
const gitUserEmail = "github-actions[bot]@users.noreply.github.com";
const gitUserName = "github-actions[bot]";

exec(`echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc`);
exec(`git config --global user.email "${gitUserEmail}"`);
exec(`git config --global user.name "${gitUserName}"`);
exec(`npm i -D`);
exec(`npm run release-ci $VERS`);

// types only package
exec('npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN')
exec(`cd ./types-only && npm version $VERS && npm run build && npm publish && cd ..`);
exec(`git commit -a -m 'updated types-only package'`);
exec(`git push --force`);

//comment on the issue
var result = execSync(`npx auto-changelog -o ./tempchangelog.txt --commit-limit false --template ./compact-keepachangelog.hbs --stdout`).toString();

    await postComment(result);

//create changelog image
exec(`npm run release-image`);
exec(`git commit -a -m 'updated release-image'`);
exec(`git push --force`);
  })();

[smashah]

Changelog

🚀 Release 4.35.0 (2022-04-12)

• Release 4.35.0 d6f8720
• ✨ feat [CLI]: --pm2to offload EASY API topm2 #2374 [339c40b`](339c40b)
• 🥚 patches update 483f607
• 🥚 patches update 8ebd5fa
• updated types-only package 1c0887d

[smashah]

As of V4.35.0, you can now offload the EASY API/CLI process to pm2. This is convenient to bring back sessions upon restarts, managing memory usage, etc.

Examples:

1. Simple offload

Just set --pm2, the name of the process is taken by the --session-id flag (default: @OPEN-WA EASY API)

> npx @open-wa/wa-automate --pm2 --session-id STICKER-BOT

Note: it will not pick up session ID from cli.config.json

If you want to keep your existing session ID but want to change the name of the pm2 process you can use --name flag instead.

> npx @open-wa/wa-automate --pm2 --name STICKER-BOT

2. With PM2 flags

PM2 itself has some powerful features (e.g restarting a process if it reaches a certain memory threshold. You can tap into those features by adding pm2 cli flags.

> npx @open-wa/wa-automate --pm2 "--max-memory-restarts 300M --cron-restart=\"0 */3 * * *\" --restart-delay=3000" --name STICKER-BOT

Note: You have to use the above format, --pm2="--max-memory-restarts 300M" (i.e using an = sign between the flag and the value) will not work.

[ahmeaqas]

We'll update the post soon.

[ahmeaqas]

If you want to auto start using pm2 then have a look here. Autostart @open-wa/wa-automate on Raspberry Pi using pm2

[smashah]

Cool write up @HobbytronicsPK !

You can now achieve the same thing with:

> npx @open-wa/wa-automate --pm2 "--max-memory-restarts 300M --restart-delay 20000" --name STICKER-BOT --ras-pi --useChrome --multiDevice

[ahmeaqas]

It produces following error

[PM2] Spawning PM2 daemon with pm2_home=/root/.pm2
[PM2] PM2 Successfully daemonized

  error: unknown option `--max-memory-restarts'

[smashah]

@HobbytronicsPK show all of your logs and the exact command you used and pm2 --version

[ahmeaqas]

@HobbytronicsPK show all of your logs and the exact command you used and pm2 --version

npx @open-wa/wa-automate --pm2 "--max-memory-restarts 300M --restart-delay 20000" --name STICKER-BOT --ras-pi --useChrome --multiDevice

[smashah]

Make sure you're using the latest pm2.

Cli does not accept camel case (multiDevice). You have to use "kebab" case (multi-device).

npx @open-wa/wa-automate --pm2 "--max-memory-restarts 300M --restart-delay 20000" --name STICKER-BOT --ras-pi --use-chrome --multi-device