11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>npx</title> 41cb0ef41Sopenharmony_ci<style> 51cb0ef41Sopenharmony_cibody { 61cb0ef41Sopenharmony_ci background-color: #ffffff; 71cb0ef41Sopenharmony_ci color: #24292e; 81cb0ef41Sopenharmony_ci 91cb0ef41Sopenharmony_ci margin: 0; 101cb0ef41Sopenharmony_ci 111cb0ef41Sopenharmony_ci line-height: 1.5; 121cb0ef41Sopenharmony_ci 131cb0ef41Sopenharmony_ci font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 141cb0ef41Sopenharmony_ci} 151cb0ef41Sopenharmony_ci#rainbar { 161cb0ef41Sopenharmony_ci height: 10px; 171cb0ef41Sopenharmony_ci background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 181cb0ef41Sopenharmony_ci} 191cb0ef41Sopenharmony_ci 201cb0ef41Sopenharmony_cia { 211cb0ef41Sopenharmony_ci text-decoration: none; 221cb0ef41Sopenharmony_ci color: #0366d6; 231cb0ef41Sopenharmony_ci} 241cb0ef41Sopenharmony_cia:hover { 251cb0ef41Sopenharmony_ci text-decoration: underline; 261cb0ef41Sopenharmony_ci} 271cb0ef41Sopenharmony_ci 281cb0ef41Sopenharmony_cipre { 291cb0ef41Sopenharmony_ci margin: 1em 0px; 301cb0ef41Sopenharmony_ci padding: 1em; 311cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 321cb0ef41Sopenharmony_ci border-radius: 6px; 331cb0ef41Sopenharmony_ci 341cb0ef41Sopenharmony_ci display: block; 351cb0ef41Sopenharmony_ci overflow: auto; 361cb0ef41Sopenharmony_ci 371cb0ef41Sopenharmony_ci white-space: pre; 381cb0ef41Sopenharmony_ci 391cb0ef41Sopenharmony_ci background-color: #f6f8fa; 401cb0ef41Sopenharmony_ci color: #393a34; 411cb0ef41Sopenharmony_ci} 421cb0ef41Sopenharmony_cicode { 431cb0ef41Sopenharmony_ci font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 441cb0ef41Sopenharmony_ci font-size: 85%; 451cb0ef41Sopenharmony_ci padding: 0.2em 0.4em; 461cb0ef41Sopenharmony_ci background-color: #f6f8fa; 471cb0ef41Sopenharmony_ci color: #393a34; 481cb0ef41Sopenharmony_ci} 491cb0ef41Sopenharmony_cipre > code { 501cb0ef41Sopenharmony_ci padding: 0; 511cb0ef41Sopenharmony_ci background-color: inherit; 521cb0ef41Sopenharmony_ci color: inherit; 531cb0ef41Sopenharmony_ci} 541cb0ef41Sopenharmony_cih1, h2, h3 { 551cb0ef41Sopenharmony_ci font-weight: 600; 561cb0ef41Sopenharmony_ci} 571cb0ef41Sopenharmony_ci 581cb0ef41Sopenharmony_ci#logobar { 591cb0ef41Sopenharmony_ci background-color: #333333; 601cb0ef41Sopenharmony_ci margin: 0 auto; 611cb0ef41Sopenharmony_ci padding: 1em 4em; 621cb0ef41Sopenharmony_ci} 631cb0ef41Sopenharmony_ci#logobar .logo { 641cb0ef41Sopenharmony_ci float: left; 651cb0ef41Sopenharmony_ci} 661cb0ef41Sopenharmony_ci#logobar .title { 671cb0ef41Sopenharmony_ci font-weight: 600; 681cb0ef41Sopenharmony_ci color: #dddddd; 691cb0ef41Sopenharmony_ci float: left; 701cb0ef41Sopenharmony_ci margin: 5px 0 0 1em; 711cb0ef41Sopenharmony_ci} 721cb0ef41Sopenharmony_ci#logobar:after { 731cb0ef41Sopenharmony_ci content: ""; 741cb0ef41Sopenharmony_ci display: block; 751cb0ef41Sopenharmony_ci clear: both; 761cb0ef41Sopenharmony_ci} 771cb0ef41Sopenharmony_ci 781cb0ef41Sopenharmony_ci#content { 791cb0ef41Sopenharmony_ci margin: 0 auto; 801cb0ef41Sopenharmony_ci padding: 0 4em; 811cb0ef41Sopenharmony_ci} 821cb0ef41Sopenharmony_ci 831cb0ef41Sopenharmony_ci#table_of_contents > h2 { 841cb0ef41Sopenharmony_ci font-size: 1.17em; 851cb0ef41Sopenharmony_ci} 861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child { 871cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 881cb0ef41Sopenharmony_ci border-radius: 6px; 891cb0ef41Sopenharmony_ci padding: 1em; 901cb0ef41Sopenharmony_ci background-color: #f6f8fa; 911cb0ef41Sopenharmony_ci color: #393a34; 921cb0ef41Sopenharmony_ci} 931cb0ef41Sopenharmony_ci#table_of_contents ul { 941cb0ef41Sopenharmony_ci list-style-type: none; 951cb0ef41Sopenharmony_ci padding-left: 1.5em; 961cb0ef41Sopenharmony_ci} 971cb0ef41Sopenharmony_ci#table_of_contents li { 981cb0ef41Sopenharmony_ci font-size: 0.9em; 991cb0ef41Sopenharmony_ci} 1001cb0ef41Sopenharmony_ci#table_of_contents li a { 1011cb0ef41Sopenharmony_ci color: #000000; 1021cb0ef41Sopenharmony_ci} 1031cb0ef41Sopenharmony_ci 1041cb0ef41Sopenharmony_ciheader.title { 1051cb0ef41Sopenharmony_ci border-bottom: solid 1px #e1e4e8; 1061cb0ef41Sopenharmony_ci} 1071cb0ef41Sopenharmony_ciheader.title > h1 { 1081cb0ef41Sopenharmony_ci margin-bottom: 0.25em; 1091cb0ef41Sopenharmony_ci} 1101cb0ef41Sopenharmony_ciheader.title > .description { 1111cb0ef41Sopenharmony_ci display: block; 1121cb0ef41Sopenharmony_ci margin-bottom: 0.5em; 1131cb0ef41Sopenharmony_ci line-height: 1; 1141cb0ef41Sopenharmony_ci} 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_cifooter#edit { 1171cb0ef41Sopenharmony_ci border-top: solid 1px #e1e4e8; 1181cb0ef41Sopenharmony_ci margin: 3em 0 4em 0; 1191cb0ef41Sopenharmony_ci padding-top: 2em; 1201cb0ef41Sopenharmony_ci} 1211cb0ef41Sopenharmony_ci</style> 1221cb0ef41Sopenharmony_ci</head> 1231cb0ef41Sopenharmony_ci<body> 1241cb0ef41Sopenharmony_ci<div id="banner"> 1251cb0ef41Sopenharmony_ci<div id="rainbar"></div> 1261cb0ef41Sopenharmony_ci<div id="logobar"> 1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 1301cb0ef41Sopenharmony_ci</svg> 1311cb0ef41Sopenharmony_ci<div class="title"> 1321cb0ef41Sopenharmony_cinpm command-line interface 1331cb0ef41Sopenharmony_ci</div> 1341cb0ef41Sopenharmony_ci</div> 1351cb0ef41Sopenharmony_ci</div> 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci<section id="content"> 1381cb0ef41Sopenharmony_ci<header class="title"> 1391cb0ef41Sopenharmony_ci<h1 id="npx">npx</h1> 1401cb0ef41Sopenharmony_ci<span class="description">Run a command from a local or remote npm package</span> 1411cb0ef41Sopenharmony_ci</header> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci<section id="table_of_contents"> 1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2> 1451cb0ef41Sopenharmony_ci<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#npx-vs-npm-exec"><code>npx</code> vs <code>npm exec</code></a></li><li><a href="#examples">Examples</a></li><li><a href="#compatibility-with-older-npx-versions">Compatibility with Older npx Versions</a></li><li><a href="#see-also">See Also</a></li></ul></div> 1461cb0ef41Sopenharmony_ci</section> 1471cb0ef41Sopenharmony_ci 1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="synopsis">Synopsis</h3> 1491cb0ef41Sopenharmony_ci<pre><code class="language-bash">npx -- <pkg>[@<version>] [args...] 1501cb0ef41Sopenharmony_cinpx --package=<pkg>[@<version>] -- <cmd> [args...] 1511cb0ef41Sopenharmony_cinpx -c '<cmd> [args...]' 1521cb0ef41Sopenharmony_cinpx --package=foo -c '<cmd> [args...]' 1531cb0ef41Sopenharmony_ci</code></pre> 1541cb0ef41Sopenharmony_ci<h3 id="description">Description</h3> 1551cb0ef41Sopenharmony_ci<p>This command allows you to run an arbitrary command from an npm package 1561cb0ef41Sopenharmony_ci(either one installed locally, or fetched remotely), in a similar context 1571cb0ef41Sopenharmony_cias running it via <code>npm run</code>.</p> 1581cb0ef41Sopenharmony_ci<p>Whatever packages are specified by the <code>--package</code> option will be 1591cb0ef41Sopenharmony_ciprovided in the <code>PATH</code> of the executed command, along with any locally 1601cb0ef41Sopenharmony_ciinstalled package executables. The <code>--package</code> option may be 1611cb0ef41Sopenharmony_cispecified multiple times, to execute the supplied command in an environment 1621cb0ef41Sopenharmony_ciwhere all specified packages are available.</p> 1631cb0ef41Sopenharmony_ci<p>If any requested packages are not present in the local project 1641cb0ef41Sopenharmony_cidependencies, then they are installed to a folder in the npm cache, which 1651cb0ef41Sopenharmony_ciis added to the <code>PATH</code> environment variable in the executed process. A 1661cb0ef41Sopenharmony_ciprompt is printed (which can be suppressed by providing either <code>--yes</code> or 1671cb0ef41Sopenharmony_ci<code>--no</code>).</p> 1681cb0ef41Sopenharmony_ci<p>Package names provided without a specifier will be matched with whatever 1691cb0ef41Sopenharmony_civersion exists in the local project. Package names with a specifier will 1701cb0ef41Sopenharmony_cionly be considered a match if they have the exact same name and version as 1711cb0ef41Sopenharmony_cithe local dependency.</p> 1721cb0ef41Sopenharmony_ci<p>If no <code>-c</code> or <code>--call</code> option is provided, then the positional arguments 1731cb0ef41Sopenharmony_ciare used to generate the command string. If no <code>--package</code> options 1741cb0ef41Sopenharmony_ciare provided, then npm will attempt to determine the executable name from 1751cb0ef41Sopenharmony_cithe package specifier provided as the first positional argument according 1761cb0ef41Sopenharmony_cito the following heuristic:</p> 1771cb0ef41Sopenharmony_ci<ul> 1781cb0ef41Sopenharmony_ci<li>If the package has a single entry in its <code>bin</code> field in <code>package.json</code>, 1791cb0ef41Sopenharmony_cior if all entries are aliases of the same command, then that command 1801cb0ef41Sopenharmony_ciwill be used.</li> 1811cb0ef41Sopenharmony_ci<li>If the package has multiple <code>bin</code> entries, and one of them matches the 1821cb0ef41Sopenharmony_ciunscoped portion of the <code>name</code> field, then that command will be used.</li> 1831cb0ef41Sopenharmony_ci<li>If this does not result in exactly one option (either because there are 1841cb0ef41Sopenharmony_cino bin entries, or none of them match the <code>name</code> of the package), then 1851cb0ef41Sopenharmony_ci<code>npm exec</code> exits with an error.</li> 1861cb0ef41Sopenharmony_ci</ul> 1871cb0ef41Sopenharmony_ci<p>To run a binary <em>other than</em> the named binary, specify one or more 1881cb0ef41Sopenharmony_ci<code>--package</code> options, which will prevent npm from inferring the package from 1891cb0ef41Sopenharmony_cithe first command argument.</p> 1901cb0ef41Sopenharmony_ci<h3 id="npx-vs-npm-exec"><code>npx</code> vs <code>npm exec</code></h3> 1911cb0ef41Sopenharmony_ci<p>When run via the <code>npx</code> binary, all flags and options <em>must</em> be set prior to 1921cb0ef41Sopenharmony_ciany positional arguments. When run via <code>npm exec</code>, a double-hyphen <code>--</code> 1931cb0ef41Sopenharmony_ciflag can be used to suppress npm's parsing of switches and options that 1941cb0ef41Sopenharmony_cishould be sent to the executed command.</p> 1951cb0ef41Sopenharmony_ci<p>For example:</p> 1961cb0ef41Sopenharmony_ci<pre><code>$ npx foo@latest bar --package=@npmcli/foo 1971cb0ef41Sopenharmony_ci</code></pre> 1981cb0ef41Sopenharmony_ci<p>In this case, npm will resolve the <code>foo</code> package name, and run the 1991cb0ef41Sopenharmony_cifollowing command:</p> 2001cb0ef41Sopenharmony_ci<pre><code>$ foo bar --package=@npmcli/foo 2011cb0ef41Sopenharmony_ci</code></pre> 2021cb0ef41Sopenharmony_ci<p>Since the <code>--package</code> option comes <em>after</em> the positional arguments, it is 2031cb0ef41Sopenharmony_citreated as an argument to the executed command.</p> 2041cb0ef41Sopenharmony_ci<p>In contrast, due to npm's argument parsing logic, running this command is 2051cb0ef41Sopenharmony_cidifferent:</p> 2061cb0ef41Sopenharmony_ci<pre><code>$ npm exec foo@latest bar --package=@npmcli/foo 2071cb0ef41Sopenharmony_ci</code></pre> 2081cb0ef41Sopenharmony_ci<p>In this case, npm will parse the <code>--package</code> option first, resolving the 2091cb0ef41Sopenharmony_ci<code>@npmcli/foo</code> package. Then, it will execute the following command in that 2101cb0ef41Sopenharmony_cicontext:</p> 2111cb0ef41Sopenharmony_ci<pre><code>$ foo@latest bar 2121cb0ef41Sopenharmony_ci</code></pre> 2131cb0ef41Sopenharmony_ci<p>The double-hyphen character is recommended to explicitly tell npm to stop 2141cb0ef41Sopenharmony_ciparsing command line options and switches. The following command would 2151cb0ef41Sopenharmony_cithus be equivalent to the <code>npx</code> command above:</p> 2161cb0ef41Sopenharmony_ci<pre><code>$ npm exec -- foo@latest bar --package=@npmcli/foo 2171cb0ef41Sopenharmony_ci</code></pre> 2181cb0ef41Sopenharmony_ci<h3 id="examples">Examples</h3> 2191cb0ef41Sopenharmony_ci<p>Run the version of <code>tap</code> in the local dependencies, with the provided 2201cb0ef41Sopenharmony_ciarguments:</p> 2211cb0ef41Sopenharmony_ci<pre><code>$ npm exec -- tap --bail test/foo.js 2221cb0ef41Sopenharmony_ci$ npx tap --bail test/foo.js 2231cb0ef41Sopenharmony_ci</code></pre> 2241cb0ef41Sopenharmony_ci<p>Run a command <em>other than</em> the command whose name matches the package name 2251cb0ef41Sopenharmony_ciby specifying a <code>--package</code> option:</p> 2261cb0ef41Sopenharmony_ci<pre><code>$ npm exec --package=foo -- bar --bar-argument 2271cb0ef41Sopenharmony_ci# ~ or ~ 2281cb0ef41Sopenharmony_ci$ npx --package=foo bar --bar-argument 2291cb0ef41Sopenharmony_ci</code></pre> 2301cb0ef41Sopenharmony_ci<p>Run an arbitrary shell script, in the context of the current project:</p> 2311cb0ef41Sopenharmony_ci<pre><code>$ npm x -c 'eslint && say "hooray, lint passed"' 2321cb0ef41Sopenharmony_ci$ npx -c 'eslint && say "hooray, lint passed"' 2331cb0ef41Sopenharmony_ci</code></pre> 2341cb0ef41Sopenharmony_ci<h3 id="compatibility-with-older-npx-versions">Compatibility with Older npx Versions</h3> 2351cb0ef41Sopenharmony_ci<p>The <code>npx</code> binary was rewritten in npm v7.0.0, and the standalone <code>npx</code> 2361cb0ef41Sopenharmony_cipackage deprecated at that time. <code>npx</code> uses the <code>npm exec</code> 2371cb0ef41Sopenharmony_cicommand instead of a separate argument parser and install process, with 2381cb0ef41Sopenharmony_cisome affordances to maintain backwards compatibility with the arguments it 2391cb0ef41Sopenharmony_ciaccepted in previous versions.</p> 2401cb0ef41Sopenharmony_ci<p>This resulted in some shifts in its functionality:</p> 2411cb0ef41Sopenharmony_ci<ul> 2421cb0ef41Sopenharmony_ci<li>Any <code>npm</code> config value may be provided.</li> 2431cb0ef41Sopenharmony_ci<li>To prevent security and user-experience problems from mistyping package 2441cb0ef41Sopenharmony_cinames, <code>npx</code> prompts before installing anything. Suppress this 2451cb0ef41Sopenharmony_ciprompt with the <code>-y</code> or <code>--yes</code> option.</li> 2461cb0ef41Sopenharmony_ci<li>The <code>--no-install</code> option is deprecated, and will be converted to <code>--no</code>.</li> 2471cb0ef41Sopenharmony_ci<li>Shell fallback functionality is removed, as it is not advisable.</li> 2481cb0ef41Sopenharmony_ci<li>The <code>-p</code> argument is a shorthand for <code>--parseable</code> in npm, but shorthand 2491cb0ef41Sopenharmony_cifor <code>--package</code> in npx. This is maintained, but only for the <code>npx</code> 2501cb0ef41Sopenharmony_ciexecutable.</li> 2511cb0ef41Sopenharmony_ci<li>The <code>--ignore-existing</code> option is removed. Locally installed bins are 2521cb0ef41Sopenharmony_cialways present in the executed process <code>PATH</code>.</li> 2531cb0ef41Sopenharmony_ci<li>The <code>--npm</code> option is removed. <code>npx</code> will always use the <code>npm</code> it ships 2541cb0ef41Sopenharmony_ciwith.</li> 2551cb0ef41Sopenharmony_ci<li>The <code>--node-arg</code> and <code>-n</code> options have been removed. Use <a href="https://nodejs.org/api/cli.html#node_optionsoptions"><code>NODE_OPTIONS</code></a> instead: e.g., 2561cb0ef41Sopenharmony_ci<code>NODE_OPTIONS="--trace-warnings --trace-exit" npx foo --random=true</code></li> 2571cb0ef41Sopenharmony_ci<li>The <code>--always-spawn</code> option is redundant, and thus removed.</li> 2581cb0ef41Sopenharmony_ci<li>The <code>--shell</code> option is replaced with <code>--script-shell</code>, but maintained 2591cb0ef41Sopenharmony_ciin the <code>npx</code> executable for backwards compatibility.</li> 2601cb0ef41Sopenharmony_ci</ul> 2611cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3> 2621cb0ef41Sopenharmony_ci<ul> 2631cb0ef41Sopenharmony_ci<li><a href="../commands/npm-run-script.html">npm run-script</a></li> 2641cb0ef41Sopenharmony_ci<li><a href="../using-npm/scripts.html">npm scripts</a></li> 2651cb0ef41Sopenharmony_ci<li><a href="../commands/npm-test.html">npm test</a></li> 2661cb0ef41Sopenharmony_ci<li><a href="../commands/npm-start.html">npm start</a></li> 2671cb0ef41Sopenharmony_ci<li><a href="../commands/npm-restart.html">npm restart</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="../commands/npm-stop.html">npm stop</a></li> 2691cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li> 2701cb0ef41Sopenharmony_ci<li><a href="../commands/npm-exec.html">npm exec</a></li> 2711cb0ef41Sopenharmony_ci</ul></div> 2721cb0ef41Sopenharmony_ci 2731cb0ef41Sopenharmony_ci<footer id="edit"> 2741cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npx.md"> 2751cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 2761cb0ef41Sopenharmony_ci<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> 2771cb0ef41Sopenharmony_ci</svg> 2781cb0ef41Sopenharmony_ciEdit this page on GitHub 2791cb0ef41Sopenharmony_ci</a> 2801cb0ef41Sopenharmony_ci</footer> 2811cb0ef41Sopenharmony_ci</section> 2821cb0ef41Sopenharmony_ci 2831cb0ef41Sopenharmony_ci 2841cb0ef41Sopenharmony_ci 2851cb0ef41Sopenharmony_ci</body></html>