Command Line Flags¶

Putting --foo bar on the command line sets the foo configuration parameter to "bar". A -- argument tells the cli parser to stop reading flags. Using --flag without specifying any value will set the value to true.

Example: --flag1 --flag2 will set both configuration parameters to true, while --flag1 --flag2 bar will set flag1 to true, and flag2 to bar. Finally, --flag1 --flag2 -- bar will set both configuration parameters to true, and the bar is taken as a command argument.

Environment Variables¶

Any environment variables that start with npm_config_ will be interpreted as a configuration parameter. For example, putting npm_config_foo=bar in your environment will set the foo configuration parameter to bar. Any environment configurations that are not given a value will be given the value of true. Config values are case-insensitive, so NPM_CONFIG_FOO=bar will work the same. However, please note that inside npm-scripts /misc/scripts npm will set its own environment variables and Node will prefer those lowercase versions over any uppercase ones that you might set. For details see this issue https://github.com/npm/npm/issues/14528.

Notice that you need to use underscores instead of dashes, so --allow-same-version would become npm_config_allow_same_version=true.

npmrc Files¶

The four relevant files are:

See npm help 5 npmrc for more details.

Default Configs¶

Run npm config ls -l to see a set of configuration parameters that are internal to npm, and are defaults if nothing else is specified.

access¶

When publishing scoped packages, the access level defaults to restricted. If you want your scoped package to be publicly viewable (and installable) set --access=public. The only valid values for access are public and restricted. Unscoped packages always have an access level of public.

allow-same-version¶

Prevents throwing an error when npm version is used to set the new version to the same value as the current version.

always-auth¶

Force npm to always require authentication when accessing the registry, even for GET requests.

also¶

When "dev" or "development" and running local npm shrinkwrap, npm outdated, or npm update, is an alias for --dev.

auth-type¶

What authentication strategy to use with adduser/login.

bin-links¶

Tells npm to create symlinks (or .cmd shims on Windows) for package executables.

Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.

browser¶

The browser that is called by the npm docs command to open websites.

ca¶

The Certificate Authority signing certificate that is trusted for SSL connections to the registry. Values should be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string "\n". For example:

ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

Set to null to only allow "known" registrars, or to a specific CA cert to trust only that specific signing authority.

Multiple CAs can be trusted by specifying an array of certificates:

ca[]="..."
ca[]="..."

See also the strict-ssl config.

cafile¶

A path to a file containing one or multiple Certificate Authority signing certificates. Similar to the ca setting, but allows for multiple CA's, as well as for the CA information to be stored in a file on disk.

cache¶

The location of npm's cache directory. See npm help npm-cache

cache-lock-stale¶

The number of ms before cache folder lockfiles are considered stale.

cache-lock-retries¶

Number of times to retry to acquire a lock on cache folder lockfiles.

cache-lock-wait¶

Number of ms to wait for cache lock files to expire.

cache-max¶

DEPRECATED: This option has been deprecated in favor of --prefer-online.

--cache-max=0 is an alias for --prefer-online.

cache-min¶

DEPRECATED: This option has been deprecated in favor of --prefer-offline.

--cache-min=9999 (or bigger) is an alias for --prefer-offline.

cert¶

A client certificate to pass when accessing the registry. Values should be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string "\n". For example:

cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"

It is not the path to a certificate file (and there is no "certfile" option).

cidr¶

This is a list of CIDR address to be used when configuring limited access tokens with the npm token create command.

color¶

If false, never shows colors. If "always" then always shows colors. If true, then only prints color codes for tty file descriptors.

This option can also be changed using the environment: colors are disabled when the environment variable NO_COLOR is set to any value.

depth¶

The depth to go when recursing directories for npm ls, npm cache ls, and npm outdated.

For npm outdated, a setting of Infinity will be treated as 0 since that gives more useful information. To show the outdated status of all packages and dependents, use a large integer value, e.g., npm outdated --depth 9999

description¶

Show the description in npm search

