1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-ci</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-ci">npm-ci</h1> 140<span class="description">Clean install a project</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="#example">Example</a></li><li><a href="#configuration">Configuration</a></li><ul><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="#strict-peer-deps"><code>strict-peer-deps</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="#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 ci 150 151aliases: clean-install, ic, install-clean, isntall-clean 152</code></pre> 153<h3 id="description">Description</h3> 154<p>This command is similar to <a href="../commands/npm-install.html"><code>npm install</code></a>, except 155it's meant to be used in automated environments such as test platforms, 156continuous integration, and deployment -- or any situation where you want 157to make sure you're doing a clean install of your dependencies.</p> 158<p>The main differences between using <code>npm install</code> and <code>npm ci</code> are:</p> 159<ul> 160<li>The project <strong>must</strong> have an existing <code>package-lock.json</code> or 161<code>npm-shrinkwrap.json</code>.</li> 162<li>If dependencies in the package lock do not match those in <code>package.json</code>, 163<code>npm ci</code> will exit with an error, instead of updating the package lock.</li> 164<li><code>npm ci</code> can only install entire projects at a time: individual 165dependencies cannot be added with this command.</li> 166<li>If a <code>node_modules</code> is already present, it will be automatically removed 167before <code>npm ci</code> begins its install.</li> 168<li>It will never write to <code>package.json</code> or any of the package-locks: 169installs are essentially frozen.</li> 170</ul> 171<p>NOTE: If you create your <code>package-lock.json</code> file by running <code>npm install</code> 172with flags that can affect the shape of your dependency tree, such as 173<code>--legacy-peer-deps</code> or <code>--install-links</code>, you <em>must</em> provide the same 174flags to <code>npm ci</code> or you are likely to encounter errors. An easy way to do 175this is to run, for example, 176<code>npm config set legacy-peer-deps=true --location=project</code> and commit the 177<code>.npmrc</code> file to your repo.</p> 178<h3 id="example">Example</h3> 179<p>Make sure you have a package-lock and an up-to-date install:</p> 180<pre><code class="language-bash">$ cd ./my/npm/project 181$ npm install 182added 154 packages in 10s 183$ ls | grep package-lock 184</code></pre> 185<p>Run <code>npm ci</code> in that project</p> 186<pre><code class="language-bash">$ npm ci 187added 154 packages in 5s 188</code></pre> 189<p>Configure Travis CI to build using <code>npm ci</code> instead of <code>npm install</code>:</p> 190<pre><code class="language-bash"># .travis.yml 191install: 192- npm ci 193# keep the npm cache around to speed up installs 194cache: 195 directories: 196 - "$HOME/.npm" 197</code></pre> 198<h3 id="configuration">Configuration</h3> 199<h4 id="install-strategy"><code>install-strategy</code></h4> 200<ul> 201<li>Default: "hoisted"</li> 202<li>Type: "hoisted", "nested", "shallow", or "linked"</li> 203</ul> 204<p>Sets the strategy for installing packages in node_modules. hoisted 205(default): Install non-duplicated in top-level, and duplicated as necessary 206within directory structure. nested: (formerly --legacy-bundling) install in 207place, no hoisting. shallow (formerly --global-style) only install direct 208deps at top-level. linked: (experimental) install in node_modules/.store, 209link in place, unhoisted.</p> 210<h4 id="legacy-bundling"><code>legacy-bundling</code></h4> 211<ul> 212<li>Default: false</li> 213<li>Type: Boolean</li> 214<li>DEPRECATED: This option has been deprecated in favor of 215<code>--install-strategy=nested</code></li> 216</ul> 217<p>Instead of hoisting package installs in <code>node_modules</code>, install packages in 218the same manner that they are depended on. This may cause very deep 219directory structures and duplicate package installs as there is no 220de-duplicating. Sets <code>--install-strategy=nested</code>.</p> 221<h4 id="global-style"><code>global-style</code></h4> 222<ul> 223<li>Default: false</li> 224<li>Type: Boolean</li> 225<li>DEPRECATED: This option has been deprecated in favor of 226<code>--install-strategy=shallow</code></li> 227</ul> 228<p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist 229on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p> 230<h4 id="omit"><code>omit</code></h4> 231<ul> 232<li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to 233'production', otherwise empty.</li> 234<li>Type: "dev", "optional", or "peer" (can be set multiple times)</li> 235</ul> 236<p>Dependency types to omit from the installation tree on disk.</p> 237<p>Note that these dependencies <em>are</em> still resolved and added to the 238<code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not 239physically installed on disk.</p> 240<p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then 241it will be included.</p> 242<p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment 243variable will be set to <code>'production'</code> for all lifecycle scripts.</p> 244<h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4> 245<ul> 246<li>Default: false</li> 247<li>Type: Boolean</li> 248</ul> 249<p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em> 250conflicting <code>peerDependencies</code> will be treated as an install failure, even 251if npm could reasonably guess the appropriate resolution based on non-peer 252dependency relationships.</p> 253<p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will 254be resolved using the nearest non-peer dependency specification, even if 255doing so will result in some packages receiving a peer dependency outside 256the range set in their package's <code>peerDependencies</code> object.</p> 257<p>When such an override is performed, a warning is printed, explaining the 258conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then 259this warning is treated as a failure.</p> 260<h4 id="foreground-scripts"><code>foreground-scripts</code></h4> 261<ul> 262<li>Default: false</li> 263<li>Type: Boolean</li> 264</ul> 265<p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>) 266scripts for installed packages in the foreground process, sharing standard 267input, output, and error with the main npm process.</p> 268<p>Note that this will generally make installs run slower, and be much noisier, 269but can be useful for debugging.</p> 270<h4 id="ignore-scripts"><code>ignore-scripts</code></h4> 271<ul> 272<li>Default: false</li> 273<li>Type: Boolean</li> 274</ul> 275<p>If true, npm does not run scripts specified in package.json files.</p> 276<p>Note that commands explicitly intended to run a particular script, such as 277<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run-script</code> 278will still run their intended script if <code>ignore-scripts</code> is set, but they 279will <em>not</em> run any pre- or post-scripts.</p> 280<h4 id="audit"><code>audit</code></h4> 281<ul> 282<li>Default: true</li> 283<li>Type: Boolean</li> 284</ul> 285<p>When "true" submit audit reports alongside the current npm command to the 286default registry and all registries configured for scopes. See the 287documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is 288submitted.</p> 289<h4 id="bin-links"><code>bin-links</code></h4> 290<ul> 291<li>Default: true</li> 292<li>Type: Boolean</li> 293</ul> 294<p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package 295executables.</p> 296<p>Set to false to have it not do this. This can be used to work around the 297fact that some file systems don't support symlinks, even on ostensibly Unix 298systems.</p> 299<h4 id="fund"><code>fund</code></h4> 300<ul> 301<li>Default: true</li> 302<li>Type: Boolean</li> 303</ul> 304<p>When "true" displays the message at the end of each <code>npm install</code> 305acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p> 306<h4 id="dry-run"><code>dry-run</code></h4> 307<ul> 308<li>Default: false</li> 309<li>Type: Boolean</li> 310</ul> 311<p>Indicates that you don't want npm to make any changes and that it should 312only report what it would have done. This can be passed into any of the 313commands that modify your local installation, eg, <code>install</code>, <code>update</code>, 314<code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p> 315<p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>, 316<code>owner</code>, etc.</p> 317<h4 id="workspace"><code>workspace</code></h4> 318<ul> 319<li>Default:</li> 320<li>Type: String (can be set multiple times)</li> 321</ul> 322<p>Enable running a command in the context of the configured workspaces of the 323current project while filtering by running only the workspaces defined by 324this configuration option.</p> 325<p>Valid values for the <code>workspace</code> config are either:</p> 326<ul> 327<li>Workspace names</li> 328<li>Path to a workspace directory</li> 329<li>Path to a parent workspace directory (will result in selecting all 330workspaces within that folder)</li> 331</ul> 332<p>When set for the <code>npm init</code> command, this may be set to the folder of a 333workspace which does not yet exist, to create the folder and set it up as a 334brand new workspace within the project.</p> 335<p>This value is not exported to the environment for child processes.</p> 336<h4 id="workspaces"><code>workspaces</code></h4> 337<ul> 338<li>Default: null</li> 339<li>Type: null or Boolean</li> 340</ul> 341<p>Set to true to run the command in the context of <strong>all</strong> configured 342workspaces.</p> 343<p>Explicitly setting this to false will cause commands like <code>install</code> to 344ignore workspaces altogether. When not set explicitly:</p> 345<ul> 346<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.) 347will link workspaces into the <code>node_modules</code> folder. - Commands that do 348other things (test, exec, publish, etc.) will operate on the root project, 349<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li> 350</ul> 351<p>This value is not exported to the environment for child processes.</p> 352<h4 id="include-workspace-root"><code>include-workspace-root</code></h4> 353<ul> 354<li>Default: false</li> 355<li>Type: Boolean</li> 356</ul> 357<p>Include the workspace root when workspaces are enabled for a command.</p> 358<p>When false, specifying individual workspaces via the <code>workspace</code> config, or 359all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on 360the specified workspaces, and not on the root project.</p> 361<p>This value is not exported to the environment for child processes.</p> 362<h4 id="install-links"><code>install-links</code></h4> 363<ul> 364<li>Default: false</li> 365<li>Type: Boolean</li> 366</ul> 367<p>When set file: protocol dependencies will be packed and installed as regular 368dependencies instead of creating a symlink. This option has no effect on 369workspaces.</p> 370<h3 id="see-also">See Also</h3> 371<ul> 372<li><a href="../commands/npm-install.html">npm install</a></li> 373<li><a href="../configuring-npm/package-lock-json.html">package-lock.json</a></li> 374</ul></div> 375 376<footer id="edit"> 377<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-ci.md"> 378<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 379<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> 380</svg> 381Edit this page on GitHub 382</a> 383</footer> 384</section> 385 386 387 388</body></html>