3 <title>npm-run-script</title>
4 <meta http-equiv="content-type" value="text/html;utf-8">
5 <link rel="stylesheet" type="text/css" href="../../static/style.css">
6 <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-run-script.html">
7 <script async=true src="../../static/toc.js"></script>
12 <h1><a href="../cli/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p>
13 <h2 id="synopsis">SYNOPSIS</h2>
14 <pre><code>npm run-script [command] [-- <args>]
15 npm run [command] [-- <args>]
16 </code></pre><h2 id="description">DESCRIPTION</h2>
17 <p>This runs an arbitrary command from a package's <code>"scripts"</code> object. If no
18 <code>"command"</code> is provided, it will list the available scripts. <code>run[-script]</code> is
19 used by the test, start, restart, and stop commands, but can be called
20 directly, as well. When the scripts in the package are printed out, they're
21 separated into lifecycle (test, start, restart) and directly-run scripts.</p>
22 <p>As of <a href="http://blog.npmjs.org/post/98131109725/npm-2-0-0"><code>npm@2.0.0</code></a>, you can
23 use custom arguments when executing scripts. The special option <code>--</code> is used by
24 <a href="http://goo.gl/KxMmtG">getopt</a> to delimit the end of the options. npm will pass
25 all the arguments after the <code>--</code> directly to your script:</p>
26 <pre><code>npm run test -- --grep="pattern"
27 </code></pre><p>The arguments will only be passed to the script specified after <code>npm run</code>
28 and not to any pre or post script.</p>
29 <p>The <code>env</code> script is a special built-in command that can be used to list
30 environment variables that will be available to the script at runtime. If an
31 "env" command is defined in your package it will take precedence over the
33 <p>In addition to the shell's pre-existing <code>PATH</code>, <code>npm run</code> adds
34 <code>node_modules/.bin</code> to the <code>PATH</code> provided to scripts. Any binaries provided by
35 locally-installed dependencies can be used without the <code>node_modules/.bin</code>
36 prefix. For example, if there is a <code>devDependency</code> on <code>tap</code> in your package,
38 <pre><code>"scripts": {"test": "tap test/\*.js"}
39 </code></pre><p>instead of <code>"scripts": {"test": "node_modules/.bin/tap test/\*.js"}</code> to run your tests.</p>
40 <h2 id="see-also">SEE ALSO</h2>
42 <li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li>
43 <li><a href="../cli/npm-test.html">npm-test(1)</a></li>
44 <li><a href="../cli/npm-start.html">npm-start(1)</a></li>
45 <li><a href="../cli/npm-restart.html">npm-restart(1)</a></li>
46 <li><a href="../cli/npm-stop.html">npm-stop(1)</a></li>
51 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
52 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
53 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
54 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
55 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
56 <tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
57 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
58 <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
60 <p id="footer">npm-run-script — npm@2.15.1</p>