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 alias: c Note: This command is unaware of workspaces. Description npm gets its config settings from the command line, environment vari- ables, 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(7) for a more thorough explanation of the mecha- nisms 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, then it sets it to an empty string. Note: for backwards compatibility, npm config set key value is sup- ported 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 con- fig 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. 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 pre- fix folder instead of the current working directory. See npm help fold- ers 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 'notepad.exe' on Windows, or 'vim' 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. 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 npm help package.json o npm help npmrc o npm help npm
Please see following description for synopsis
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
alias: c
Note: This command is unaware of workspaces.
Description
npm gets its config settings from the command line, environment vari-
ables, 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(7) for a more thorough explanation of the mecha-
nisms 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, then it sets it to an empty string.
Note: for backwards compatibility, npm config set key value is sup-
ported 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 con-
fig 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.
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 pre-
fix folder instead of the current working directory. See npm help fold-
ers 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 'notepad.exe'
on Windows, or 'vim' 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.
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 npm help package.json
o npm help npmrc
o npm help npm
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | runtime/nodejs/nodejs-18 |
+---------------+--------------------------+
|Stability | Pass-thru volatile |
+---------------+--------------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://github.com/nodejs/node/ar-
chive/v18.1.0.zip.
Further information about this software can be found on the open source
community website at https://github.com/nodejs/node.
April 2022 NPM-CONFIG(1)