npm-install

Install a package

Select CLI Version:

See Details

Table of contents

Synopsis

npminstall[<package-spec>...]
aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall

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:

npm-shrinkwrap.json
package-lock.json
yarn.lock

Seepackage-lock.json andnpm shrinkwrap.

Apackage is:

a) a folder containing a program described by apackage.json file
b) a gzipped tarball containing (a)
c) a url that resolves to (b)
d) a<name>@<version> that is published on the registry (seeregistry) with (c)
e) a<name>@<tag> (seenpm dist-tag) that points to (d)
f) a<name> that has a "latest" tag satisfying (e)
g) a<git remote url> that resolves to (a)

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).

npm install (in a package directory, no arguments):
Install the dependencies to the localnode_modules folder.
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.
By default,npm install will install all modules listed as dependencies inpackage.json.
With the--production flag (or when theNODE_ENV environment variable is set toproduction), npm will not install modules listed indevDependencies. To install all modules listed in bothdependencies anddevDependencies whenNODE_ENV environment variable is set toproduction, you can use--production=false.
NOTE: The--production flag has no particular meaning when adding a dependency to a project.
npm install <folder>:
If<folder> sits inside the root of your project, its dependencies will be installed and may be hoisted to the top-levelnode_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>.
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.
Example:
```
npminstall../../other-package --install-links
npminstall ./sub-package
```
npm install <tarball file>:
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 usingnpm link.
Tarball requirements:
- The filenamemust use.tar,.tar.gz, or.tgz as the extension.
- The package contents should reside in a subfolder inside the tarball (usually it is calledpackage/). npm strips one directory layer when installing the package (an equivalent oftar x --strip-components=1 is run).
- The package must contain apackage.json file withname andversion properties.
Example:
```
npminstall ./package.tgz
```
npm install <tarball url>:
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://"
Example:
```
npminstall https://github.com/indexzero/forever/tarball/v0.5.6
```
npm install [<@scope>/]<name>:
Do a<name>@<tag> install, where<tag> is the "tag" config. (Seeconfig. The config's default value islatest.)
In most cases, this will install the version of the modules tagged aslatest on the npm registry.
Note: When installing by name without specifying a version or tag, npm prioritizes versions that match the current Node.js version based on the package'sengines field. If thelatest tag points to a version incompatible with your current Node.js version, npm will install the newest compatible version instead. To install a specific version regardless ofengines compatibility, explicitly specify the version or tag:npm install <name>@latest.
Example:
```
npminstall sax
```
npm install saves any specified packages intodependencies by default. Additionally, you can control where and how they get saved with some additional flags:
- -P, --save-prod: Package will appear in yourdependencies. This is the default unless-D or-O are present.
- -D, --save-dev: Package will appear in yourdevDependencies.
- --save-peer: Package will appear in yourpeerDependencies.
- -O, --save-optional: Package will appear in youroptionalDependencies.
- --no-save: Prevents saving todependencies.
When using any of the above options to save dependencies to your package.json, there are two additional, optional flags:
- -E, --save-exact: Saved dependencies will be configured with an exact version rather than using npm's default semver range operator.
- -B, --save-bundle: Saved dependencies will also be added to yourbundleDependencies list.
Further, if you have annpm-shrinkwrap.json orpackage-lock.json then it will be updated as well.
<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. Seescope.
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.
Examples:
```
npminstall sax
npminstall githubname/reponame
npminstall @myorg/privatepackage
npminstall node-tap --save-dev
npminstall dtrace-provider --save-optional
npminstall readable-stream --save-exact
npminstall ansi-regex --save-bundle
```
npm install <alias>@npm:<name>:
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 invalidate-npm-package-name.
Examples:
```
npminstall my-react@npm:react
npminstall jquery2@npm:jquery@2
npminstall jquery3@npm:jquery@3
npminstall npa@npm:npm-package-arg
```
npm install [<@scope>/]<name>@<tag>:
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.
Example:
```
npminstall sax@latest
npminstall @myorg/mypackage@latest
```
npm install [<@scope>/]<name>@<version>:
Install the specified version of the package. This will fail if the version has not been published to the registry.
Example:
```
npminstall sax@0.1.1
npminstall @myorg/privatepackage@1.5.0
```
npm install [<@scope>/]<name>@<version range>:
Install a version of the package matching the specified version range. This will follow the same rules for resolving dependencies described inpackage.json.
Note that most version ranges must be put in quotes so that your shell will treat it as a single argument.
Example:
```
npminstall sax@">=0.1.0 <0.2.0"
npminstall @myorg/privatepackage@"16 - 17"
```
Prerelease versions: By default, version ranges only match stable versions. To include prerelease versions, they must be explicitly specified in the range. Prerelease versions are tied to a specific version triple (major.minor.patch). For example,^1.2.3-beta.1 will only match prereleases for1.2.x, not1.3.x. To match all prereleases for a major version, use a range like^1.0.0-0, which will include all1.x.x prereleases.
Example:
```
npminstall package@^1.2.3-beta.1# Matches 1.2.3-beta.1, 1.2.3-beta.2, 1.2.4-beta.1, etc.
npminstall package@^1.0.0-0# Matches all 1.x.x prereleases and stable versions
```
npm install <git remote url>:
Installs the package from the hosted git provider, cloning it withgit. For a full git remote url, only that URL will be attempted.
```
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
```
<protocol> is one ofgit,git+ssh,git+http,git+https, orgit+file.
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.
If the repository makes use of submodules, those submodules will be cloned as well.
If the package being installed contains aprepare script, itsdependencies anddevDependencies will be installed, and the prepare script will be run, before the package is packaged and installed.
The following git environment variables are recognized by npm and will be added to the environment when running git:
- GIT_ASKPASS
- GIT_EXEC_PATH
- GIT_PROXY_COMMAND
- GIT_SSH
- GIT_SSH_COMMAND
- GIT_SSL_CAINFO
- GIT_SSL_NO_VERIFY
See the git man page for details.
Examples:
```
npminstall git+ssh://git@github.com:npm/cli.git#v1.0.27
npminstall git+ssh://git@github.com:npm/cli#pull/273
npminstall git+ssh://git@github.com:npm/cli#semver:^5.0
npminstall git+https://isaacs@github.com/npm/cli.git
npminstall git://github.com/npm/cli.git#v1.0.27
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident'npminstall git+ssh://git@github.com:npm/cli.git
```
npm install <githubname>/<githubrepo>[#<commit-ish>]:
npm install github:<githubname>/<githubrepo>[#<commit-ish>]:
Install the package athttps://github.com/githubname/githubrepo by attempting to clone it usinggit.
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.
As with regular git dependencies,dependencies anddevDependencies will be installed if the package has aprepare script before the package is done installing.
Examples:
```
npminstall mygithubuser/myproject
npminstall github:mygithubuser/myproject
```
npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]:
Install the package athttps://gist.github.com/gistID by attempting to clone it usinggit. The GitHub username associated with the gist is optional and will not be saved inpackage.json.
As with regular git dependencies,dependencies anddevDependencies will be installed if the package has aprepare script before the package is done installing.
Example:
```
npminstall gist:101a11beef
```
npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]:
Install the package athttps://bitbucket.org/bitbucketname/bitbucketrepo by attempting to clone it usinggit.
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, thenmaster is used.
As with regular git dependencies,dependencies anddevDependencies will be installed if the package has aprepare script before the package is done installing.
Example:
```
npminstall bitbucket:mybitbucketuser/myproject
```
npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]:
Install the package athttps://gitlab.com/gitlabname/gitlabrepo by attempting to clone it usinggit.
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, thenmaster is used.
As with regular git dependencies,dependencies anddevDependencies will be installed if the package has aprepare script before the package is done installing.
Example:
```
npminstall gitlab:mygitlabuser/myproject
npminstall gitlab:myusr/myproj#semver:^5.0
```

