mirror of https://github.com/lukechilds/node.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
52 lines
1.5 KiB
52 lines
1.5 KiB
.TH "NPM\-RUN\-SCRIPT" "1" "February 2015" "" ""
|
|
.SH "NAME"
|
|
\fBnpm-run-script\fR \- Run arbitrary package scripts
|
|
.SH SYNOPSIS
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm run\-script [command] [\-\- <args>]
|
|
npm run [command] [\-\- <args>]
|
|
.fi
|
|
.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\. The \fBenv\fR 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\.
|
|
.P
|
|
\fBrun[\-script]\fR is used by the test, start, restart, and stop commands, but can
|
|
be called directly, as well\.
|
|
.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\.
|
|
.SH SEE ALSO
|
|
.RS 0
|
|
.IP \(bu 2
|
|
npm help 7 scripts
|
|
.IP \(bu 2
|
|
npm help test
|
|
.IP \(bu 2
|
|
npm help start
|
|
.IP \(bu 2
|
|
npm help restart
|
|
.IP \(bu 2
|
|
npm help stop
|
|
|
|
.RE
|
|
|
|
|