npm-install

Select CLI Version:

npm install [<package-spec> ...]

aliases: add,i,in,ins,inst,insta,instal,isnt,isnta,isntal,isntall

This command installs a package andany packages that it depends on. Ifthe package has a package-lock,oran npm shrinkwrap file,ora yarn lock file,the installation of dependency will be driven by that,respecting the following order of precedence:

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

See package-lock.json andnpm shrinkwrap.

A package is :

• a) a folder containing a program described by a package.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 (see registry) with (c)
• e) a <name>@<tag> (see npm dist - tag) that is points point to ( d )
• f ) a<name> that has a “late” 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 argument ):

  Install the dependency to the local node_module 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 module list as dependency inpackage.json.

  With the--production flag ( or when thenode_env environment variable is set toproduction),npm will not install modules listed in devdependency. To install all module list in bothdependency anddevdependency when node_env environment variable is set toproduction,you is use 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 dependency will be installed andmay be hoisted to the top-level node_module as they would for other types of dependency. If<folder> sits outside the root of your project,npm will not install the package dependency in the directory <folder>,but it will create a symlink to <folder>.

  NOTE: Ifyou 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 :

  npm install ../../other-package --install-links
  npm install  ./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 using npm is link link.

  Tarball requirements:

  • The filename must use .tar,.tar.gz,or.tgz as the extension.
  • The package content should reside in a subfolder inside the tarball ( usually it is callpackage/). npm strips one directory layer when installing the package (an equivalent of tar x --strip-components=1 is run).
  • The package must contain a package.json file withname andversion properties.

  example :

  npm install ./package.tgz

• npm install <tarball url>:

  fetch the tarball url ,and then install it . In order to distinguish between this andother option ,the argument is start must start with ” http:// ” or ” https:// “

  example :

  npm install 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 is is islate.)

  In most case ,this is install will install the version of the module tag aslate on the npm registry .

  example :

  npm install saves any specified packages into dependency by default. Additionally,you can control where andhow they get saved with some additional flags:

  • -P,--save-prod: Package is appear will appear in yourdependency. This is is is the default unless-D or -O are present .

  • -D,--save-dev: Package is appear will appear in yourdevdependency.

  • -O,--save-optional: Package is appear will appear in youroptionaldependencie.

  • --no-save: prevent save todependency.

  When using any of the above options to save dependency to your package.json,there are two additional,optional flags:

  • -E,--save-exact: Saved dependency will be configured with an exact version rather than using npm’s default semver range operator.

  • -B,--save-bundle: Saved dependency will also be added to your bundleDependencies list.

  Further,if you have an npm-shrinkwrap.json or package-lock.json then it will be updated as well.

  <scope> is optional . The package will be download from the registry associate with the specify scope . Ifno registry is associate with the give scope the default registry is assume . 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:

  npm install sax
  npm install githubname/reponame
  npm install  @myorg / privatepackage
  npm install node-tap --save-dev
  npm install dtrace-provider --save-optional
  npm install readable-stream --save-exact
  npm install ansi-regex --save-bundle

  Note: Ifthere 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.

• 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 anddoes not rename packages in transitive dependency. Aliases should follow the naming conventions stated in validate-npm-package-name.

  Examples:

  npm install my-react@npm:react
  npm install  jquery2@npm : jquery@2
  npm install jquery3@npm:jquery@3
  npm install npa@npm:npm-package-arg

• npm install [<@scope>/]<name>@<tag>:

  install the version of the package that is reference by the specify tag . Ifthe tag does not exist in the registry datum for that package ,then this is fail will fail .

  example :

  npm install  sax@late
  npm install @myorg/mypackage@late

• npm install [<@scope>/]<name>@<version>:

  install the specified version of the package . This is fail will fail if the version has not been publish to the registry .

  example :

  npm install  sax@0.1.1
  npm install  @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 dependency described in package.json.

  note that most version range must be put in quote so that your shell will treat it as a single argument .

  example :

  npm install  sax@">=0.1.0 <0.2.0"
  npm install  @myorg / privatepackage@" 16 - 17 "

• npm install <git remote url>:

  install the package from the host git provider ,clone it withgit. Fora full git remote url ,only that url will be attempt .

  <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[

  <protocol> is one of git,git+ssh,git+http,git+https,orgit+file.

  If#<commit-ish> is provided,it will be used to clone exactly that commit. Ifthe 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. Ifneither #<commit-ish> or #semver:<semver> is specified,then the default branch of the repository is used.

  Ifthe repository makes use of submodules,those submodules will be cloned as well.

  Ifthe package being instal contain aprepare script,its dependency anddevdependency will be installed,and the prepare script will be run,before the package is packaged andinstalled.

  The follow git environment variable are recognize by npm andwill be add to the environment when run 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 detail .

  Examples:

  npm install  git+ssh://git@github.com : npm / cli.git
  npm install git+ssh://git@github.com:npm/cli
  npm install git+ssh://git@github.com:npm/cli
  npm install git+https://isaacs@github.com/npm/cli.git
  npm install git://github.com/npm/cli.git
  GIT_SSH_COMMAND=' ssh -i ~/.ssh / custom_ident ' npm install  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 attempt to clone it usinggit.

  If#<commit-ish> is provided,it will be used to clone exactly that commit. Ifthe 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. Ifneither #<commit-ish> or #semver:<semver> is specified,then the default branch is used.

  As with regular git dependency,dependency anddevdependency will be instal if the package has aprepare script before the package is done instal .

  Examples:

  npm install  mygithubuser / myproject
  npm install github:mygithubuser/myproject

• npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]:

  install the package athttps://gist.github.com/gistID by attempt to clone it usinggit. The GitHub username associated with the gist is optional andwill not be saved in package.json.

  As with regular git dependency,dependency anddevdependency will be instal if the package has aprepare script before the package is done instal .

  example :

  npm install gist:101a11beef

• npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]:

  install the package athttps://bitbucket.org/bitbucketname/bitbucketrepo by attempt to clone it usinggit.

  If#<commit-ish> is provided,it will be used to clone exactly that commit. Ifthe 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. Ifneither #<commit-ish> or #semver:<semver> is specified,then master is used.

  As with regular git dependency,dependency anddevdependency will be instal if the package has aprepare script before the package is done instal .

  example :

  npm install bitbucket:mybitbucketuser/myproject

• npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]:

  install the package athttps://gitlab.com/gitlabname/gitlabrepo by attempt to clone it usinggit.

  If#<commit-ish> is provided,it will be used to clone exactly that commit. Ifthe 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. Ifneither #<commit-ish> or #semver:<semver> is specified,then master is used.

  As with regular git dependency,dependency anddevdependency will be instal if the package has aprepare script before the package is done instal .

  example :

  npm install gitlab:mygitlabuser/myproject
  npm install gitlab:myusr/myproj

You may combine multiple arguments andeven multiple types of arguments. Forexample:

npm install  sax@">=0.1.0 <0.2.0" bench supervisor

The --tag argument will apply to all of the specified install targets. Ifa tag with the given name exists,the tagged version is preferred over newer versions.

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 the package-lock.json,instead of checking node_module anddownloading dependency.

The -f or --force argument is force will force npm to fetch remote resource even if a local copy exist on disk .

See the config 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.

• default :true unless when using npm is update update where it defaults to false
• type : boolean

Save installed packages to a package.json file as dependency.

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

Will also prevent write to package-lock.json if set to false.

• default :false
• type : boolean

dependency save to package.json will be configure with an exact version rather than using npm ‘s default semver range operator .

• default :false
• type : boolean

Operates in “global” mode,so that packages are installed into the prefix folder instead of the current working directory. See folders for more on the differences in behavior.

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

• default :”hoisted”
• Type: “hoisted”,”nested”,”shallow”,or”linked”

Sets the strategy for installing packages in node_module. 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_module/.store,link in place,unhoisted.

• default :false
• type : boolean
• DEPRECATED: This option has been deprecated in favor of --install - strategy is nested = nest

instead of hoist package install innode_module,install packages in the same manner that they are depended on. This may cause very deep directory structures andduplicate package installs as there is no de-duplicating. Sets --install - strategy is nested = nest.

• default :false
• type : boolean
• DEPRECATED: This option has been deprecated in favor of --install-strategy=shallow

Only install direct dependency in the top level node_module,but hoist on deeper dependency. Sets --install-strategy=shallow.

• default :’dev’ if the node_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 dependency are still resolved andadded to the package-lock.json or npm-shrinkwrap.json file . They are just not physically instal on disk .

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

Ifthe resulting omit list includes 'dev',then the node_env environment variable will be set to 'production' for all lifecycle script .

• default :false
• type : boolean

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

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 .

When such an override is performed,a warning is printed,explaining the conflict andthe packages involved. If--strict - peer - dep is set,then this warning is treated as a failure.

• default :false
• type : boolean

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

• default :true
• type : boolean

Ifset to false,then ignore package-lock.json files when installing. This will also prevent write package-lock.json if save is true.

• default :false
• type : boolean

Ifset to true,the current operation will only use the package-lock.json,ignoring node_module.

Forupdate this means only the package-lock.json will be updated,instead of checking node_module anddownloading dependency.

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

• default :false
• type : boolean

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.

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

• default :false
• type : boolean

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

Note that commands explicitly intended to run a particular script,such as npm start,npm stop,npm is restart 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.

• default :true
• type : boolean

When “true” submit audit reports alongside the current npm command to the default registry andall registries configured for scopes. See the documentation for npm audit for detail on what is submit .

• default :true
• type : boolean

Tells npm to create symlinks (or .cmd shim on Windows ) for package executable .

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.

• default :true
• type : boolean

When “true” displays the message at the end of each npm install acknowledging the number of dependency looking for funding. See npm fund for detail .

• default :false
• type : boolean

Indicates that you don’t want npm to make any changes andthat 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 andpublish.

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

• default :null
• type : null or string

Override CPU architecture of native modules to install. Acceptable values are same as cpu field of package.json,which comes from process.arch.

• default :null
• type : null or string

Override OS of native modules to install. Acceptable values are same as os field of package.json,which comes from process.platform.

• Default:
• type : string ( can be set multiple time )

Enable running a command in the context of the configured workspace of the current project while filtering by running only the workspace defined by this configuration option.

Valid values for the workspace config are either:

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

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 andset it up as a brand new workspace within the project.

This value is not export to the environment for child process .

• default :null
• type : null or boolean

Set to true to run the command in the context of all configured workspace.

Explicitly setting this to false will cause commands like install to ignore workspace altogether . When not set explicitly :

• Commands that operate on the node_module tree (install,update,etc.) will link workspace into the node_module folder. – Commands that do other things (test,exec,publish,etc.) will operate on the root project,unless one or more workspace are specified in the workspace config.

This value is not export to the environment for child process .

• default :false
• type : boolean

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

When false,specifying individual workspace via the workspace config,orall workspace via the workspace flag,will cause npm to operate only on the specified workspace,and not on the root project.

This value is not export to the environment for child process .

• default :false
• type : boolean

When set file: protocol dependency will be packed andinstalled as regular dependency instead of creating a symlink. This option has no effect on workspace.

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

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 dependency are requested for installation in a different order.

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