node/deps/npm/man/man1/npm-run-script.1

50 lines
1.3 KiB
Groff
Raw Normal View History

2014-11-05 07:08:12 +08:00
.TH "NPM\-RUN\-SCRIPT" "1" "October 2014" "" ""
.SH "NAME"
2014-09-25 05:41:07 +08:00
\fBnpm-run-script\fR \- Run arbitrary package scripts
.SH SYNOPSIS
.P
.RS 2
2014-11-05 07:08:12 +08:00
.nf
2014-09-25 05:41:07 +08:00
npm run\-script [command] [\-\- <args>]
npm run [command] [\-\- <args>]
2014-11-05 07:08:12 +08:00
.fi
2014-09-25 05:41:07 +08:00
.RE
.SH DESCRIPTION
.P
This runs an arbitrary command from a package's \fB"scripts"\fR object\.
If no package name is provided, it will search for a \fBpackage\.json\fR
in the current folder and use its \fB"scripts"\fR object\. If no \fB"command"\fR
is provided, it will list the available top level scripts\.
.P
It is used by the test, start, restart, and stop commands, but can be
called directly, as well\.
2014-11-05 07:08:12 +08:00
.P
As of \fBnpm@2\.0\.0\fR \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can
use custom arguments when executing scripts\. The special option \fB\-\-\fR is used by
getopt \fIhttp://goo\.gl/KxMmtG\fR to delimit the end of the options\. npm will pass
all the arguments after the \fB\-\-\fR directly to your script:
.P
.RS 2
.nf
npm run test \-\- \-\-grep="pattern"
.fi
.RE
.P
The arguments will only be passed to the script specified after \fBnpm run\fR
and not to any pre or post script\.
2014-09-25 05:41:07 +08:00
.SH SEE ALSO
.RS 0
.IP \(bu 2
2014-09-17 06:38:50 +08:00
npm help 7 scripts
2014-09-25 05:41:07 +08:00
.IP \(bu 2
npm help test
2014-09-25 05:41:07 +08:00
.IP \(bu 2
npm help start
2014-09-25 05:41:07 +08:00
.IP \(bu 2
npm help restart
2014-09-25 05:41:07 +08:00
.IP \(bu 2
npm help stop
2014-09-25 05:41:07 +08:00
.RE