Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: v0.2.16
Fetching contributors…

Cannot retrieve contributors at this time

363 lines (218 sloc) 9.201 kb

npm-config(1) -- Manage the npm configuration file

SYNOPSIS

npm config set <key> <value> [--global]
npm config get <key>
npm config delete <key>
npm config list
npm config edit
npm get <key>
npm set <key> <value> [--global]

DESCRIPTION

npm gets its configuration values from 5 sources, in this priority:

  • cli: The 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. A --flag parameter that is at the end of the command will be given the value of true.
  • env: 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.
  • $HOME/.npmrc (or the userconfig param, if set above): This file is an ini-file formatted list of key = value parameters.
  • $PREFIX/etc/npmrc (or the globalconfig param, if set above): This file is an ini-file formatted list of key = value parameters
  • default configs: This is a set of configuration parameters that are internal to npm, and are defaults if nothing else is specified.

Sub-commands

Config supports the following sub-commands:

set

npm config set key value

Sets the config key to the value.

get

npm config get key

Echo the config value to stdout. (NOTE: All the other npm logging is done to stderr, so pipes should work properly, and you can do npm get key 2>/dev/null to print out JUST the config value.)

list

npm config list

Show all the config settings.

delete

npm config delete key

Deletes the key from all configuration files.

edit

npm config edit

Opens the config file in an editor. Use the --global flag to edit the global config.

Per-Package Config Settings

When running scripts (see npm help scripts) the package.json "config" keys are overwritten in the environment if there is a config param of <name>[@<version>]:<key>. For example, if the package.json has this:

{ "name" : "foo"
, "config" : { "port" : "8080" }
, "scripts" : { "start" : "node server.js" } }

and the server.js is this:

http.createServer(...).listen(process.env.npm_package_config_port)

then the user could change the behavior by doing:

npm config set foo:port 80

Config Settings

auto-activate

Default: true

Automatically activate a package after installation, if there is not an active version already. Set to "always" to always activate when installing.

rebuild-bundle

Default: true

Set to some truish value to rebuild bundled dependencies after installation.

recursive

Default: false

Set to some truish value to recursively remove dependent packages. For example if foo depends on bar, and bar depends on baz, then:

npm uninstall baz --recursive

will remove baz, bar, and foo.

loglevel

Default: "info"

The log level to show.

Each level maps to a numeric value, above which all logs must pass to be seen. So, setting it to "warn" shows "win", "error" and "warn" messages.

The log levels:

  • silent: Show no output. Nothing. If there is output on stderr, it's because something is broken.
  • win: Show the "npm ok" or "npm not ok", but that's all.
  • error: Errors, usually with a stack trace.
  • warn: Things that you should probably be aware of.
  • info: Helpful info.
  • silly: Not-helpful info. (Lots of dumping whole objects and such.)

Note that output to stdout is always printed. This setting just modifies what's logged to stderr.

update-dependents

Default: true

Automatically update a package's dependencies after installation, if it is the newest version installed. Set to "always" to update dependents when a new version is installed, even if it's not the newest.

root

Default: $INSTALL_PREFIX/lib/node

The root folder where packages are installed and npm keeps its data.

binroot

Default: $INSTALL_PREFIX/bin

The folder where executable programs are installed.

Set to "false" to not install executables

manroot

Default: $INSTALL_PREFIX/share/man

The folder where man pages are installed.

Set to "false" to not install man pages.

registry

Default: https://registry.npmjs.org/

The base URL of the npm package registry.

_auth

A base-64 encoded "user:pass" pair. This is created by npm-adduser(1).

If your config file is ever corrupted, you can set this manually by doing:

npm adduser

_authCrypt

If crypto.Cipher is available, and you have some private keys in $HOME/.ssh, then npm will encrypt your "_auth" config before saving to the .npmrc file, and will decrypt the "_authCrypt" config when it reads the .npmrc file.

username, _password

Once the configuration is parsed, the _auth config is split into username and _password. This is the part before the ":"

proxy

If proxy is available, then npm will access the registry via the proxy server.

Example:

proxy = http://user:password@proxy-server:8080

tag

Default: latest

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

Note: this has no effect on the npm-tag(1) command.

userconfig

The default user configuration file is process.env.HOME+"/.npmrc".

Note that this must be provided either in the cli or env settings. Once the userconfig is read, it is irrelevant.

globalconfig

The default global configuration file is resolved based on the location of the node executable. It is process.execPath+"/../../etc/npmrc". In the canonical NodeJS installation with make install, this is /usr/local/etc/npmrc. If you put the node binary somewhere else (for instance, if you are using nvm or nave), then it would be resolved relative to that location.

Note that this must be provided in the cli, env, or userconfig settings. Once the globalconfig is read, this parameter is irrelevant.

global

If set to some truish value (for instance, by being the last cli flag or being passed a literal true or 1), and the npm config set param is being called, then the new configuration paramater is written global config file. Otherwise, they are saved to the user config file.

dev

If set to a truish value, then it'll install the "devDependencies" as well as "dependencies" when installing a package.

Note that devDependencies are always installed when linking a package.

tar

Default: env.TAR or "tar"

The name of a GNU-compatible tar program on your system.

gzip

Default: env.GZIPBIN or "gzip"

The name of a GNU-compatible gzip program on your system.

usage

If set to true, then this will tell help to print out the short usage statement instead of the long manpage type thing.

This is set automatically if you invoke help like npm command -?.

viewer

Default: "man"

The program to use to view help content. Set to "woman" to use the emacs troff viewer by that name.

_exit

Default: true

Whether or not to exit the process when the command is finished. When using npm programmatically, it's a good idea to set this to false explicitly.

logfd

Default: Standard Error FD (2)

The file descriptor (integer) or stream object where npm will write log messages.

When using npm programmatically, you may want to provide a FileWriteStream, or some other form of WritableStream.

outfd

Default: Standard Output FD (1)

The file descriptor (integer) or stream object where npm will write "normal" output. For instance, the ls and view commands write their output here.

When using npm programmatically, you may want to provide a FileWriteStream, or some other form of WritableStream.

color

Default: true

Set to false to disable colorized output.

In versions of node that expose the isatty function, npm will never write colorized output to a non-terminal file descriptor.

tmproot

Default: env.TMPDIR or "/tmp"

The folder where temporary files should be placed.

npm creates a subfolder whenever it is run, and attempts to delete it afterwards.

force

Default: false

Set to a truish value to force uninstalling packages, even if they have dependents.

Note that setting recursive is safer, because forcing uninstall can create orphan packages that no longer function properly.

editor

Default: env.EDITOR

The program to use to edit files.

listopts

Default: ""

A whitespace-separated list of extra args that are always passed to npm ls

For example: listopts = remote

npm ls

The output here will always filter by remote

must-install

Default: true

Set to false to not install over packages that already exist. By default, npm install foo will fetch and install the latest version of foo, even if it matches a version already installed.

description

Default: true

Show the package description in npm ls.

Jump to Line
Something went wrong with that request. Please try again.