ChatGPT解决这个技术问题 Extra ChatGPT

Can pm2 run an 'npm start' script

Is there a way for pm2 to run an npm start script or do you just have to run pm2 start app.js

So in development

npm start

Then in production with pm2 you would run something like

pm2 start 'npm start'

There is an equivalent way to do this in forever:

forever start -c "npm start" ./
This is extension to Answer given by Dhaval stackoverflow.com/a/37775318/4828326 1. First add pm2 to your package.json 2. For development mode, update your package json script like this: "pm2:dev": "node_modules/pm2/bin/pm2-dev start npm -- start",

I
Ionică Bizău

PM2 now supports npm start:

pm2 start npm -- start

To assign a name to the PM2 process, use the --name option:

pm2 start npm --name "app name" -- start

How can you set a name for the process when using this command? I tried using --name "app" but it just set it to npm.
pm2 start npm --name "Your APP Name" -- start
Anyone know how to set npm start in the process file?
How comes I got "stopped" status when I try this? my start script looks like this "start": "cross-env NODE_ENV=production nodemon dist-prod/server.js"
ah, I think I found the answer to my question. It's not a pm2 or npm thing, it seems to be a *nix way of saying "I'm done giving command options and want to start passing arguments": unix.stackexchange.com/questions/11376/…
J
Jyotman Singh

Those who are using a configuration script like a .json file to run the pm2 process can use npm start or any other script like this -

my-app-pm2.json

{
    "apps": [
        {
            "name": "my-app",
            "script": "npm",
            "args" : "start"
        }
    ]
}

Then simply -

pm2 start my-app-pm2.json

Edit - To handle the use case when you have this configuration script in a parent directory and want to launch an app in the sub-directory then use the cwd attribute.

Assuming our app is in the sub-directory nested-app relative to this configuration file then -

{
    "apps": [
        {
            "name": "my-nested-app",
            "cwd": "./nested-app",
            "script": "npm",
            "args": "start"
        }
    ]
}

More detail here.


how does this work if I want to run the start npm script from a parent folder?
Could you elaborate a bit more? I assume you're asking How to run npm start from outside the project directory? .
I'm using the configuration script to run multiple node apps that are in sub-folders. The package.json with the start script information is in one of them. See this gist: gist.github.com/gianpaj/04c5680a8275616aac5e46374e07f673 When I run this it doesn't know where npm should run from. Thx
@GianfrancoP. You can use the cwd attribute. Check my edited answer :)
I tried to use sudo npm and it shows access error to create a directory tough I have given all the permission to user as root and also running pm2 command as sudo pm2 start config.json
c
carkod

To use npm run

pm2 start npm --name "{app_name}" -- run {script_name}


Indeed, I agree with @Adiii , given that it can be run as an npm script, it just doesn't get any better than that!
j
jcollum

Yes. Use pm2 start npm --no-automation --name {app name} -- run {script name}. It works. The --no-automation flag is there because without it PM2 will not restart your app when it crashes.


Do you have any idea how to use this flag inside of the ecosystem.js configuration file?
UPDATE: Okay I found it you need to specify "automation": false.
@twigg pm2 --help | grep 'no-autom' returns one line for me in version 1.0.2
T
Tomer Omri

I needed to run a specific npm script on my app in pm2 (for each env) In my case, it was when I created a staging/test service

The command that worked for me (the args must be forwarded that way):

pm2 start npm --name "my-app-name" -- run "npm:script"

examples:

pm2 start npm --name "myApp" -- run "start:test"

pm2 start npm --name "myApp" -- run "start:staging"

pm2 start npm --name "myApp" -- run "start:production"

Hope it helped


notice that there is a space in between "-- run". Space needs to be there else you will get invalid option run.
M
Mike

you need to provide app name here like myapp

pm2 start npm --name {appName} -- run {script name}

you can check it by

pm2 list

you can also add time

pm2 restart "id" --log-date-format 'DD-MM HH:mm:ss.SSS'

or

pm2 restart "id" --time

you can check logs by

pm2 log "id"

or

pm2 log "appName"

to get logs for all app

pm2 logs

Hi, @pharaj_ali, can you explain this part -- run {script name} ? I can't found it on the pm2 documentation. I've read on the edit history of your answer and I've found this interesting edit: in case of different script name use run with script name and in case of start script no need to add run. If I understand, using run {script name} is for multiple script and with only npm start it's more relevant to use pm2 start npm --name {appName} -- start? Plus I don't understand why the space between --and start/run any suggestions? Thanks
Hi @YohanW.Dunon yes you are right while running npm, if we are using start script then we don't need to use run there npm start but in case of other script we use run like npm run {script name} for the case of space between --, I think it is simply the way they use (not sure) let me know if you find answer for that
p
peccu

I wrote shell script below (named start.sh). Because my package.json has prestart option. So I want to run npm start.

