描述

此命令安装一个包和它所依赖的任何包。如果包有一个包锁，或者一个 npm 收缩包装文件，或者一个纱线锁文件，依赖项的安装将由它驱动，遵循以下优先顺序：

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

见 package-lock.json 和 npm shrinkwrap。

一个package是：

• a) 包含由 package.json 文件描述的程序的文件夹
• b) 一个 gzipped tarball，包含 (a)
• c) 解析为 (b) 的 url
• d) 在注册表上发布的 <name>@<version>（参见 registry），带有 (c)
• e) 指向 (d) 的 <name>@<tag>（见 npm dist-tag）
• f) 具有满足 (e) 的 "latest" 标签的 <name>
• g) 解决为 (a) 的 <git remote url>

即使你从不发布你的包，如果你只是想写一个 node 程序（a），你仍然可以获得使用 npm 的很多好处，也许你还想在打包后能够轻松地安装它成一个 tarball (b)。

• npm install（在包目录中，无参数）：

  将依赖项安装到本地 node_modules 文件夹。

  在全局模式下（即，将 -g 或 --global 附加到命令中），它将当前包上下文（即当前工作目录）安装为全局包。

  默认情况下，npm install 将安装 package.json 中列为依赖项的所有模块。

  使用 --production 标志（或者当 NODE_ENV 环境变量设置为 production 时），npm 将不会安装 devDependencies 中列出的模块。当 NODE_ENV 环境变量设置为 production 时，要安装 dependencies 和 devDependencies 中列出的所有模块，您可以使用 --production=false。

  注意：向项目添加依赖项时，--production 标志没有特殊含义。

• npm install <folder>：

  如果 <folder> 位于项目的根目录中，它的依赖项将被安装，并且可能会像其他类型的依赖项一样被提升到顶级 node_modules。如果 <folder> 位于项目的根目录之外，npm 将不会在 <folder> 目录中安装包依赖项，但它会创建指向 <folder> 的符号链接。

  注意：如果您想从注册表安装目录的内容（如包）而不是创建链接，则需要使用 --install-links 选项。

  例子：

  npm install ../../other-package --install-links
  npm install ./sub-package
  

• npm install <tarball file>：

  安装位于文件系统上的软件包。注意：如果您只想将 dev 目录链接到您的 npm 根目录，您可以使用 npm link 更轻松地做到这一点。

  压缩包要求： * 文件名 必须 使用 .tar、.tar.gz 或 .tgz 作为扩展名。* 包内容应位于 tarball 内的子文件夹中（通常称为 package/）。npm 在安装包时剥离一个目录层（运行 tar x --strip-components=1 的等效项）。* 包必须包含具有 name 和 version 属性的 package.json 文件。

  例子：

  npm install ./package.tgz
  

• npm install <tarball url>：

  获取 tarball url，然后安装它。为了区分此选项和其他选项，参数必须以 "http://" 或 "https://" 开头

  例子：

  npm install https://github.com/indexzero/forever/tarball/v0.5.6
  

• npm install [<@scope>/]<name>：

  进行 <name>@<tag> 安装，其中 <tag> 是 "tag" 配置。（见 config。配置的默认值为 latest。）

  在大多数情况下，这将在 npm 注册表上安装标记为 latest 的模块版本。

  例子：

  npm install sax
  

  默认情况下，npm install 将任何指定的包保存到 dependencies 中。此外，您可以使用一些额外的标志来控制它们的保存位置和方式：

  • -P, --save-prod：包裹会出现在你的dependencies中。这是默认值，除非存在 -D 或 -O。

  • -D, --save-dev：包裹会出现在你的devDependencies中。

  • -O, --save-optional：包裹会出现在你的optionalDependencies中。

  • --no-save：防止保存到 dependencies。

  当使用上述任何选项将依赖项保存到 package.json 时，还有两个额外的可选标志：

  • -E, --save-exact：保存的依赖项将使用精确的版本配置，而不是使用 npm 的默认 semver 范围运算符。

  • -B, --save-bundle：已保存的依赖项也将添加到您的 bundleDependencies 列表中。

  此外，如果您有 npm-shrinkwrap.json 或 package-lock.json，那么它也会被更新。

  <scope> 是可选的。该包将从与指定范围关联的注册表中下载。如果没有注册表与给定范围关联，则假定为默认注册表。见 scope。

  注意：如果你的范围名称中没有包含 @-symbol，npm 会将其解释为 GitHub 存储库，见下文。范围名称后还必须跟一个斜杠。

  例子：

  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
  

  注意：如果当前工作目录中有一个名为 <name> 的文件或文件夹，那么它会尝试安装它，如果它无效，则只尝试按名称获取包。