You may combine multiple arguments and even multiple types of arguments. For example:

npminstall sax@">=0.1.0 <0.2.0" bench supervisor

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.

Note: The--tag option only affects packages specified on the command line. It does not override version ranges specified inpackage.json. For example, ifpackage.json specifies"foo": "^1.0.0" and you runnpm install --tag beta, npm will still install a version matching^1.0.0 even if thebeta tag points to a different version. To install a tagged version, specify the package explicitly:npm install foo@beta.

The--dry-run argument will report in the usual way what the install would have done without actually installing anything.

The--package-lock-only argument will only update thepackage-lock.json, instead of checkingnode_modules and downloading dependencies.

The-f or--force argument will force npm to fetch remote resources even if a local copy exists on disk.

npminstall sax--force

Configuration

See theconfig help doc. Many of the configuration params have some effect on installation, since that's most of what npm does.

These are some of the most common options related to installation.

`save`

Default:true unless when usingnpm update where it defaults tofalse
Type: Boolean

Save installed packages to apackage.json file as dependencies.

When used with thenpm rm command, removes the dependency frompackage.json.

Will also prevent writing topackage-lock.json if set tofalse.

`save-exact`

Default: false
Type: Boolean

Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.

`global`

Default: false
Type: Boolean

Operates in "global" mode, so that packages are installed into theprefix folder instead of the current working directory. Seefolders for more on the differences in behavior.

packages are installed into the{prefix}/lib/node_modules folder, instead of the current working directory.
bin files are linked to{prefix}/bin
man pages are linked to{prefix}/share/man

`install-strategy`

Default: "hoisted"
Type: "hoisted", "nested", "shallow", or "linked"

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.

`legacy-bundling`

Default: false
Type: Boolean
DEPRECATED: This option has been deprecated in favor of--install-strategy=nested

Instead of hoisting package installs innode_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.

`global-style`

Default: false
Type: Boolean
DEPRECATED: This option has been deprecated in favor of--install-strategy=shallow

Only install direct dependencies in the top levelnode_modules, but hoist on deeper dependencies. Sets--install-strategy=shallow.

`omit`

Default: 'dev' if theNODE_ENV environment variable is set to 'production'; otherwise, empty.
Type: "dev", "optional", or "peer" (can be set multiple times)