dev¶

Install dev-dependencies along with packages.

dry-run¶

Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, install, update, dedupe, uninstall. This is NOT currently honored by network related commands, eg dist-tags, owner, publish, etc.

editor¶

The command to run for npm edit or npm config edit.

engine-strict¶

If set to true, then npm will stubbornly refuse to install (or even consider installing) any package that claims to not be compatible with the current Node.js version.

force¶

Makes various commands more forceful.

fetch-retries¶

The "retries" config for the retry module to use when fetching packages from the registry.

fetch-retry-factor¶

The "factor" config for the retry module to use when fetching packages.

fetch-retry-mintimeout¶

The "minTimeout" config for the retry module to use when fetching packages.

fetch-retry-maxtimeout¶

The "maxTimeout" config for the retry module to use when fetching packages.

git¶

The command to use for git commands. If git is installed on the computer, but is not in the PATH, then set this to the full path to the git binary.

git-tag-version¶

Tag the commit when using the npm version command.

commit-hooks¶

Run git commit hooks when using the npm version command.

global¶

Operates in "global" mode, so that packages are installed into the prefix folder instead of the current working directory. See npm help 5 npm-folders for more on the differences in behavior.

globalconfig¶

The config file to read for global config options.

global-style¶

Causes npm to install the package into your local node_modules folder with the same layout it uses with the global node_modules folder. Only your direct dependencies will show in node_modules and everything they depend on will be flattened in their node_modules folders. This obviously will eliminate some deduping. If used with legacy-bundling, legacy-bundling will be preferred.

group¶

The group to use when running package scripts in global mode as the root user.

heading¶

The string that starts all the debugging log output.

https-proxy¶

A proxy to use for outgoing https requests. If the HTTPS_PROXY or https_proxy or HTTP_PROXY or http_proxy environment variables are set, proxy settings will be honored by the underlying request library.

if-present¶

If true, npm will not exit with an error code when run-script is invoked for a script that isn't defined in the scripts section of package.json. This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup.

ignore-prepublish¶

If true, npm will not run prepublish scripts.

ignore-scripts¶

If true, npm does not run scripts specified in package.json files.

init-module¶

A module that will be loaded by the npm init command. See the documentation for the init-package-json https://github.com/isaacs/init-package-json module for more information, or npm help init.

init-author-name¶

The value npm init should use by default for the package author's name.

init-author-email¶

The value npm init should use by default for the package author's email.

init-author-url¶

The value npm init should use by default for the package author's homepage.

init-license¶

The value npm init should use by default for the package license.

init-version¶

The value that npm init should use by default for the package version number, if not already set in package.json.

json¶

Whether or not to output JSON data, rather than the normal output.

This feature is currently experimental, and the output data structures for many commands is either not implemented in JSON yet, or subject to change. Only the output from npm ls --json and npm search --json are currently valid.

key¶

A client key to pass when accessing the registry. Values should be in PEM format with newlines replaced by the string "\n". For example:

key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"

It is not the path to a key file (and there is no "keyfile" option).

legacy-bundling¶

Causes npm to install the package such that versions of npm prior to 1.4, such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with global-style this option will be preferred.

link¶

If true, then local installs will link if there is a suitable globally installed package.

Note that this means that local installs can cause things to be installed into the global space at the same time. The link is only done if one of the two conditions are met:

local-address¶

The IP address of the local interface to use when making connections to the npm registry. Must be IPv4 in versions of Node prior to 0.12.

loglevel¶

What level of logs to report. On failure, all logs are written to npm-debug.log in the current working directory.

Any logs of a higher level than the setting are shown. The default is "notice".

logstream¶

This is the stream that is passed to the npmlog https://github.com/npm/npmlog module at run time.

It cannot be set from the command line, but if you are using npm programmatically, you may wish to send logs to somewhere other than stderr.

If the color config is set to true, then this stream will receive colored output if it is a TTY.

logs-max¶

The maximum number of log files to store.

