npm-config(1) npm-config(1)
NAME
npm-config - Manage the npm configuration files
Synopsis
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
Note: This command is unaware of workspaces.
Description
npm gets its config settings from the command line, environment
variables, npmrc files, and in some cases, the package.json file.
See npm help npmrc for more information about the npmrc files.
See npm help config for a more thorough explanation of the mechanisms
involved, and a full list of config options available.
The npm config command can be used to update and edit the contents of
the user and global npmrc files.
Sub-commands
Config supports the following sub-commands:
set
npm config set key=value [key=value...]
npm set key=value [key=value...]
Sets each of the config keys to the value provided.
If value is omitted, the key will be removed from your config file
entirely.
Note: for backwards compatibility, npm config set key value is
supported as an alias for npm config set key=value.
get
npm config get [key ...]
npm get [key ...]
Echo the config value(s) to stdout.
If multiple keys are provided, then the values will be prefixed with
the key names.
If no keys are provided, then this command behaves the same as npm
config list.
list
npm config list
Show all the config settings. Use -l to also show defaults. Use --json
to show the settings in json format.
delete
npm config delete key [key ...]
Deletes the specified keys from all configuration files.
edit
npm config edit
Opens the config file in an editor. Use the --global flag to edit the
global config.
fix
npm config fix
Attempts to repair invalid configuration items. Usually this means
attaching authentication config (i.e. _auth, _authToken) to the
configured registry.
Configuration
json
o Default: false
o Type: Boolean
Whether or not to output JSON data, rather than the normal output.
o In npm pkg set it enables parsing set values with JSON.parse()
before saving them to your package.json.
Not supported by all npm commands.
global
o Default: false
o Type: Boolean
Operates in "global" mode, so that packages are installed into the
prefix folder instead of the current working directory. See npm help
folders for more on the differences in behavior.
o packages are installed into the {prefix}/lib/node_modules folder,
instead of the current working directory.
o bin files are linked to {prefix}/bin
o man pages are linked to {prefix}/share/man
editor
o Default: The EDITOR or VISUAL environment variables, or
'%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems
o Type: String
The command to run for npm edit and npm config edit.
location
o Default: "user" unless --global is passed, which will also set this
value to "global"
o Type: "global", "user", or "project"
When passed to npm config this refers to which config file to use.
When set to "global" mode, packages are installed into the prefix
folder instead of the current working directory. See npm help folders
for more on the differences in behavior.
o packages are installed into the {prefix}/lib/node_modules folder,
instead of the current working directory.
o bin files are linked to {prefix}/bin
o man pages are linked to {prefix}/share/man
long
o Default: false
o Type: Boolean
Show extended information in ls, search, and help-search.
See Also
o npm help folders
o npm help config
o package.json </configuring-npm/package-json>
o npm help npmrc
o npm help npm
June 2023 npm-config(1)
npm 9.7.1 - Generated Sun Jun 11 15:29:33 CDT 2023