• npm install <alias>@npm:<name>：

  在自定义别名下安装包。允许并排同名包的多个版本，更方便地导入具有其他长包的名称，并使用 git forks 替换或分叉的 npm 包作为替换。别名仅适用于您的项目，不会重命名传递依赖项中的包。别名应遵循 validate-npm-package-name 中规定的命名约定。

  例子：

  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>：

  安装指定标签引用的包的版本。如果该包的注册表数据中不存在该标记，则此操作将失败。

  例子：

  npm install sax@latest
  npm install @myorg/mypackage@latest
  

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

  安装指定版本的包。如果版本尚未发布到注册表，这将失败。

  例子：

  npm install sax@0.1.1
  npm install @myorg/privatepackage@1.5.0
  

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

  安装与指定版本范围匹配的软件包版本。这将遵循 package.json 中描述的解决依赖关系的相同规则。

  请注意，大多数版本范围必须放在引号中，以便您的 shell 将其视为单个参数。

  例子：

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

• npm install <git remote url>：

  从托管的 git 提供程序安装包，并使用 git 克隆它。对于完整的 git 远程 URL，只会尝试该 URL。

  <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
  

  <protocol> 是 git、git+ssh、git+http、git+https 或 git+file 之一。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖项一样。如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用存储库的默认分支。

  如果存储库使用子模块，这些子模块也将被克隆。

  如果正在安装的包中包含 prepare 脚本，则会安装它的 dependencies 和 devDependencies，并在打包和安装包之前运行准备脚本。

  以下 git 环境变量被 npm 识别，并在运行 git 时添加到环境中：

  • GIT_ASKPASS
  • GIT_EXEC_PATH
  • GIT_PROXY_COMMAND
  • GIT_SSH
  • GIT_SSH_COMMAND
  • GIT_SSL_CAINFO
  • GIT_SSL_NO_VERIFY

  有关详细信息，请参阅 git 手册页。

  例子：

  npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
  npm install git+ssh://git@github.com:npm/cli#pull/273
  npm install git+ssh://git@github.com:npm/cli#semver:^5.0
  npm install git+https://isaacs@github.com/npm/cli.git
  npm install git://github.com/npm/cli.git#v1.0.27
  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>]：

  通过尝试使用 git 克隆它，在 https://github.com/githubname/githubrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖项一样。如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用默认分支。

  与常规 git 依赖项一样，如果包在安装完成之前有 prepare 脚本，则将安装 dependencies 和 devDependencies。

  例子：

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

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

  通过尝试使用 git 克隆它，在 https://gist.github.com/gistID 安装包。与 gist 关联的 GitHub 用户名是可选的，不会保存在 package.json 中。

  与常规 git 依赖项一样，如果包在安装完成之前有 prepare 脚本，则将安装 dependencies 和 devDependencies。

  例子：

  npm install gist:101a11beef
  

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

  通过尝试使用 git 克隆它，在 https://bitbucket.org/bitbucketname/bitbucketrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖项一样。如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用 master。

  与常规 git 依赖项一样，如果包在安装完成之前有 prepare 脚本，则将安装 dependencies 和 devDependencies。

  例子：

  npm install bitbucket:mybitbucketuser/myproject
  

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

  通过尝试使用 git 克隆它，在 https://gitlab.com/gitlabname/gitlabrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖项一样。如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用 master。

  与常规 git 依赖项一样，如果包在安装完成之前有 prepare 脚本，则将安装 dependencies 和 devDependencies。

  例子：

  npm install gitlab:mygitlabuser/myproject
  npm install gitlab:myusr/myproj#semver:^5.0
  

您可以组合多个参数，甚至多种类型的参数。例如：

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

--tag 参数将适用于所有指定的安装目标。如果存在具有给定名称的标记，则标记的版本优先于较新的版本。

--dry-run 参数将以通常的方式报告在没有实际安装任何东西的情况下安装会完成的工作。

--package-lock-only 参数只会更新 package-lock.json，而不是检查 node_modules 和下载依赖项。

-f 或 --force 参数将强制 npm 获取远程资源，即使磁盘上存在本地副本。

npm install sax --force