long¶

Show extended information in npm ls and npm search.

maxsockets¶

The maximum number of connections to use per origin (protocol/host/port combination). Passed to the http Agent used to make the request.

message¶

Commit message which is used by npm version when creating version commit.

Any "%s" in the message will be replaced with the version number.

metrics-registry¶

The registry you want to send cli metrics to if send-metrics is true.

node-options¶

Options to pass through to Node.js via the NODE_OPTIONS environment variable. This does not impact how npm itself is executed but it does impact how lifecycle scripts are called.

node-version¶

The node version to use when checking a package's engines map.

no-proxy¶

A comma-separated string or an array of domain extensions that a proxy should not be used for.

offline¶

Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see --prefer-offline.

onload-script¶

A node module to require() when npm loads. Useful for programmatic usage.

only¶

When "dev" or "development" and running local npm install without any arguments, only devDependencies (and their dependencies) are installed.

When "dev" or "development" and running local npm ls, npm outdated, or npm update, is an alias for --dev.

When "prod" or "production" and running local npm install without any arguments, only non-devDependencies (and their dependencies) are installed.

When "prod" or "production" and running local npm ls, npm outdated, or npm update, is an alias for --production.

optional¶

Attempt to install packages in the optionalDependencies object. Note that if these packages fail to install, the overall installation process is not aborted.

otp¶

This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with npm access.

package-lock¶

If set to false, then ignore package-lock.json files when installing. This will also prevent writing package-lock.json if save is true.

When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use npm prune.

This option is an alias for --shrinkwrap.

package-lock-only¶

If set to true, it will update only the package-lock.json, instead of checking node_modules and downloading dependencies.

parseable¶

Output parseable results from commands that write to standard output. For npm search, this will be tab-separated table format.

prefer-offline¶

If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server. To force full offline mode, use --offline.

This option is effectively equivalent to --cache-min=9999999.

prefer-online¶

If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data.

prefix¶

The location to install global items. If set on the command line, then it forces non-global commands to run in the specified folder.

production¶

Set to true to run in "production" mode.

progress¶

When set to true, npm will display a progress bar during time intensive operations, if process.stderr is a TTY.

Set to false to suppress the progress bar.

proxy¶

A proxy to use for outgoing http requests. If the HTTP_PROXY or http_proxy environment variables are set, proxy settings will be honored by the underlying request library.

read-only¶

This is used to mark a token as unable to publish when configuring limited access tokens with the npm token create command.

rebuild-bundle¶

Rebuild bundled dependencies after installation.

registry¶

The base URL of the npm package registry.

rollback¶

Remove failed installs.

save¶

Save installed packages to a package.json file as dependencies.

When used with the npm rm command, it removes it from the dependencies object.

Only works if there is already a package.json file present.

save-bundle¶

If a package would be saved at install time by the use of --save, --save-dev, or --save-optional, then also put it in the bundleDependencies list.

When used with the npm rm command, it removes it from the bundledDependencies list.

save-prod¶

Makes sure that a package will be saved into dependencies specifically. This is useful if a package already exists in devDependencies or optionalDependencies, but you want to move it to be a production dep. This is also the default behavior if --save is true, and neither --save-dev or --save-optional are true.

save-dev¶

Save installed packages to a package.json file as devDependencies.

When used with the npm rm command, it removes it from the devDependencies object.

Only works if there is already a package.json file present.

save-exact¶

Dependencies saved to package.json using --save, --save-dev or --save-optional will be configured with an exact version rather than using npm's default semver range operator.

save-optional¶

Save installed packages to a package.json file as optionalDependencies.

When used with the npm rm command, it removes it from the devDependencies object.

Only works if there is already a package.json file present.

save-prefix¶

Configure how versions of packages installed to a package.json file via --save or --save-dev get prefixed.

For example if a package has version 1.2.3, by default its version is set to ^1.2.3 which allows minor upgrades for that package, but after npm config set save-prefix='~' it would be set to ~1.2.3 which only allows patch upgrades.

