diff options
author | Forrest L Norvell <forrest@npmjs.com> | 2015-02-26 09:25:23 +0300 |
---|---|---|
committer | Forrest L Norvell <forrest@npmjs.com> | 2015-02-26 09:25:23 +0300 |
commit | df1bbd93f755c08d6bb7c4d046c9edba890eb43d (patch) | |
tree | 33939830fcbde8d6185b0cdb757eaa973d504850 /doc | |
parent | 95e59b287c9517780318e145371a859e8ebb2d20 (diff) |
docs: drop misleading & obsolete docs; reorganized
`env` doesn't need to be right up top like that.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm-run-script.md | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/doc/cli/npm-run-script.md b/doc/cli/npm-run-script.md index c218c845f..507d2e9cc 100644 --- a/doc/cli/npm-run-script.md +++ b/doc/cli/npm-run-script.md @@ -8,14 +8,8 @@ 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. - +This runs an arbitrary command from a package's `"scripts"` object. If no +`"command"` is provided, it will list the available top level scripts. `run[-script]` is used by the test, start, restart, and stop commands, but can be called directly, as well. @@ -29,6 +23,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) |