.TH "NPM\-CI" "1" "November 2022" "9.1.1"
.SH "NAME"
\fBnpm-ci\fR
.SH Synopsis
<!\-\- AUTOGENERATED USAGE DESCRIPTIONS \-\->

.SH Description
.P
This command is similar to \fBnpm install\fP, except
.br
it's meant to be used in automated environments such as test platforms,
.br
continuous integration, and deployment \-\- or any situation where you want
.br
to make sure you're doing a clean install of your dependencies\.
.P
The main differences between using \fBnpm install\fP and \fBnpm ci\fP are:

.RS 1
.IP \(bu 2
The project \fBmust\fR have an existing \fBpackage\-lock\.json\fP or
.br
\fBnpm\-shrinkwrap\.json\fP\|\.
.IP \(bu 2
If dependencies in the package lock do not match those in \fBpackage\.json\fP,
.br
\fBnpm ci\fP will exit with an error, instead of updating the package lock\.
.IP \(bu 2
\fBnpm ci\fP can only install entire projects at a time: individual
.br
dependencies cannot be added with this command\.
.IP \(bu 2
If a \fBnode_modules\fP is already present, it will be automatically removed
.br
before \fBnpm ci\fP begins its install\.
.IP \(bu 2
It will never write to \fBpackage\.json\fP or any of the package\-locks:
.br
installs are essentially frozen\.

.RE
.P
NOTE: If you create your \fBpackage\-lock\.json\fP file by running \fBnpm install\fP
.br
with flags that can affect the shape of your dependency tree, such as
.br
\fB\-\-legacy\-peer\-deps\fP or \fB\-\-install\-links\fP, you \fImust\fR provide the same
.br
flags to \fBnpm ci\fP or you are likely to encounter errors\. An easy way to do
.br
this is to run, for example,
.br
\fBnpm config set legacy\-peer\-deps=true \-\-location=project\fP and commit the
.br
\fB\|\.npmrc\fP file to your repo\.
.SH Example
.P
Make sure you have a package\-lock and an up\-to\-date install:
.RS 2
.nf
$ cd \./my/npm/project
$ npm install
added 154 packages in 10s
$ ls | grep package\-lock
.fi
.RE
.P
Run \fBnpm ci\fP in that project
.RS 2
.nf
$ npm ci
added 154 packages in 5s
.fi
.RE
.P
Configure Travis CI to build using \fBnpm ci\fP instead of \fBnpm install\fP:
.RS 2
.nf
# \.travis\.yml
install:
\- npm ci
# keep the npm cache around to speed up installs
cache:
  directories:
  \- "$HOME/\.npm"
.fi
.RE
.SH Configuration
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS \-\->

.SH See Also

.RS 1
.IP \(bu 2
npm install
.IP \(bu 2
package\-lock\.json

.RE