2011-11-22 01:48:45 +08:00
|
|
|
npm-run-script(1) -- Run arbitrary package scripts
|
|
|
|
|
==================================================
|
|
|
|
|
|
|
|
|
|
## SYNOPSIS
|
|
|
|
|
|
2014-09-25 05:41:07 +08:00
|
|
|
npm run-script [command] [-- <args>]
|
|
|
|
|
npm run [command] [-- <args>]
|
2011-11-22 01:48:45 +08:00
|
|
|
|
|
|
|
|
## DESCRIPTION
|
|
|
|
|
|
2014-05-02 02:09:00 +08:00
|
|
|
This runs an arbitrary command from a package's `"scripts"` object.
|
|
|
|
|
If no package name is provided, it will search for a `package.json`
|
2014-05-06 09:20:40 +08:00
|
|
|
in the current folder and use its `"scripts"` object. If no `"command"`
|
2015-01-17 16:50:09 +08:00
|
|
|
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.
|
2011-11-22 01:48:45 +08:00
|
|
|
|
2015-01-17 16:50:09 +08:00
|
|
|
`run[-script]` is used by the test, start, restart, and stop commands, but can
|
|
|
|
|
be called directly, as well.
|
2011-11-22 01:48:45 +08:00
|
|
|
|
2014-11-05 07:08:12 +08:00
|
|
|
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
|
|
|
|
|
[getopt](http://goo.gl/KxMmtG) to delimit the end of the options. npm will pass
|
|
|
|
|
all the arguments after the `--` directly to your script:
|
|
|
|
|
|
|
|
|
|
npm run test -- --grep="pattern"
|
|
|
|
|
|
|
|
|
|
The arguments will only be passed to the script specified after ```npm run```
|
|
|
|
|
and not to any pre or post script.
|
|
|
|
|
|
2011-11-22 01:48:45 +08:00
|
|
|
## SEE ALSO
|
|
|
|
|
|
2013-07-12 23:55:57 +08:00
|
|
|
* npm-scripts(7)
|
2011-11-22 01:48:45 +08:00
|
|
|
* npm-test(1)
|
|
|
|
|
* npm-start(1)
|
|
|
|
|
* npm-restart(1)
|
|
|
|
|
* npm-stop(1)
|
