Synopsis

npm ci

Example

Make sure you have a package-lock and an up-to-date install:

$cd ./my/npm/project
$npminstall
added154 packagesin 10s
$ls|grep package-lock

Runnpm ci in that project

$npm ci
added154 packagesin 5s

Configure Travis to build usingnpm ci instead ofnpm install:

# .travis.yml
install:
-npm ci
# keep the npm cache around to speed up installs
cache:
  directories:
  -"$HOME/.npm"

Description

This command is similar tonpm install, except it's meant to be used in automated environments such as test platforms, continuous integration, and deployment -- or any situation where you want to make sure you're doing a clean install of your dependencies. It can be significantly faster than a regular npm install by skipping certain user-oriented features. It is also more strict than a regular install, which can help catch errors or inconsistencies caused by the incrementally-installed local environments of most npm users.

In short, the main differences between usingnpm install andnpm ci are:

• The projectmust have an existingpackage-lock.json ornpm-shrinkwrap.json.
• If dependencies in the package lock do not match those inpackage.json,npm ci will exit with an error, instead of updating the package lock.
• npm ci can only install entire projects at a time: individual dependencies cannot be added with this command.
• If anode_modules is already present, it will be automatically removed beforenpm ci begins its install.
• It will never write topackage.json or any of the package-locks: installs are essentially frozen.

See Also

• npm install
• package-locks

Edit this page on GitHub

1 contributorethomson

Last edited byethomson onSeptember 22, 2020