npm-config

管理 npm 配置文件

选择 CLI 版本

概要

npm config set <key>=<value> [<key>=<value> ...]
npm config get [<key> [<key> ...]]
npm config delete <key> [<key> ...]
npm config list [--json]
npm config edit
npm config fix
alias: c

注意:此命令不识别工作区。

描述

npm 从命令行、环境变量、npmrc 文件以及某些情况下,package.json 文件获取其配置设置。

有关 npmrc 文件的更多信息,请参见 npmrc

有关所涉及机制的更详细说明以及可用配置选项的完整列表,请参见 config

npm config 命令可用于更新和编辑用户和全局 npmrc 文件的内容。

子命令

Config 支持以下子命令

set

npm config set key=value [key=value...]
npm set key=value [key=value...]

将每个配置键设置为提供的 value。修改用户配置文件,除非传递了 location

如果省略了 value,则该键将从您的配置文件中完全删除。

注意:为了向后兼容,npm config set key value 作为 npm config set key=value 的别名受支持。

get

npm config get [key ...]
npm get [key ...]

将配置 value(s) 回显到 stdout。

如果提供了多个键,则这些 value 将以键名作为前缀。

如果没有提供任何键,则此命令的行为与 npm config list 相同。

list

npm config list

显示所有配置设置。使用 -l 也显示默认值。使用 --json 以 json 格式显示设置。

delete

npm config delete key [key ...]

从所有配置文件中删除指定的键。

edit

npm config edit

在编辑器中打开配置文件。使用 --global 标志编辑全局配置。

fix

npm config fix

尝试修复无效的配置项。通常,这意味着将身份验证配置(即 _auth_authToken)附加到已配置的 registry

配置

json

  • 默认值:false
  • 类型:布尔值

是否输出 JSON 数据,而不是正常输出。

  • npm pkg set 中,它在将 set 值保存到您的 package.json 之前使用 JSON.parse() 解析它们。

并非所有 npm 命令都支持。

global

  • 默认值:false
  • 类型:布尔值

在“全局”模式下操作,以便将包安装到 prefix 文件夹中,而不是当前工作目录。有关行为差异的更多信息,请参见 folders

  • 包安装到 {prefix}/lib/node_modules 文件夹中,而不是当前工作目录。
  • bin 文件链接到 {prefix}/bin
  • man 页面链接到 {prefix}/share/man

editor

  • 默认值:EDITOR 或 VISUAL 环境变量,或 Windows 上的 '%SYSTEMROOT%\notepad.exe',或 Unix 系统上的 'vi'
  • 类型:字符串

用于 npm editnpm config edit 的命令。

location

  • 默认值:除非传递了 --global,否则为“user”,这也会将此值设置为“global”
  • 类型:“global”、“user”或“project”

当传递给 npm config 时,这指的是要使用的配置文件。

当设置为“全局”模式时,包将安装到 prefix 文件夹中,而不是当前工作目录。有关行为差异的更多信息,请参见 folders

  • 包安装到 {prefix}/lib/node_modules 文件夹中,而不是当前工作目录。
  • bin 文件链接到 {prefix}/bin
  • man 页面链接到 {prefix}/share/man

long

  • 默认值:false
  • 类型:布尔值

lssearchhelp-search 中显示扩展信息。

参见