diff options
Diffstat (limited to 'deps/npm/doc/cli/npm-run-script.md')
| -rw-r--r-- | deps/npm/doc/cli/npm-run-script.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/deps/npm/doc/cli/npm-run-script.md b/deps/npm/doc/cli/npm-run-script.md index c218c845f..9e6e17e1d 100644 --- a/deps/npm/doc/cli/npm-run-script.md +++ b/deps/npm/doc/cli/npm-run-script.md @@ -8,16 +8,11 @@ npm-run-script(1) -- Run arbitrary package scripts ## DESCRIPTION -This runs an arbitrary command from a package's `"scripts"` object. -If no package name is provided, it will search for a `package.json` -in the current folder and use its `"scripts"` object. If no `"command"` -is provided, it will list the available top level scripts. The `env` command -can be used to list environment variables that will be available to the script -at runtime. If an "env" command is defined in your package it will have -precedence instead. - -`run[-script]` is used by the test, start, restart, and stop commands, but can -be called directly, as well. +This runs an arbitrary command from a package's `"scripts"` object. If no +`"command"` is provided, it will list the available scripts. `run[-script]` is +used by the test, start, restart, and stop commands, but can be called +directly, as well. When the scripts in the package are printed out, they're +separated into lifecycle (test, start, restart) and directly-run scripts. As of [`npm@2.0.0`](http://blog.npmjs.org/post/98131109725/npm-2-0-0), you can use custom arguments when executing scripts. The special option `--` is used by @@ -29,6 +24,11 @@ all the arguments after the `--` directly to your script: The arguments will only be passed to the script specified after ```npm run``` and not to any pre or post script. +The `env` script is a special built-in command that can be used to list +environment variables that will be available to the script at runtime. If an +"env" command is defined in your package it will take precedence over the +built-in. + ## SEE ALSO * npm-scripts(7) |