mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 16:39:33 +00:00
1f287b04a2
PR-URL: https://github.com/nodejs/node/pull/36953 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
72 lines
1.8 KiB
Markdown
72 lines
1.8 KiB
Markdown
---
|
|
title: npm-ci
|
|
section: 1
|
|
description: Install a project with a clean slate
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm ci
|
|
```
|
|
|
|
### Description
|
|
|
|
This command is similar to [`npm install`](/cli-commands/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.
|
|
|
|
`npm ci` will be significantly faster when:
|
|
|
|
- There is a `package-lock.json` or `npm-shrinkwrap.json` file.
|
|
- The `node_modules` folder is missing or empty.
|
|
|
|
In short, the main differences between using `npm install` and `npm ci` are:
|
|
|
|
* The project **must** have an existing `package-lock.json` or
|
|
`npm-shrinkwrap.json`.
|
|
* If dependencies in the package lock do not match those in `package.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 a `node_modules` is already present, it will be automatically removed
|
|
before `npm ci` begins its install.
|
|
* It will never write to `package.json` or any of the package-locks:
|
|
installs are essentially frozen.
|
|
|
|
### Example
|
|
|
|
Make sure you have a package-lock and an up-to-date install:
|
|
|
|
```bash
|
|
$ cd ./my/npm/project
|
|
$ npm install
|
|
added 154 packages in 10s
|
|
$ ls | grep package-lock
|
|
```
|
|
|
|
Run `npm ci` in that project
|
|
|
|
```bash
|
|
$ npm ci
|
|
added 154 packages in 5s
|
|
```
|
|
|
|
Configure Travis to build using `npm ci` instead of `npm install`:
|
|
|
|
```bash
|
|
# .travis.yml
|
|
install:
|
|
- npm ci
|
|
# keep the npm cache around to speed up installs
|
|
cache:
|
|
directories:
|
|
- "$HOME/.npm"
|
|
```
|
|
|
|
### See Also
|
|
|
|
* [npm install](/commands/npm-install)
|
|
* [package-lock.json](/configuring-npm/package-lock-json)
|