@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
gat-bypass-2fa-docs
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 532 lines 22.7 KB
Raw
1 ---
2 title: npm-install
3 section: 1
4 description: Install a package
5 github_repo: npm/cli
6 github_branch: release/v8
7 github_path: docs/lib/content/commands/npm-install.md
8 redirect_from:
9 - /cli-documentation/v8/cli-commands/install
10 - /cli-documentation/v8/cli-commands/npm-install
11 - /cli-documentation/v8/commands/install
12 - /cli-documentation/v8/commands/npm-install
13 - /cli-documentation/v8/install
14 - /cli-documentation/v8/npm-install
15 - /cli/v8/cli-commands/install
16 - /cli/v8/cli-commands/npm-install
17 - /cli/v8/commands/install
18 - /cli/v8/install
19 - /cli/v8/npm-install
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm install [<package-spec> ...]
26
27 aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
28 ```
29
30 ### Description
31
32 This command installs a package and any packages that it depends on. If the package has a package-lock, or an npm shrinkwrap file, or a yarn lock file, the installation of dependencies will be driven by that, respecting the following order of precedence:
33
34 - `npm-shrinkwrap.json`
35 - `package-lock.json`
36 - `yarn.lock`
37
38 See [package-lock.json](/cli/v8/configuring-npm/package-lock-json) and [`npm shrinkwrap`](/cli/v8/commands/npm-shrinkwrap).
39
40 A `package` is:
41
42 - a) a folder containing a program described by a [`package.json`](/cli/v8/configuring-npm/package-json) file
43 - b) a gzipped tarball containing (a)
44 - c) a url that resolves to (b)
45 - d) a `<name>@<version>` that is published on the registry (see [`registry`](/cli/v8/using-npm/registry)) with (c)
46 - e) a `<name>@<tag>` (see [`npm dist-tag`](/cli/v8/commands/npm-dist-tag)) that points to (d)
47 - f) a `<name>` that has a "latest" tag satisfying (e)
48 - g) a `<git remote url>` that resolves to (a)
49
50 Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b).
51
52 - `npm install` (in a package directory, no arguments):
53
54 Install the dependencies to the local `node_modules` folder.
55
56 In global mode (ie, with `-g` or `--global` appended to the command), it installs the current package context (ie, the current working directory) as a global package.
57
58 By default, `npm install` will install all modules listed as dependencies in [`package.json`](/cli/v8/configuring-npm/package-json).
59
60 With the `--production` flag (or when the `NODE_ENV` environment variable is set to `production`), npm will not install modules listed in `devDependencies`. To install all modules listed in both `dependencies` and `devDependencies` when `NODE_ENV` environment variable is set to `production`, you can use `--production=false`.
61
62 > NOTE: The `--production` flag has no particular meaning when adding a dependency to a project.
63
64 - `npm install <folder>`:
65
66 If `<folder>` sits inside the root of your project, its dependencies will be installed and may be hoisted to the top-level `node_modules` as they would for other types of dependencies. If `<folder>` sits outside the root of your project, _npm will not install the package dependencies_ in the directory `<folder>`, but it will create a symlink to `<folder>`.
67
68 > NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use the `--install-links` option.
69
70 Example:
71
72 ```bash
73 npm install ../../other-package --install-links
74 npm install ./sub-package
75 ```
76
77 - `npm install <tarball file>`:
78
79 Install a package that is sitting on the filesystem. Note: if you just want to link a dev directory into your npm root, you can do this more easily by using [`npm link`](/cli/v8/commands/npm-link).
80
81 Tarball requirements:
82 - The filename _must_ use `.tar`, `.tar.gz`, or `.tgz` as the extension.
83 - The package contents should reside in a subfolder inside the tarball (usually it is called `package/`). npm strips one directory layer when installing the package (an equivalent of `tar x --strip-components=1` is run).
84 - The package must contain a `package.json` file with `name` and `version` properties.
85
86 Example:
87
88 ```bash
89 npm install ./package.tgz
90 ```
91
92 - `npm install <tarball url>`:
93
94 Fetch the tarball url, and then install it. In order to distinguish between this and other options, the argument must start with "http://" or "https://"
95
96 Example:
97
98 ```bash
99 npm install https://github.com/indexzero/forever/tarball/v0.5.6
100 ```
101
102 - `npm install [<@scope>/]<name>`:
103
104 Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See [`config`](/cli/v8/using-npm/config). The config's default value is `latest`.)
105
106 In most cases, this will install the version of the modules tagged as `latest` on the npm registry.
107
108 Example:
109
110 ```bash
111 npm install sax
112 ```
113
114 `npm install` saves any specified packages into `dependencies` by default. Additionally, you can control where and how they get saved with some additional flags:
115 - `-P, --save-prod`: Package will appear in your `dependencies`. This is the default unless `-D` or `-O` are present.
116
117 - `-D, --save-dev`: Package will appear in your `devDependencies`.
118
119 - `-O, --save-optional`: Package will appear in your `optionalDependencies`.
120
121 - `--no-save`: Prevents saving to `dependencies`.
122
123 When using any of the above options to save dependencies to your package.json, there are two additional, optional flags:
124 - `-E, --save-exact`: Saved dependencies will be configured with an exact version rather than using npm's default semver range operator.
125
126 - `-B, --save-bundle`: Saved dependencies will also be added to your `bundleDependencies` list.
127
128 Further, if you have an `npm-shrinkwrap.json` or `package-lock.json` then it will be updated as well.
129
130 `<scope>` is optional. The package will be downloaded from the registry associated with the specified scope. If no registry is associated with the given scope the default registry is assumed. See [`scope`](/cli/v8/using-npm/scope).
131
132 Note: if you do not include the @-symbol on your scope name, npm will interpret this as a GitHub repository instead, see below. Scopes names must also be followed by a slash.
133
134 Examples:
135
136 ```bash
137 npm install sax
138 npm install githubname/reponame
139 npm install @myorg/privatepackage
140 npm install node-tap --save-dev
141 npm install dtrace-provider --save-optional
142 npm install readable-stream --save-exact
143 npm install ansi-regex --save-bundle
144 ```
145
146 **Note**: If there is a file or folder named `<name>` in the current working directory, then it will try to install that, and only try to fetch the package by name if it is not valid.
147
148 - `npm install <alias>@npm:<name>`:
149
150 Install a package under a custom alias. Allows multiple versions of a same-name package side-by-side, more convenient import names for packages with otherwise long ones, and using git forks replacements or forked npm packages as replacements. Aliasing works only on your project and does not rename packages in transitive dependencies. Aliases should follow the naming conventions stated in [`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name#naming-rules).
151
152 Examples:
153
154 ```bash
155 npm install my-react@npm:react
156 npm install jquery2@npm:jquery@2
157 npm install jquery3@npm:jquery@3
158 npm install npa@npm:npm-package-arg
159 ```
160
161 - `npm install [<@scope>/]<name>@<tag>`:
162
163 Install the version of the package that is referenced by the specified tag. If the tag does not exist in the registry data for that package, then this will fail.
164
165 Example:
166
167 ```bash
168 npm install sax@latest
169 npm install @myorg/mypackage@latest
170 ```
171
172 - `npm install [<@scope>/]<name>@<version>`:
173
174 Install the specified version of the package. This will fail if the version has not been published to the registry.
175
176 Example:
177
178 ```bash
179 npm install sax@0.1.1
180 npm install @myorg/privatepackage@1.5.0
181 ```
182
183 - `npm install [<@scope>/]<name>@<version range>`:
184
185 Install a version of the package matching the specified version range. This will follow the same rules for resolving dependencies described in [`package.json`](/cli/v8/configuring-npm/package-json).
186
187 Note that most version ranges must be put in quotes so that your shell will treat it as a single argument.
188
189 Example:
190
191 ```bash
192 npm install sax@">=0.1.0 <0.2.0"
193 npm install @myorg/privatepackage@"16 - 17"
194 ```
195
196 - `npm install <git remote url>`:
197
198 Installs the package from the hosted git provider, cloning it with `git`. For a full git remote url, only that URL will be attempted.
199
200 ```bash
201 <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
202 ```
203
204 `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or `git+file`.
205
206 If `#<commit-ish>` is provided, it will be used to clone exactly that commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is specified, then the default branch of the repository is used.
207
208 If the repository makes use of submodules, those submodules will be cloned as well.
209
210 If the package being installed contains a `prepare` script, its `dependencies` and `devDependencies` will be installed, and the prepare script will be run, before the package is packaged and installed.
211
212 The following git environment variables are recognized by npm and will be added to the environment when running git:
213 - `GIT_ASKPASS`
214 - `GIT_EXEC_PATH`
215 - `GIT_PROXY_COMMAND`
216 - `GIT_SSH`
217 - `GIT_SSH_COMMAND`
218 - `GIT_SSL_CAINFO`
219 - `GIT_SSL_NO_VERIFY`
220
221 See the git man page for details.
222
223 Examples:
224
225 ```bash
226 npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
227 npm install git+ssh://git@github.com:npm/cli#pull/273
228 npm install git+ssh://git@github.com:npm/cli#semver:^5.0
229 npm install git+https://isaacs@github.com/npm/cli.git
230 npm install git://github.com/npm/cli.git#v1.0.27
231 GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
232 ```
233
234 - `npm install <githubname>/<githubrepo>[#<commit-ish>]`:
235 - `npm install github:<githubname>/<githubrepo>[#<commit-ish>]`:
236
237 Install the package at `https://github.com/githubname/githubrepo` by attempting to clone it using `git`.
238
239 If `#<commit-ish>` is provided, it will be used to clone exactly that commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is specified, then the default branch is used.
240
241 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
242
243 Examples:
244
245 ```bash
246 npm install mygithubuser/myproject
247 npm install github:mygithubuser/myproject
248 ```
249
250 - `npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]`:
251
252 Install the package at `https://gist.github.com/gistID` by attempting to clone it using `git`. The GitHub username associated with the gist is optional and will not be saved in `package.json`.
253
254 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
255
256 Example:
257
258 ```bash
259 npm install gist:101a11beef
260 ```
261
262 - `npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]`:
263
264 Install the package at `https://bitbucket.org/bitbucketname/bitbucketrepo` by attempting to clone it using `git`.
265
266 If `#<commit-ish>` is provided, it will be used to clone exactly that commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is specified, then `master` is used.
267
268 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
269
270 Example:
271
272 ```bash
273 npm install bitbucket:mybitbucketuser/myproject
274 ```
275
276 - `npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]`:
277
278 Install the package at `https://gitlab.com/gitlabname/gitlabrepo` by attempting to clone it using `git`.
279
280 If `#<commit-ish>` is provided, it will be used to clone exactly that commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is specified, then `master` is used.
281
282 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
283
284 Example:
285
286 ```bash
287 npm install gitlab:mygitlabuser/myproject
288 npm install gitlab:myusr/myproj#semver:^5.0
289 ```
290
291 You may combine multiple arguments and even multiple types of arguments. For example:
292
293 ```bash
294 npm install sax@">=0.1.0 <0.2.0" bench supervisor
295 ```
296
297 The `--tag` argument will apply to all of the specified install targets. If a tag with the given name exists, the tagged version is preferred over newer versions.
298
299 The `--dry-run` argument will report in the usual way what the install would have done without actually installing anything.
300
301 The `--package-lock-only` argument will only update the `package-lock.json`, instead of checking `node_modules` and downloading dependencies.
302
303 The `-f` or `--force` argument will force npm to fetch remote resources even if a local copy exists on disk.
304
305 ```bash
306 npm install sax --force
307 ```
308
309 ### Configuration
310
311 See the [`config`](/cli/v8/using-npm/config) help doc. Many of the configuration params have some effect on installation, since that's most of what npm does.
312
313 These are some of the most common options related to installation.
314
315 #### `save`
316
317 - Default: `true` unless when using `npm update` where it defaults to `false`
318 - Type: Boolean
319
320 Save installed packages to a `package.json` file as dependencies.
321
322 When used with the `npm rm` command, removes the dependency from `package.json`.
323
324 Will also prevent writing to `package-lock.json` if set to `false`.
325
326 #### `save-exact`
327
328 - Default: false
329 - Type: Boolean
330
331 Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.
332
333 #### `global`
334
335 - Default: false
336 - Type: Boolean
337
338 Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v8/configuring-npm/folders) for more on the differences in behavior.
339
340 - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory.
341 - bin files are linked to `{prefix}/bin`
342 - man pages are linked to `{prefix}/share/man`
343
344 #### `global-style`
345
346 - Default: false
347 - Type: Boolean
348
349 Causes npm to install the package into your local `node_modules` folder with the same layout it uses with the global `node_modules` folder. Only your direct dependencies will show in `node_modules` and everything they depend on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred.
350
351 #### `legacy-bundling`
352
353 - Default: false
354 - Type: Boolean
355
356 Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred.
357
358 #### `omit`
359
360 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
361 - Type: "dev", "optional", or "peer" (can be set multiple times)
362
363 Dependency types to omit from the installation tree on disk.
364
365 Note that these dependencies _are_ still resolved and added to the `package-lock.json` or `npm-shrinkwrap.json` file. They are just not physically installed on disk.
366
367 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
368
369 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
370
371 #### `strict-peer-deps`
372
373 - Default: false
374 - Type: Boolean
375
376 If set to `true`, and `--legacy-peer-deps` is not set, then _any_ conflicting `peerDependencies` will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.
377
378 By default, conflicting `peerDependencies` deep in the dependency graph will be resolved using the nearest non-peer dependency specification, even if doing so will result in some packages receiving a peer dependency outside the range set in their package's `peerDependencies` object.
379
380 When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure.
381
382 #### `package-lock`
383
384 - Default: true
385 - Type: Boolean
386
387 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
388
389 This configuration does not affect `npm ci`.
390
391 #### `foreground-scripts`
392
393 - Default: false
394 - Type: Boolean
395
396 Run all build scripts (ie, `preinstall`, `install`, and `postinstall`) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
397
398 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
399
400 #### `ignore-scripts`
401
402 - Default: false
403 - Type: Boolean
404
405 If true, npm does not run scripts specified in package.json files.
406
407 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
408
409 #### `audit`
410
411 - Default: true
412 - Type: Boolean
413
414 When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v8/commands/npm-audit) for details on what is submitted.
415
416 #### `bin-links`
417
418 - Default: true
419 - Type: Boolean
420
421 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
422
423 Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.
424
425 #### `fund`
426
427 - Default: true
428 - Type: Boolean
429
430 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v8/commands/npm-fund) for details.
431
432 #### `dry-run`
433
434 - Default: false
435 - Type: Boolean
436
437 Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
438
439 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
440
441 #### `workspace`
442
443 - Default:
444 - Type: String (can be set multiple times)
445
446 Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
447
448 Valid values for the `workspace` config are either:
449
450 - Workspace names
451 - Path to a workspace directory
452 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
453
454 When set for the `npm init` command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
455
456 This value is not exported to the environment for child processes.
457
458 #### `workspaces`
459
460 - Default: null
461 - Type: null or Boolean
462
463 Set to true to run the command in the context of **all** configured workspaces.
464
465 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
466
467 - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config.
468
469 This value is not exported to the environment for child processes.
470
471 #### `include-workspace-root`
472
473 - Default: false
474 - Type: Boolean
475
476 Include the workspace root when workspaces are enabled for a command.
477
478 When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project.
479
480 This value is not exported to the environment for child processes.
481
482 #### `install-links`
483
484 - Default: false
485 - Type: Boolean
486
487 When set file: protocol dependencies that exist outside of the project root will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
488
489 ### Algorithm
490
491 Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`, the npm install algorithm produces:
492
493 ```bash
494 A
495 +-- B
496 +-- C
497 +-- D
498 ```
499
500 That is, the dependency from B to C is satisfied by the fact that A already caused C to be installed at a higher level. D is still installed at the top level because nothing conflicts with it.
501
502 For `A{B,C}, B{C,D@1}, C{D@2}`, this algorithm produces:
503
504 ```bash
505 A
506 +-- B
507 +-- C
508 `-- D@2
509 +-- D@1
510 ```
511
512 Because B's D@1 will be installed in the top-level, C now has to install D@2 privately for itself. This algorithm is deterministic, but different trees may be produced if two dependencies are requested for installation in a different order.
513
514 See [folders](/cli/v8/configuring-npm/folders) for a more detailed description of the specific folder structures that npm creates.
515
516 ### See Also
517
518 - [npm folders](/cli/v8/configuring-npm/folders)
519 - [npm update](/cli/v8/commands/npm-update)
520 - [npm audit](/cli/v8/commands/npm-audit)
521 - [npm fund](/cli/v8/commands/npm-fund)
522 - [npm link](/cli/v8/commands/npm-link)
523 - [npm rebuild](/cli/v8/commands/npm-rebuild)
524 - [npm scripts](/cli/v8/using-npm/scripts)
525 - [npm config](/cli/v8/commands/npm-config)
526 - [npmrc](/cli/v8/configuring-npm/npmrc)
527 - [npm registry](/cli/v8/using-npm/registry)
528 - [npm dist-tag](/cli/v8/commands/npm-dist-tag)
529 - [npm uninstall](/cli/v8/commands/npm-uninstall)
530 - [npm shrinkwrap](/cli/v8/commands/npm-shrinkwrap)
531 - [package.json](/cli/v8/configuring-npm/package-json)
532 - [workspaces](/cli/v8/using-npm/workspaces)