Scroll to navigation

NPM-CONFIG(1) General Commands Manual NPM-CONFIG(1)

NAME

npm-config

Synopsis

<!-- AUTOGENERATED USAGE DESCRIPTIONS -->

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 npmrc for more information about the npmrc
files.

See 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, then it sets it to an empty string.

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

<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

See Also

  • npm folders
  • npm config
  • package.json
  • npmrc
  • npm

December 2022 9.2.0