UNPKG

npm

Version:

A package manager for node

28 lines (26 loc) 1.62 kB
<h1><a href="../cli/npm-run-script.html">npm-run-script</a></h1> <p>Run arbitrary package scripts</p> <h2 id="synopsis">SYNOPSIS</h2> <pre><code>npm run-script [command] [-- &lt;args&gt;] npm run [command] [-- &lt;args&gt;] </code></pre><h2 id="description">DESCRIPTION</h2> <p>This runs an arbitrary command from a package&#39;s <code>&quot;scripts&quot;</code> object. If no package name is provided, it will search for a <code>package.json</code> in the current folder and use its <code>&quot;scripts&quot;</code> object. If no <code>&quot;command&quot;</code> is provided, it will list the available top level scripts.</p> <p>It is used by the test, start, restart, and stop commands, but can be called directly, as well.</p> <p>As of <a href="http://blog.npmjs.org/post/98131109725/npm-2-0-0"><code>npm@2.0.0</code></a>, you can use custom arguments when executing scripts. The special option <code>--</code> is used by <a href="http://goo.gl/KxMmtG">getopt</a> to delimit the end of the options. npm will pass all the arguments after the <code>--</code> directly to your script:</p> <pre><code>npm run test -- --grep=&quot;pattern&quot; </code></pre><p>The arguments will only be passed to the script specified after <code>npm run</code> and not to any pre or post script.</p> <h2 id="see-also">SEE ALSO</h2> <ul> <li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li> <li><a href="../cli/npm-test.html">npm-test(1)</a></li> <li><a href="../cli/npm-start.html">npm-start(1)</a></li> <li><a href="../cli/npm-restart.html">npm-restart(1)</a></li> <li><a href="../cli/npm-stop.html">npm-stop(1)</a></li> </ul>