@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
dhei/classic-tokens
@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 614 lines 25.5 KB
Raw
1 ---
2 title: npm-install
3 section: 1
4 description: Install a package
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/commands/npm-install.md
8 redirect_from:
9 - /cli-commands/install
10 - /cli-commands/npm-install
11 - /cli-documentation/cli-commands/install
12 - /cli-documentation/cli-commands/npm-install
13 - /cli-documentation/commands/install
14 - /cli-documentation/commands/npm-install
15 - /cli-documentation/install
16 - /cli-documentation/npm-install
17 - /cli-documentation/v11/cli-commands/install
18 - /cli-documentation/v11/cli-commands/npm-install
19 - /cli-documentation/v11/commands/install
20 - /cli-documentation/v11/commands/npm-install
21 - /cli-documentation/v11/install
22 - /cli-documentation/v11/npm-install
23 - /cli/cli-commands/install
24 - /cli/cli-commands/npm-install
25 - /cli/commands/install
26 - /cli/commands/npm-install
27 - /cli/install
28 - /cli/npm-install
29 - /cli/v11/cli-commands/install
30 - /cli/v11/cli-commands/npm-install
31 - /cli/v11/commands/install
32 - /cli/v11/install
33 - /cli/v11/npm-install
34 - /commands/install
35 - /commands/npm-install
36 ---
37
38 ### Synopsis
39
40 ```bash
41 npm install [<package-spec> ...]
42
43 aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
44 ```
45
46 ### Description
47
48 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:
49
50 - `npm-shrinkwrap.json`
51 - `package-lock.json`
52 - `yarn.lock`
53
54 See [package-lock.json](/cli/v11/configuring-npm/package-lock-json) and [`npm shrinkwrap`](/cli/v11/commands/npm-shrinkwrap).
55
56 A `package` is:
57
58 - a) a folder containing a program described by a [`package.json`](/cli/v11/configuring-npm/package-json) file
59 - b) a gzipped tarball containing (a)
60 - c) a url that resolves to (b)
61 - d) a `<name>@<version>` that is published on the registry (see [`registry`](/cli/v11/using-npm/registry)) with (c)
62 - e) a `<name>@<tag>` (see [`npm dist-tag`](/cli/v11/commands/npm-dist-tag)) that points to (d)
63 - f) a `<name>` that has a "latest" tag satisfying (e)
64 - g) a `<git remote url>` that resolves to (a)
65
66 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).
67
68 - `npm install` (in a package directory, no arguments):
69
70 Install the dependencies to the local `node_modules` folder.
71
72 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.
73
74 By default, `npm install` will install all modules listed as dependencies in [`package.json`](/cli/v11/configuring-npm/package-json).
75
76 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`.
77
78 > NOTE: The `--production` flag has no particular meaning when adding a dependency to a project.
79
80 - `npm install <folder>`:
81
82 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>`.
83
84 > 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.
85
86 Example:
87
88 ```bash
89 npm install ../../other-package --install-links
90 npm install ./sub-package
91 ```
92
93 - `npm install <tarball file>`:
94
95 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/v11/commands/npm-link).
96
97 Tarball requirements:
98 - The filename _must_ use `.tar`, `.tar.gz`, or `.tgz` as the extension.
99 - 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).
100 - The package must contain a `package.json` file with `name` and `version` properties.
101
102 Example:
103
104 ```bash
105 npm install ./package.tgz
106 ```
107
108 - `npm install <tarball url>`:
109
110 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://"
111
112 Example:
113
114 ```bash
115 npm install https://github.com/indexzero/forever/tarball/v0.5.6
116 ```
117
118 - `npm install [<@scope>/]<name>`:
119
120 Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See [`config`](/cli/v11/using-npm/config#tag). The config's default value is `latest`.)
121
122 In most cases, this will install the version of the modules tagged as `latest` on the npm registry.
123
124 Example:
125
126 ```bash
127 npm install sax
128 ```
129
130 `npm install` saves any specified packages into `dependencies` by default. Additionally, you can control where and how they get saved with some additional flags:
131 - `-P, --save-prod`: Package will appear in your `dependencies`. This is the default unless `-D` or `-O` are present.
132
133 - `-D, --save-dev`: Package will appear in your `devDependencies`.
134
135 - `--save-peer`: Package will appear in your `peerDependencies`.
136
137 - `-O, --save-optional`: Package will appear in your `optionalDependencies`.
138
139 - `--no-save`: Prevents saving to `dependencies`.
140
141 When using any of the above options to save dependencies to your package.json, there are two additional, optional flags:
142 - `-E, --save-exact`: Saved dependencies will be configured with an exact version rather than using npm's default semver range operator.
143
144 - `-B, --save-bundle`: Saved dependencies will also be added to your `bundleDependencies` list.
145
146 Further, if you have an `npm-shrinkwrap.json` or `package-lock.json` then it will be updated as well.
147
148 `<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/v11/using-npm/scope).
149
150 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.
151
152 Examples:
153
154 ```bash
155 npm install sax
156 npm install githubname/reponame
157 npm install @myorg/privatepackage
158 npm install node-tap --save-dev
159 npm install dtrace-provider --save-optional
160 npm install readable-stream --save-exact
161 npm install ansi-regex --save-bundle
162 ```
163
164 - `npm install <alias>@npm:<name>`:
165
166 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).
167
168 Examples:
169
170 ```bash
171 npm install my-react@npm:react
172 npm install jquery2@npm:jquery@2
173 npm install jquery3@npm:jquery@3
174 npm install npa@npm:npm-package-arg
175 ```
176
177 - `npm install [<@scope>/]<name>@<tag>`:
178
179 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.
180
181 Example:
182
183 ```bash
184 npm install sax@latest
185 npm install @myorg/mypackage@latest
186 ```
187
188 - `npm install [<@scope>/]<name>@<version>`:
189
190 Install the specified version of the package. This will fail if the version has not been published to the registry.
191
192 Example:
193
194 ```bash
195 npm install sax@0.1.1
196 npm install @myorg/privatepackage@1.5.0
197 ```
198
199 - `npm install [<@scope>/]<name>@<version range>`:
200
201 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/v11/configuring-npm/package-json).
202
203 Note that most version ranges must be put in quotes so that your shell will treat it as a single argument.
204
205 Example:
206
207 ```bash
208 npm install sax@">=0.1.0 <0.2.0"
209 npm install @myorg/privatepackage@"16 - 17"
210 ```
211
212 - `npm install <git remote url>`:
213
214 Installs the package from the hosted git provider, cloning it with `git`. For a full git remote url, only that URL will be attempted.
215
216 ```bash
217 <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
218 ```
219
220 `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or `git+file`.
221
222 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.
223
224 If the repository makes use of submodules, those submodules will be cloned as well.
225
226 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.
227
228 The following git environment variables are recognized by npm and will be added to the environment when running git:
229 - `GIT_ASKPASS`
230 - `GIT_EXEC_PATH`
231 - `GIT_PROXY_COMMAND`
232 - `GIT_SSH`
233 - `GIT_SSH_COMMAND`
234 - `GIT_SSL_CAINFO`
235 - `GIT_SSL_NO_VERIFY`
236
237 See the git man page for details.
238
239 Examples:
240
241 ```bash
242 npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
243 npm install git+ssh://git@github.com:npm/cli#pull/273
244 npm install git+ssh://git@github.com:npm/cli#semver:^5.0
245 npm install git+https://isaacs@github.com/npm/cli.git
246 npm install git://github.com/npm/cli.git#v1.0.27
247 GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
248 ```
249
250 - `npm install <githubname>/<githubrepo>[#<commit-ish>]`:
251 - `npm install github:<githubname>/<githubrepo>[#<commit-ish>]`:
252
253 Install the package at `https://github.com/githubname/githubrepo` by attempting to clone it using `git`.
254
255 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.
256
257 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
258
259 Examples:
260
261 ```bash
262 npm install mygithubuser/myproject
263 npm install github:mygithubuser/myproject
264 ```
265
266 - `npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]`:
267
268 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`.
269
270 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
271
272 Example:
273
274 ```bash
275 npm install gist:101a11beef
276 ```
277
278 - `npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]`:
279
280 Install the package at `https://bitbucket.org/bitbucketname/bitbucketrepo` by attempting to clone it using `git`.
281
282 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.
283
284 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
285
286 Example:
287
288 ```bash
289 npm install bitbucket:mybitbucketuser/myproject
290 ```
291
292 - `npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]`:
293
294 Install the package at `https://gitlab.com/gitlabname/gitlabrepo` by attempting to clone it using `git`.
295
296 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.
297
298 As with regular git dependencies, `dependencies` and `devDependencies` will be installed if the package has a `prepare` script before the package is done installing.
299
300 Example:
301
302 ```bash
303 npm install gitlab:mygitlabuser/myproject
304 npm install gitlab:myusr/myproj#semver:^5.0
305 ```
306
307 You may combine multiple arguments and even multiple types of arguments. For example:
308
309 ```bash
310 npm install sax@">=0.1.0 <0.2.0" bench supervisor
311 ```
312
313 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.
314
315 The `--dry-run` argument will report in the usual way what the install would have done without actually installing anything.
316
317 The `--package-lock-only` argument will only update the `package-lock.json`, instead of checking `node_modules` and downloading dependencies.
318
319 The `-f` or `--force` argument will force npm to fetch remote resources even if a local copy exists on disk.
320
321 ```bash
322 npm install sax --force
323 ```
324
325 ### Configuration
326
327 See the [`config`](/cli/v11/using-npm/config) help doc. Many of the configuration params have some effect on installation, since that's most of what npm does.
328
329 These are some of the most common options related to installation.
330
331 #### `save`
332
333 - Default: `true` unless when using `npm update` where it defaults to `false`
334 - Type: Boolean
335
336 Save installed packages to a `package.json` file as dependencies.
337
338 When used with the `npm rm` command, removes the dependency from `package.json`.
339
340 Will also prevent writing to `package-lock.json` if set to `false`.
341
342 #### `save-exact`
343
344 - Default: false
345 - Type: Boolean
346
347 Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.
348
349 #### `global`
350
351 - Default: false
352 - Type: Boolean
353
354 Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v11/configuring-npm/folders) for more on the differences in behavior.
355
356 - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory.
357 - bin files are linked to `{prefix}/bin`
358 - man pages are linked to `{prefix}/share/man`
359
360 #### `install-strategy`
361
362 - Default: "hoisted"
363 - Type: "hoisted", "nested", "shallow", or "linked"
364
365 Sets the strategy for installing packages in node_modules. hoisted (default): Install non-duplicated in top-level, and duplicated as necessary within directory structure. nested: (formerly --legacy-bundling) install in place, no hoisting. shallow (formerly --global-style) only install direct deps at top-level. linked: (experimental) install in node_modules/.store, link in place, unhoisted.
366
367 #### `legacy-bundling`
368
369 - Default: false
370 - Type: Boolean
371 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=nested`
372
373 Instead of hoisting package installs in `node_modules`, install packages in the same manner that they are depended on. This may cause very deep directory structures and duplicate package installs as there is no de-duplicating. Sets `--install-strategy=nested`.
374
375 #### `global-style`
376
377 - Default: false
378 - Type: Boolean
379 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=shallow`
380
381 Only install direct dependencies in the top level `node_modules`, but hoist on deeper dependencies. Sets `--install-strategy=shallow`.
382
383 #### `omit`
384
385 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
386 - Type: "dev", "optional", or "peer" (can be set multiple times)
387
388 Dependency types to omit from the installation tree on disk.
389
390 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.
391
392 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
393
394 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
395
396 #### `include`
397
398 - Default:
399 - Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
400
401 Option that allows for defining which types of dependencies to install.
402
403 This is the inverse of `--omit=<type>`.
404
405 Dependency types specified in `--include` will not be omitted, regardless of the order in which omit/include are specified on the command-line.
406
407 #### `strict-peer-deps`
408
409 - Default: false
410 - Type: Boolean
411
412 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.
413
414 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.
415
416 When such an 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.
417
418 #### `prefer-dedupe`
419
420 - Default: false
421 - Type: Boolean
422
423 Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.
424
425 #### `package-lock`
426
427 - Default: true
428 - Type: Boolean
429
430 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
431
432 #### `package-lock-only`
433
434 - Default: false
435 - Type: Boolean
436
437 If set to true, the current operation will only use the `package-lock.json`, ignoring `node_modules`.
438
439 For `update` this means only the `package-lock.json` will be updated, instead of checking `node_modules` and downloading dependencies.
440
441 For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`.
442
443 #### `foreground-scripts`
444
445 - Default: `false` unless when using `npm pack` or `npm publish` where it defaults to `true`
446 - Type: Boolean
447
448 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.
449
450 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
451
452 #### `ignore-scripts`
453
454 - Default: false
455 - Type: Boolean
456
457 If true, npm does not run scripts specified in package.json files.
458
459 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
460
461 #### `audit`
462
463 - Default: true
464 - Type: Boolean
465
466 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/v11/commands/npm-audit) for details on what is submitted.
467
468 #### `before`
469
470 - Default: null
471 - Type: null or Date
472
473 If passed to `npm install`, will rebuild the npm tree such that only versions that were available **on or before** the given date are installed. If there are no versions available for the current set of dependencies, the command will error.
474
475 If the requested version is a `dist-tag` and the given tag does not pass the `--before` filter, the most recent version less than or equal to that tag will be used. For example, `foo@latest` might install `foo@1.2` even though `latest` is `2.0`.
476
477 #### `bin-links`
478
479 - Default: true
480 - Type: Boolean
481
482 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
483
484 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.
485
486 #### `fund`
487
488 - Default: true
489 - Type: Boolean
490
491 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v11/commands/npm-fund) for details.
492
493 #### `dry-run`
494
495 - Default: false
496 - Type: Boolean
497
498 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`.
499
500 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
501
502 #### `cpu`
503
504 - Default: null
505 - Type: null or String
506
507 Override CPU architecture of native modules to install. Acceptable values are same as `cpu` field of package.json, which comes from `process.arch`.
508
509 #### `os`
510
511 - Default: null
512 - Type: null or String
513
514 Override OS of native modules to install. Acceptable values are same as `os` field of package.json, which comes from `process.platform`.
515
516 #### `libc`
517
518 - Default: null
519 - Type: null or String
520
521 Override libc of native modules to install. Acceptable values are same as `libc` field of package.json
522
523 #### `workspace`
524
525 - Default:
526 - Type: String (can be set multiple times)
527
528 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.
529
530 Valid values for the `workspace` config are either:
531
532 - Workspace names
533 - Path to a workspace directory
534 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
535
536 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.
537
538 This value is not exported to the environment for child processes.
539
540 #### `workspaces`
541
542 - Default: null
543 - Type: null or Boolean
544
545 Set to true to run the command in the context of **all** configured workspaces.
546
547 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
548
549 - 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.
550
551 This value is not exported to the environment for child processes.
552
553 #### `include-workspace-root`
554
555 - Default: false
556 - Type: Boolean
557
558 Include the workspace root when workspaces are enabled for a command.
559
560 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.
561
562 This value is not exported to the environment for child processes.
563
564 #### `install-links`
565
566 - Default: false
567 - Type: Boolean
568
569 When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
570
571 ### Algorithm
572
573 Given a `package{dep}` structure: `A{B,C}, B{C}, C{D}`, the npm install algorithm produces:
574
575 ```bash
576 A
577 +-- B
578 +-- C
579 +-- D
580 ```
581
582 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.
583
584 For `A{B,C}, B{C,D@1}, C{D@2}`, this algorithm produces:
585
586 ```bash
587 A
588 +-- B
589 +-- C
590 `-- D@2
591 +-- D@1
592 ```
593
594 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.
595
596 See [folders](/cli/v11/configuring-npm/folders) for a more detailed description of the specific folder structures that npm creates.
597
598 ### See Also
599
600 - [npm folders](/cli/v11/configuring-npm/folders)
601 - [npm update](/cli/v11/commands/npm-update)
602 - [npm audit](/cli/v11/commands/npm-audit)
603 - [npm fund](/cli/v11/commands/npm-fund)
604 - [npm link](/cli/v11/commands/npm-link)
605 - [npm rebuild](/cli/v11/commands/npm-rebuild)
606 - [npm scripts](/cli/v11/using-npm/scripts)
607 - [npm config](/cli/v11/commands/npm-config)
608 - [npmrc](/cli/v11/configuring-npm/npmrc)
609 - [npm registry](/cli/v11/using-npm/registry)
610 - [npm dist-tag](/cli/v11/commands/npm-dist-tag)
611 - [npm uninstall](/cli/v11/commands/npm-uninstall)
612 - [npm shrinkwrap](/cli/v11/commands/npm-shrinkwrap)
613 - [package.json](/cli/v11/configuring-npm/package-json)
614 - [workspaces](/cli/v11/using-npm/workspaces)