Dependency types to omit from the installation tree on disk.

Note that these dependenciesare still resolved and added to thepackage-lock.json ornpm-shrinkwrap.json file. They are just not physically installed on disk.

If a package type appears in both the--include and--omit lists, then it will be included.

If the resulting omit list includes'dev', then theNODE_ENV environment variable will be set to'production' for all lifecycle scripts.

`include`

Default:
Type: "prod", "dev", "optional", or "peer" (can be set multiple times)

Option that allows for defining which types of dependencies to install.

This is the inverse of--omit=<type>.

Dependency types specified in--include will not be omitted, regardless of the order in which omit/include are specified on the command-line.

`strict-peer-deps`

Default: false
Type: Boolean

If set totrue, and--legacy-peer-deps is not set, thenany conflictingpeerDependencies will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.

By default, conflictingpeerDependencies 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'speerDependencies object.

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.

`prefer-dedupe`

Default: false
Type: Boolean

Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.

`package-lock`

Default: true
Type: Boolean

If set to false, then ignorepackage-lock.json files when installing. This will also preventwritingpackage-lock.json ifsave is true.

`package-lock-only`

Default: false
Type: Boolean

If set to true, the current operation will only use thepackage-lock.json, ignoringnode_modules.

Forupdate this means only thepackage-lock.json will be updated, instead of checkingnode_modules and downloading dependencies.

Forlist this means the output will be based on the tree described by thepackage-lock.json, rather than the contents ofnode_modules.

`foreground-scripts`

Default:false unless when usingnpm pack ornpm publish where it defaults totrue
Type: Boolean

Run all build scripts (ie,preinstall,install, andpostinstall) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.

Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.

`ignore-scripts`

Default: false
Type: Boolean

If true, npm does not run scripts specified in package.json files.

Note that commands explicitly intended to run a particular script, such asnpm start,npm stop,npm restart,npm test, andnpm run will still run their intended script ifignore-scripts is set, but they willnot run any pre- or post-scripts.

`audit`

Default: true
Type: Boolean

When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation fornpm audit for details on what is submitted.

`before`

Default: null
Type: null or Date

If passed tonpm install, will rebuild the npm tree such that only versions that were availableon or before the given date are installed. If there are no versions available for the current set of dependencies, the command will error.

If the requested version is adist-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 installfoo@1.2 even thoughlatest is2.0.

`bin-links`

Default: true
Type: Boolean

Tells npm to create symlinks (or.cmd shims on Windows) for package executables.

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.

`fund`

Default: true
Type: Boolean

When "true" displays the message at the end of eachnpm install acknowledging the number of dependencies looking for funding. Seenpm fund for details.

`dry-run`

Default: false
Type: Boolean

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 aspack andpublish.

Note: This is NOT honored by other network related commands, egdist-tags,owner, etc.

`cpu`

Default: null
Type: null or String

Override CPU architecture of native modules to install. Acceptable values are same ascpu field of package.json, which comes fromprocess.arch.

`os`

Default: null
Type: null or String

Override OS of native modules to install. Acceptable values are same asos field of package.json, which comes fromprocess.platform.

`libc`

Default: null
Type: null or String

Override libc of native modules to install. Acceptable values are same aslibc field of package.json

`workspace`

Default:
Type: String (can be set multiple times)

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.

Valid values for theworkspace config are either:

Workspace names
Path to a workspace directory
Path to a parent workspace directory (will result in selecting all workspaces within that folder)

When set for thenpm 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.

This value is not exported to the environment for child processes.

`workspaces`

Default: null
Type: null or Boolean

Set to true to run the command in the context ofall configured workspaces.

Explicitly setting this to false will cause commands likeinstall to ignore workspaces altogether. When not set explicitly:

Commands that operate on thenode_modules tree (install, update, etc.) will link workspaces into thenode_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 theworkspace config.

This value is not exported to the environment for child processes.

`include-workspace-root`

Default: false
Type: Boolean

Include the workspace root when workspaces are enabled for a command.

When false, specifying individual workspaces via theworkspace config, or all workspaces via theworkspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.

This value is not exported to the environment for child processes.

`install-links`

Default: false
Type: Boolean

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.

Algorithm

Given apackage{dep} structure:A{B,C}, B{C}, C{D}, the npm install algorithm produces:

A
+-- B
+-- C
+-- D

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.

ForA{B,C}, B{C,D@1}, C{D@2}, this algorithm produces:

A
+-- B
+-- C
   `-- D@2
+-- D@1

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.

Seefolders for a more detailed description of the specific folder structures that npm creates.

Movatterモバイル変換

Site navigation

npm-install

Synopsis

Description

Configuration

`save`

`save-exact`

`global`

`install-strategy`

`legacy-bundling`

`global-style`

`omit`

`include`

`strict-peer-deps`

`prefer-dedupe`

`package-lock`

`package-lock-only`

`foreground-scripts`

`ignore-scripts`

`audit`

`before`

`bin-links`

`fund`

`dry-run`

`cpu`

`os`

`libc`

`workspace`

`workspaces`

`include-workspace-root`

`install-links`

Algorithm

See Also

Table of contents