1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-install-test</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 116footer#edit { 117 border-top: solid 1px #e1e4e8; 118 margin: 3em 0 4em 0; 119 padding-top: 2em; 120} 121</style> 122</head> 123<body> 124<div id="banner"> 125<div id="rainbar"></div> 126<div id="logobar"> 127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 130</svg> 131<div class="title"> 132npm command-line interface 133</div> 134</div> 135</div> 136 137<section id="content"> 138<header class="title"> 139<h1 id="npm-install-test">npm-install-test</h1> 140<span class="description">Install package(s) and run tests</span> 141</header> 142 143<section id="table_of_contents"> 144<h2 id="table-of-contents">Table of contents</h2> 145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#save"><code>save</code></a></li><li><a href="#save-exact"><code>save-exact</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#install-strategy"><code>install-strategy</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#prefer-dedupe"><code>prefer-dedupe</code></a></li><li><a href="#package-lock"><code>package-lock</code></a></li><li><a href="#package-lock-only"><code>package-lock-only</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#audit"><code>audit</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#fund"><code>fund</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#cpu"><code>cpu</code></a></li><li><a href="#os"><code>os</code></a></li><li><a href="#libc"><code>libc</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><li><a href="#install-links"><code>install-links</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> 146</section> 147 148<div id="_content"><h3 id="synopsis">Synopsis</h3> 149<pre><code class="language-bash">npm install-test [<package-spec> ...] 150 151alias: it 152</code></pre> 153<h3 id="description">Description</h3> 154<p>This command runs an <code>npm install</code> followed immediately by an <code>npm test</code>. It 155takes exactly the same arguments as <code>npm install</code>.</p> 156<h3 id="configuration">Configuration</h3> 157<h4 id="save"><code>save</code></h4> 158<ul> 159<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li> 160<li>Type: Boolean</li> 161</ul> 162<p>Save installed packages to a <code>package.json</code> file as dependencies.</p> 163<p>When used with the <code>npm rm</code> command, removes the dependency from 164<code>package.json</code>.</p> 165<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p> 166<h4 id="save-exact"><code>save-exact</code></h4> 167<ul> 168<li>Default: false</li> 169<li>Type: Boolean</li> 170</ul> 171<p>Dependencies saved to package.json will be configured with an exact version 172rather than using npm's default semver range operator.</p> 173<h4 id="global"><code>global</code></h4> 174<ul> 175<li>Default: false</li> 176<li>Type: Boolean</li> 177</ul> 178<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code> 179folder instead of the current working directory. See 180<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 181<ul> 182<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 183of the current working directory.</li> 184<li>bin files are linked to <code>{prefix}/bin</code></li> 185<li>man pages are linked to <code>{prefix}/share/man</code></li> 186</ul> 187<h4 id="install-strategy"><code>install-strategy</code></h4> 188<ul> 189<li>Default: "hoisted"</li> 190<li>Type: "hoisted", "nested", "shallow", or "linked"</li> 191</ul> 192<p>Sets the strategy for installing packages in node_modules. hoisted 193(default): Install non-duplicated in top-level, and duplicated as necessary 194within directory structure. nested: (formerly --legacy-bundling) install in 195place, no hoisting. shallow (formerly --global-style) only install direct 196deps at top-level. linked: (experimental) install in node_modules/.store, 197link in place, unhoisted.</p> 198<h4 id="legacy-bundling"><code>legacy-bundling</code></h4> 199<ul> 200<li>Default: false</li> 201<li>Type: Boolean</li> 202<li>DEPRECATED: This option has been deprecated in favor of 203<code>--install-strategy=nested</code></li> 204</ul> 205<p>Instead of hoisting package installs in <code>node_modules</code>, install packages in 206the same manner that they are depended on. This may cause very deep 207directory structures and duplicate package installs as there is no 208de-duplicating. Sets <code>--install-strategy=nested</code>.</p> 209<h4 id="global-style"><code>global-style</code></h4> 210<ul> 211<li>Default: false</li> 212<li>Type: Boolean</li> 213<li>DEPRECATED: This option has been deprecated in favor of 214<code>--install-strategy=shallow</code></li> 215</ul> 216<p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist 217on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p> 218<h4 id="omit"><code>omit</code></h4> 219<ul> 220<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to 221'production', otherwise empty.</li> 222<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li> 223</ul> 224<p>Dependency types to omit from the installation tree on disk.</p> 225<p>Note that these dependencies <em>are</em> still resolved and added to the 226<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not 227physically installed on disk.</p> 228<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then 229it will be included.</p> 230<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment 231variable will be set to <code>'production'</code> for all lifecycle scripts.</p> 232<h4 id="include"><code>include</code></h4> 233<ul> 234<li>Default:</li> 235<li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li> 236</ul> 237<p>Option that allows for defining which types of dependencies to install.</p> 238<p>This is the inverse of <code>--omit=<type></code>.</p> 239<p>Dependency types specified in <code>--include</code> will not be omitted, regardless of 240the order in which omit/include are specified on the command-line.</p> 241<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> 242<ul> 243<li>Default: false</li> 244<li>Type: Boolean</li> 245</ul> 246<p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em> 247conflicting <code>peerDependencies</code> will be treated as an install failure, even 248if npm could reasonably guess the appropriate resolution based on non-peer 249dependency relationships.</p> 250<p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will 251be resolved using the nearest non-peer dependency specification, even if 252doing so will result in some packages receiving a peer dependency outside 253the range set in their package's <code>peerDependencies</code> object.</p> 254<p>When such an override is performed, a warning is printed, explaining the 255conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then 256this warning is treated as a failure.</p> 257<h4 id="prefer-dedupe"><code>prefer-dedupe</code></h4> 258<ul> 259<li>Default: false</li> 260<li>Type: Boolean</li> 261</ul> 262<p>Prefer to deduplicate packages if possible, rather than choosing a newer 263version of a dependency.</p> 264<h4 id="package-lock"><code>package-lock</code></h4> 265<ul> 266<li>Default: true</li> 267<li>Type: Boolean</li> 268</ul> 269<p>If set to false, then ignore <code>package-lock.json</code> files when installing. This 270will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p> 271<h4 id="package-lock-only"><code>package-lock-only</code></h4> 272<ul> 273<li>Default: false</li> 274<li>Type: Boolean</li> 275</ul> 276<p>If set to true, the current operation will only use the <code>package-lock.json</code>, 277ignoring <code>node_modules</code>.</p> 278<p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated, 279instead of checking <code>node_modules</code> and downloading dependencies.</p> 280<p>For <code>list</code> this means the output will be based on the tree described by the 281<code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p> 282<h4 id="foreground-scripts"><code>foreground-scripts</code></h4> 283<ul> 284<li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it 285defaults to <code>true</code></li> 286<li>Type: Boolean</li> 287</ul> 288<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>) 289scripts for installed packages in the foreground process, sharing standard 290input, output, and error with the main npm process.</p> 291<p>Note that this will generally make installs run slower, and be much noisier, 292but can be useful for debugging.</p> 293<h4 id="ignore-scripts"><code>ignore-scripts</code></h4> 294<ul> 295<li>Default: false</li> 296<li>Type: Boolean</li> 297</ul> 298<p>If true, npm does not run scripts specified in package.json files.</p> 299<p>Note that commands explicitly intended to run a particular script, such as 300<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> 301will still run their intended script if <code>ignore-scripts</code> is set, but they 302will <em>not</em> run any pre- or post-scripts.</p> 303<h4 id="audit"><code>audit</code></h4> 304<ul> 305<li>Default: true</li> 306<li>Type: Boolean</li> 307</ul> 308<p>When "true" submit audit reports alongside the current npm command to the 309default registry and all registries configured for scopes. See the 310documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is 311submitted.</p> 312<h4 id="bin-links"><code>bin-links</code></h4> 313<ul> 314<li>Default: true</li> 315<li>Type: Boolean</li> 316</ul> 317<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package 318executables.</p> 319<p>Set to false to have it not do this. This can be used to work around the 320fact that some file systems don't support symlinks, even on ostensibly Unix 321systems.</p> 322<h4 id="fund"><code>fund</code></h4> 323<ul> 324<li>Default: true</li> 325<li>Type: Boolean</li> 326</ul> 327<p>When "true" displays the message at the end of each <code>npm install</code> 328acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> 329<h4 id="dry-run"><code>dry-run</code></h4> 330<ul> 331<li>Default: false</li> 332<li>Type: Boolean</li> 333</ul> 334<p>Indicates that you don't want npm to make any changes and that it should 335only report what it would have done. This can be passed into any of the 336commands that modify your local installation, eg, <code>install</code>, <code>update</code>, 337<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> 338<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, 339<code>owner</code>, etc.</p> 340<h4 id="cpu"><code>cpu</code></h4> 341<ul> 342<li>Default: null</li> 343<li>Type: null or String</li> 344</ul> 345<p>Override CPU architecture of native modules to install. Acceptable values 346are same as <code>cpu</code> field of package.json, which comes from <code>process.arch</code>.</p> 347<h4 id="os"><code>os</code></h4> 348<ul> 349<li>Default: null</li> 350<li>Type: null or String</li> 351</ul> 352<p>Override OS of native modules to install. Acceptable values are same as <code>os</code> 353field of package.json, which comes from <code>process.platform</code>.</p> 354<h4 id="libc"><code>libc</code></h4> 355<ul> 356<li>Default: null</li> 357<li>Type: null or String</li> 358</ul> 359<p>Override libc of native modules to install. Acceptable values are same as 360<code>libc</code> field of package.json</p> 361<h4 id="workspace"><code>workspace</code></h4> 362<ul> 363<li>Default:</li> 364<li>Type: String (can be set multiple times)</li> 365</ul> 366<p>Enable running a command in the context of the configured workspaces of the 367current project while filtering by running only the workspaces defined by 368this configuration option.</p> 369<p>Valid values for the <code>workspace</code> config are either:</p> 370<ul> 371<li>Workspace names</li> 372<li>Path to a workspace directory</li> 373<li>Path to a parent workspace directory (will result in selecting all 374workspaces within that folder)</li> 375</ul> 376<p>When set for the <code>npm init</code> command, this may be set to the folder of a 377workspace which does not yet exist, to create the folder and set it up as a 378brand new workspace within the project.</p> 379<p>This value is not exported to the environment for child processes.</p> 380<h4 id="workspaces"><code>workspaces</code></h4> 381<ul> 382<li>Default: null</li> 383<li>Type: null or Boolean</li> 384</ul> 385<p>Set to true to run the command in the context of <strong>all</strong> configured 386workspaces.</p> 387<p>Explicitly setting this to false will cause commands like <code>install</code> to 388ignore workspaces altogether. When not set explicitly:</p> 389<ul> 390<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.) 391will link workspaces into the <code>node_modules</code> folder. - Commands that do 392other things (test, exec, publish, etc.) will operate on the root project, 393<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li> 394</ul> 395<p>This value is not exported to the environment for child processes.</p> 396<h4 id="include-workspace-root"><code>include-workspace-root</code></h4> 397<ul> 398<li>Default: false</li> 399<li>Type: Boolean</li> 400</ul> 401<p>Include the workspace root when workspaces are enabled for a command.</p> 402<p>When false, specifying individual workspaces via the <code>workspace</code> config, or 403all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on 404the specified workspaces, and not on the root project.</p> 405<p>This value is not exported to the environment for child processes.</p> 406<h4 id="install-links"><code>install-links</code></h4> 407<ul> 408<li>Default: false</li> 409<li>Type: Boolean</li> 410</ul> 411<p>When set file: protocol dependencies will be packed and installed as regular 412dependencies instead of creating a symlink. This option has no effect on 413workspaces.</p> 414<h3 id="see-also">See Also</h3> 415<ul> 416<li><a href="../commands/npm-install.html">npm install</a></li> 417<li><a href="../commands/npm-install-ci-test.html">npm install-ci-test</a></li> 418<li><a href="../commands/npm-test.html">npm test</a></li> 419</ul></div> 420 421<footer id="edit"> 422<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-install-test.md"> 423<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 424<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> 425</svg> 426Edit this page on GitHub 427</a> 428</footer> 429</section> 430 431 432 433</body></html>