Ubuntu Manpage: npm-config - More than you probably want to know about npm configuration

NAME

       npm-config - More than you probably want to know about npm configuration

DESCRIPTION

npm gets its configuration values from the following sources, sorted by priority:

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:

· per-project configuration file (/path/to/my/project/.npmrc)

· per-user configuration file (defaults to $HOME/.npmrc; configurable via CLI option
--userconfig or environment variable $NPM_CONFIG_USERCONFIG)

· global configuration file (defaults to $PREFIX/etc/npmrc; configurable via CLI option
--globalconfig or environment variable $NPM_CONFIG_GLOBALCONFIG)

· npm's built-in configuration file (/path/to/npm/npmrc)

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.

Shorthands and Other CLI Niceties

       The following shorthands are parsed on the command-line:

       · -v: --version

       · -h, -?, --help, -H: --usage

       · -s, --silent: --loglevel silent

       · -q, --quiet: --loglevel warn

       · -d: --loglevel info

       · -dd, --verbose: --loglevel verbose

       · -ddd: --loglevel silly

       · -g: --global

       · -C: --prefix

       · -l: --long

       · -m: --message

       · -p, --porcelain: --parseable

       · -reg: --registry

       · -f: --force

       · -desc: --description

       · -S: --save

       · -P: --save-prod

       · -D: --save-dev

       · -O: --save-optional

       · -B: --save-bundle

       · -E: --save-exact

       · -y: --yes

       · -n: --yes false

       · ll and la commands: ls --long

       If  the  specified  configuration  param  resolves  unambiguously to a known configuration
       parameter, then it is expanded to that configuration parameter.  For example:

         npm ls --par
         # same as:
         npm ls --parseable

       If multiple single-character shorthands are strung together, and the resulting combination
       is  unambiguously  not  some other configuration param, then it is expanded to its various
       component pieces.  For example:

         npm ls -gpld
         # same as:
         npm ls --global --parseable --long --loglevel info

Per-Package Config Settings

       When running scripts (see npm help 7  npm-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

       See npm help 5 package.json for more information.

Config Settings

access
· Default: restricted

· Type: 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
· Default: false

· Type: Boolean

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

always-auth
· Default: false

· Type: Boolean

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

also
· Default: null

· Type: String

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

auth-type
· Default: 'legacy'

· Type: 'legacy', 'sso', 'saml', 'oauth'

What authentication strategy to use with adduser/login.

bin-links
· Default: true

· Type: Boolean

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
· Default: OS X: "open", Windows: "start", Others: "xdg-open"

· Type: String

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

ca
· Default: The npm CA certificate

· Type: String, Array or null

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[]="..."

NAME

DESCRIPTION

Shorthands and Other CLI Niceties

Per-Package Config Settings

Config Settings

SEE ALSO