codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-exec</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-exec----11130">
190 <span>npm-exec</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Run a command from a local or remote npm package</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<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="#configuration">Configuration</a></li><ul><li><a href="#package"><code>package</code></a></li><li><a href="#call"><code>call</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li></ul><li><a href="#examples">Examples</a></li><li><a href="#workspaces-support">Workspaces support</a></li><ul><li><a href="#filtering-workspaces">Filtering workspaces</a></li></ul><li><a href="#compatibility-with-older-npx-versions">Compatibility with Older npx Versions</a></li><li><a href="#a-note-on-caching">A note on caching</a></li><ul><li><a href="#prefer-online">prefer-online</a></li><li><a href="#prefer-offline">prefer-offline</a></li><li><a href="#offline">offline</a></li><li><a href="#workspace2">workspace</a></li><li><a href="#workspaces2">workspaces</a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm exec -- <pkg>[@<version>] [args...]
203npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
204npm exec -c '<cmd> [args...]'
205npm exec --package=foo -c '<cmd> [args...]'
206
207alias: x
208</code></pre>
209<h3 id="description">Description</h3>
210<p>This command allows you to run an arbitrary command from an npm package (either one installed locally, or fetched remotely), in a similar context as running it via <code>npm run</code>.</p>
211<p>Run without positional arguments or <code>--call</code>, this allows you to interactively run commands in the same sort of shell environment that <code>package.json</code> scripts are run.
212Interactive mode is not supported in CI environments when standard input is a TTY, to prevent hangs.</p>
213<p>Whatever packages are specified by the <code>--package</code> option will be provided in the <code>PATH</code> of the executed command, along with any locally installed package executables.
214The <code>--package</code> option may be specified multiple times, to execute the supplied command in an environment where all specified packages are available.</p>
215<p>If any requested packages are not present in the local project dependencies, then a prompt is printed, which can be suppressed by providing either <code>--yes</code> or <code>--no</code>.
216When standard input is not a TTY or a CI environment is detected, <code>--yes</code> is assumed.
217The requested packages are installed to a folder in the npm cache, which is added to the <code>PATH</code> environment variable in the executed process.</p>
218<p>Package names provided without a specifier will be matched with whatever version exists in the local project.
219Package names with a specifier will only be considered a match if they have the exact same name and version as the local dependency.</p>
220<p>If no <code>-c</code> or <code>--call</code> option is provided, then the positional arguments are used to generate the command string.
221If no <code>--package</code> options are provided, then npm will attempt to determine the executable name from the package specifier provided as the first positional argument according to the following heuristic:</p>
222<ul>
223<li>If the package has a single entry in its <code>bin</code> field in <code>package.json</code>, or if all entries are aliases of the same command, then that command will be used.</li>
224<li>If the package has multiple <code>bin</code> entries, and one of them matches the unscoped portion of the <code>name</code> field, then that command will be used.</li>
225<li>If this does not result in exactly one option (either because there are no bin entries, or none of them match the <code>name</code> of the package), then <code>npm exec</code> exits with an error.</li>
226</ul>
227<p>To run a binary <em>other than</em> the named binary, specify one or more <code>--package</code> options, which will prevent npm from inferring the package from the first command argument.</p>
228<h3 id="npx-vs-npm-exec"><code>npx</code> vs <code>npm exec</code></h3>
229<p>When run via the <code>npx</code> binary, all flags and options <em>must</em> be set prior to any positional arguments.
230When run via <code>npm exec</code>, a double-hyphen <code>--</code> flag can be used to suppress npm's parsing of switches and options that should be sent to the executed command.</p>
231<p>For example:</p>
232<pre><code>$ npx foo@latest bar --package=@npmcli/foo
233</code></pre>
234<p>In this case, npm will resolve the <code>foo</code> package name, and run the following command:</p>
235<pre><code>$ foo bar --package=@npmcli/foo
236</code></pre>
237<p>Since the <code>--package</code> option comes <em>after</em> the positional arguments, it is treated as an argument to the executed command.</p>
238<p>In contrast, due to npm's argument parsing logic, running this command is different:</p>
239<pre><code>$ npm exec foo@latest bar --package=@npmcli/foo
240</code></pre>
241<p>In this case, npm will parse the <code>--package</code> option first, resolving the <code>@npmcli/foo</code> package.
242Then, it will execute the following command in that context:</p>
243<pre><code>$ foo@latest bar
244</code></pre>
245<p>The double-hyphen character is recommended to explicitly tell npm to stop parsing command line options and switches.
246The following command would thus be equivalent to the <code>npx</code> command above:</p>
247<pre><code>$ npm exec -- foo@latest bar --package=@npmcli/foo
248</code></pre>
249<h3 id="configuration">Configuration</h3>
250<h4 id="package"><code>package</code></h4>
251<ul>
252<li>Default:</li>
253<li>Type: String (can be set multiple times)</li>
254</ul>
255<p>The package or packages to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p>
256<h4 id="call"><code>call</code></h4>
257<ul>
258<li>Default: ""</li>
259<li>Type: String</li>
260</ul>
261<p>Optional companion option for <code>npm exec</code>, <code>npx</code> that allows for specifying a
262custom command to be run along with the installed packages.</p>
263<pre><code class="language-bash">npm exec --package yo --package generator-node --call "yo node"
264</code></pre>
265<h4 id="workspace"><code>workspace</code></h4>
266<ul>
267<li>Default:</li>
268<li>Type: String (can be set multiple times)</li>
269</ul>
270<p>Enable running a command in the context of the configured workspaces of the
271current project while filtering by running only the workspaces defined by
272this configuration option.</p>
273<p>Valid values for the <code>workspace</code> config are either:</p>
274<ul>
275<li>Workspace names</li>
276<li>Path to a workspace directory</li>
277<li>Path to a parent workspace directory (will result in selecting all
278workspaces within that folder)</li>
279</ul>
280<p>When set for the <code>npm init</code> command, this may be set to the folder of a
281workspace which does not yet exist, to create the folder and set it up as a
282brand new workspace within the project.</p>
283<p>This value is not exported to the environment for child processes.</p>
284<h4 id="workspaces"><code>workspaces</code></h4>
285<ul>
286<li>Default: null</li>
287<li>Type: null or Boolean</li>
288</ul>
289<p>Set to true to run the command in the context of <strong>all</strong> configured
290workspaces.</p>
291<p>Explicitly setting this to false will cause commands like <code>install</code> to
292ignore workspaces altogether. When not set explicitly:</p>
293<ul>
294<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
295will link workspaces into the <code>node_modules</code> folder. - Commands that do
296other things (test, exec, publish, etc.) will operate on the root project,
297<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
298</ul>
299<p>This value is not exported to the environment for child processes.</p>
300<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
301<ul>
302<li>Default: false</li>
303<li>Type: Boolean</li>
304</ul>
305<p>Include the workspace root when workspaces are enabled for a command.</p>
306<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
307all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
308the specified workspaces, and not on the root project.</p>
309<p>This value is not exported to the environment for child processes.</p>
310<h3 id="examples">Examples</h3>
311<p>Run the version of <code>tap</code> in the local dependencies, with the provided arguments:</p>
312<pre><code>$ npm exec -- tap --bail test/foo.js
313$ npx tap --bail test/foo.js
314</code></pre>
315<p>Run a command <em>other than</em> the command whose name matches the package name by specifying a <code>--package</code> option:</p>
316<pre><code>$ npm exec --package=foo -- bar --bar-argument
317# ~ or ~
318$ npx --package=foo bar --bar-argument
319</code></pre>
320<p>Run an arbitrary shell script, in the context of the current project:</p>
321<pre><code>$ npm x -c 'eslint && say "hooray, lint passed"'
322$ npx -c 'eslint && say "hooray, lint passed"'
323</code></pre>
324<h3 id="workspaces-support">Workspaces support</h3>
325<p>You may use the <a href="../using-npm/config#workspace.html"><code>workspace</code></a> or <a href="../using-npm/config#workspaces.html"><code>workspaces</code></a> configs in order to run an arbitrary command from an npm package (either one installed locally, or fetched remotely) in the context of the specified workspaces.
326If no positional argument or <code>--call</code> option is provided, it will open an interactive subshell in the context of each of these configured workspaces one at a time.</p>
327<p>Given a project with configured workspaces, e.g:</p>
328<pre><code>.
329+-- package.json
330`-- packages
331 +-- a
332 | `-- package.json
333 +-- b
334 | `-- package.json
335 `-- c
336 `-- package.json
337</code></pre>
338<p>Assuming the workspace configuration is properly set up at the root level <code>package.json</code> file.
339e.g:</p>
340<pre><code>{
341 "workspaces": [ "./packages/*" ]
342}
343</code></pre>
344<p>You can execute an arbitrary command from a package in the context of each of the configured workspaces when using the <a href="../using-npm/config#workspace.html"><code>workspaces</code> config options</a>, in this example we're using <strong>eslint</strong> to lint any js file found within each workspace folder:</p>
345<pre><code>npm exec --ws -- eslint ./*.js
346</code></pre>
347<h4 id="filtering-workspaces">Filtering workspaces</h4>
348<p>It's also possible to execute a command in a single workspace using the <code>workspace</code> config along with a name or directory path:</p>
349<pre><code>npm exec --workspace=a -- eslint ./*.js
350</code></pre>
351<p>The <code>workspace</code> config can also be specified multiple times in order to run a specific script in the context of multiple workspaces.
352When defining values for the <code>workspace</code> config in the command line, it also possible to use <code>-w</code> as a shorthand, e.g:</p>
353<pre><code>npm exec -w a -w b -- eslint ./*.js
354</code></pre>
355<p>This last command will run the <code>eslint</code> command in both <code>./packages/a</code> and
356<code>./packages/b</code> folders.</p>
357<h3 id="compatibility-with-older-npx-versions">Compatibility with Older npx Versions</h3>
358<p>The <code>npx</code> binary was rewritten in npm v7.0.0, and the standalone <code>npx</code> package deprecated at that time.
359<code>npx</code> uses the <code>npm exec</code> command instead of a separate argument parser and install process, with some affordances to maintain backwards compatibility with the arguments it accepted in previous versions.</p>
360<p>This resulted in some shifts in its functionality:</p>
361<ul>
362<li>Any <code>npm</code> config value may be provided.</li>
363<li>To prevent security and user-experience problems from mistyping package
364names, <code>npx</code> prompts before installing anything.
365Suppress this prompt with the <code>-y</code> or <code>--yes</code> option.</li>
366<li>The <code>--no-install</code> option is deprecated, and will be converted to <code>--no</code>.</li>
367<li>Shell fallback functionality is removed, as it is not advisable.</li>
368<li>The <code>-p</code> argument is a shorthand for <code>--parseable</code> in npm, but shorthand for <code>--package</code> in npx.
369This is maintained, but only for the <code>npx</code> executable.</li>
370<li>The <code>--ignore-existing</code> option is removed.
371Locally installed bins are always present in the executed process <code>PATH</code>.</li>
372<li>The <code>--npm</code> option is removed.
373<code>npx</code> will always use the <code>npm</code> it ships with.</li>
374<li>The <code>--node-arg</code> and <code>-n</code> options are removed.</li>
375<li>The <code>--always-spawn</code> option is redundant, and thus removed.</li>
376<li>The <code>--shell</code> option is replaced with <code>--script-shell</code>, but maintained in the <code>npx</code> executable for backwards compatibility.</li>
377</ul>
378<h3 id="a-note-on-caching">A note on caching</h3>
379<p>The npm cli utilizes its internal package cache when using the package name specified.
380You can use the following to change how and when the cli uses this cache.
381See <a href="../commands/npm-cache.html"><code>npm cache</code></a> for more on how the cache works.</p>
382<h4 id="prefer-online">prefer-online</h4>
383<p>Forces staleness checks for packages, making the cli look for updates immediately even if the package is already in the cache.</p>
384<h4 id="prefer-offline">prefer-offline</h4>
385<p>Bypasses staleness checks for packages.
386Missing data will still be requested from the server.
387To force full offline mode, use <code>offline</code>.</p>
388<h4 id="offline">offline</h4>
389<p>Forces full offline mode.
390Any packages not locally cached will result in an error.</p>
391<h4 id="workspace2">workspace</h4>
392<ul>
393<li>Default:</li>
394<li>Type: String (can be set multiple times)</li>
395</ul>
396<p>Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.</p>
397<p>Valid values for the <code>workspace</code> config are either:</p>
398<ul>
399<li>Workspace names</li>
400<li>Path to a workspace directory</li>
401<li>Path to a parent workspace directory (will result to selecting all of the nested workspaces)</li>
402</ul>
403<p>This value is not exported to the environment for child processes.</p>
404<h4 id="workspaces2">workspaces</h4>
405<ul>
406<li>Alias: <code>--ws</code></li>
407<li>Type: Boolean</li>
408<li>Default: <code>false</code></li>
409</ul>
410<p>Run scripts in the context of all configured workspaces for the current project.</p>
411<h3 id="see-also">See Also</h3>
412<ul>
413<li><a href="../commands/npm-run.html">npm run</a></li>
414<li><a href="../using-npm/scripts.html">npm scripts</a></li>
415<li><a href="../commands/npm-test.html">npm test</a></li>
416<li><a href="../commands/npm-start.html">npm start</a></li>
417<li><a href="../commands/npm-restart.html">npm restart</a></li>
418<li><a href="../commands/npm-stop.html">npm stop</a></li>
419<li><a href="../commands/npm-config.html">npm config</a></li>
420<li><a href="../using-npm/workspaces.html">npm workspaces</a></li>
421<li><a href="../commands/npx.html">npx</a></li>
422</ul></div>
423
424<footer id="edit">
425<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-exec.md">
426<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
427<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>
428</svg>
429Edit this page on GitHub
430</a>
431</footer>
432</section>
433
434
435
436</body></html>