#!/bin/bash
cd /path/to/project
npm start

Then, start start.sh by pm2.

pm2 start start.sh --name appNameYouLike

That's nice. Unfortunately this doesn't work when using the startOrRestart command.
@xpepermint just use the -f flag at the end. It forces a start. (i.e it'll restart if already started)
K
KARTHIKEYAN.A

Yes we can, now pm2 support npm start, --name to species app name.

pm2 start npm --name "app" -- start

This is the answer which really helped me. Thanks a lot.
j
jdnichollsc

See to enable clustering:

pm2 start npm --name "AppName" -i 0 -- run start

What do you think?


what does the -i 0 do?
Start maximum processes depending on available CPUs (cluster mode)
K
Kevin Cooper

If you use PM2 via node modules instead of globally, you'll need to set interpreter: 'none' in order for the above solutions to work. Related docs here.

In ecosystem.config.js:

  apps: [
    {
      name: 'myApp',
      script: 'yarn',
      args: 'start',
      interpreter: 'none',
    },
  ],

L
Luke Robertson

pm2 start npm --name "custom_pm2_name" -- run prod

"scripts": {
    "prod": "nodemon --exec babel-node ./src/index.js"
  }

This worked for me when the others didnt


Thank you so much, Luke. Especially appreciate that you posted your script alongside, no more guessing which "start" is which :) This should be rated higher, finally something that just works.
A
Ashish Gupta

For the normal user

PM2 now supports npm start:

pm2 start npm -- start

To assign a name to the PM2 process, use the "--name" option:

pm2 start npm --name "your desired app name" -- start

For the root user

sudo pm2 start npm -- start

To assign a name to the PM2 process, use the "--name" option:

sudo pm2 start npm --name "your desired app name" -- start

S
Shivam

Yes, Absolutely you can do it very efficiently by using a pm2 config (json) file with elegance.

package.json file (containing below example scripts)

"scripts": {
    "start": "concurrently npm:server npm:dev",
    "dev": "react-scripts start",
    "build": "node ./scripts/build.js",
    "eject": "react-scripts eject",
    "lint": "eslint src server",
    "shivkumarscript": "ts-node -T -P server/tsconfig.json server/index.ts"
  }

Suppose we want to run the script named as 'shivkumarscript' with pm2 utility. So, our pm2 config file should be like below, containing 'script' key with value as 'npm' and 'args' key with value as 'run '. Script name is 'shivkumarscript' in our case.

ecosystem.config.json file

module.exports = {
    apps: [
        {
            name: "NodeServer",
            script: "npm",
            automation: false,
            args: "run shivkumarscript",
            env: {
                NODE_ENV: "development"
            },
            env_production: {
                NODE_ENV: "production"
            }
        }
    ]
}

Assuming that you have already installed Node.js, NPM and PM2 on your machine. Then below should be the command to start the application through pm2 which will in turn run the npm script (command line mentioned in your application's package.json file):

For production environment:

pm2 start ecosystem.config.js --env production --only NodeServer

For development environment:

pm2 start ecosystem.config.js --only NodeServer

...And Boooom! guys


N
Nelson Frank

You can change directory to your project

cd /my-project

then run

pm2 start "npm run start" \\ run npm script from your package.json

read more here


M
M. Hamza Rajput

It's working fine on CentOS 7

PM2 version 4.2.1

let's take two scenarios:

1. npm start //server.js

pm2 start "npm -- start" --name myMainFile

2. npm run main //main.js

pm2 start "npm -- run main" --name myMainFile

s
snozza

Unfortunately, it seems that pm2 doesn't support the exact functionality you requested https://github.com/Unitech/PM2/issues/1317.

The alternative proposed is to use a ecosystem.json file Getting started with deployment which could include setups for production and dev environments. However, this is still using npm start to bootstrap your app.


What do you mean by that? However, this is still using npm start to bootstrap your app. Can you actually run npm start using pm2?
劉謹賢
pm2 start ./bin/www

can running

if you wanna multiple server deploy you can do that. instead of pm2 start npm -- start


H
Hille

Don't forget the space before start

pm2 start npm --[space]start

so the correct command is:

pm2 start npm -- start

A
Anish Nair

To run PM2 with npm start method and to give it a name, run this,
pm2 start npm --name "your_app_name" -- start

To run it by passing date-format for logs,
pm2 start npm --name "your_name" --log-date-format 'DD-MM HH:mm:ss.SSS' -- start


M
Minh Dao

Now, You can use after:

pm2 start npm -- start

Follow by https://github.com/Unitech/pm2/issues/1317#issuecomment-220955319


Can you expand your answer? Advice from How to answer: Links to external resources are encouraged, but please add context around the link so your fellow users will have some idea what it is and why it’s there. Always quote the most relevant part of an important link, in case the target site is unreachable or goes permanently offline.