scope¶

Associate an operation with a scope for a scoped registry. Useful when logging in to a private registry for the first time: npm login --scope=@organization --registry=registry.organization.com, which will cause @organization to be mapped to the registry for future installation of packages specified according to the pattern @organization/package.

script-shell¶

The shell to use for scripts run with the npm run command.

scripts-prepend-node-path¶

If set to true, add the directory in which the current node executable resides to the PATH environment variable when running scripts, even if that means that npm will invoke a different node executable than the one which it is running.

If set to false, never modify PATH with that.

If set to "warn-only", never modify PATH but print a warning if npm thinks that you may want to run it with true, e.g. because the node executable in the PATH is not the one npm was invoked with.

If set to auto, only add that directory to the PATH environment variable if the node executable with which npm was invoked and the one that is found first on the PATH are different.

searchexclude¶

Space-separated options that limit the results from search.

searchopts¶

Space-separated options that are always passed to search.

searchlimit¶

Number of items to limit search results to. Will not apply at all to legacy searches.

searchstaleness¶

The age of the cache, in seconds, before another registry request is made if using legacy search endpoint.

send-metrics¶

If true, success/failure metrics will be reported to the registry stored in metrics-registry. These requests contain the number of successful and failing runs of the npm CLI and the time period overwhich those counts were gathered. No identifying information is included in these requests.

shell¶

The shell to run for the npm explore command.

shrinkwrap¶

If set to false, then ignore npm-shrinkwrap.json files when installing. This will also prevent writing npm-shrinkwrap.json if save is true.

This option is an alias for --package-lock.

sign-git-tag¶

If set to true, then the npm version command will tag the version using -s to add a signature.

Note that git requires you to have set up GPG keys in your git configs for this to work properly.

sso-poll-frequency¶

When used with SSO-enabled auth-types, configures how regularly the registry should be polled while the user is completing authentication.

sso-type¶

If --auth-type=sso, the type of SSO type to use.

strict-ssl¶

Whether or not to do SSL key validation when making requests to the registry via https.

See also the ca config.

tag¶

If you ask npm to install a package and don't tell it a specific version, then it will install the specified tag.

Also the tag that is added to the package@version specified by the npm tag command, if no explicit tag is given.

tag-version-prefix¶

If set, alters the prefix used when tagging a new version when performing a version increment using npm-version. To remove the prefix altogether, set it to the empty string: "".

Because other tools may rely on the convention that npm version tags look like v1.0.0, only use this property if it is absolutely necessary. In particular, use care when overriding this setting for public packages.

timing¶

If true, writes an npm-debug log to _logs and timing information to _timing.json, both in your cache. _timing.json is a newline delimited list of JSON objects. You can quickly view it with this json https://www.npmjs.com/package/json command line: json -g < ~/.npm/_timing.json.

tmp¶

Where to store temporary files and folders. All temp files are deleted on success, but left behind on failure for forensic purposes.

unicode¶

When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters to draw trees.

unsafe-perm¶

Set to true to suppress the UID/GID switching when running package scripts. If set explicitly to false, then installing as a non-root user will fail.

usage¶

Set to show short usage output (like the -H output) instead of complete help when doing npm help npm-help.

user¶

The UID to set to when running package scripts as root.

userconfig¶

The location of user-level configuration settings.

umask¶

The "umask" value to use when setting the file creation mode on files and folders.

Folders and executables are given a mode which is 0777 masked against this value. Other files are given a mode which is 0666 masked against this value. Thus, the defaults are 0755 and 0644 respectively.

user-agent¶

Sets a User-Agent to the request header

version¶

If true, output the npm version and exit successfully.

Only relevant when specified explicitly on the command line.

versions¶

If true, output the npm version as well as node's process.versions map, and exit successfully.

Only relevant when specified explicitly on the command line.

viewer¶

The program to use to view help content.

Set to "browser" to view html help content in the default web browser.