How do I send command line arguments to npm script

Question

The scripts portion of my package.json currently looks like this:

"scripts": {
    "start": "node ./script.js server"
}

which means I can run npm start to start the server.

However, I would like to be able to run something like npm start 8080 and have the argument(s) passed to script.js (e.g. npm start 8080 => node ./script.js server 8080). Is this possible?

Answer 1

Hello @kartik,

The syntax is as follows:

npm run <command> [-- <args>]

Note the necessary --. It is needed to separate the params passed to npm command itself and params passed to your script.

So if you have in package.json

"scripts": {
    "grunt": "grunt",
    "server": "node server.js"
}

Then the following commands would be equivalent:

grunt task:target => npm run grunt -- task:target

node server.js --port=1337 => npm run server -- --port=1337

Hope it helps!!
Thank You!