Go to main content

man pages section 7: Standards, Environments, Macros, Character Sets, and Miscellany

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-config (7)

Name

npm-config - tion

Synopsis

Please see following description for synopsis

Description

NPM-CONFIG(7)                                                    NPM-CONFIG(7)



NAME
       npm-config  -  More than you probably want to know about npm configura-
       tion

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 param-
       eter 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 inter-
       preted as a configuration parameter.   For  example,  putting  npm_con-
       fig_foo=bar  in your environment will set the foo configuration parame-
       ter 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 vari-
       ables 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:

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

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

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

       o 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:

       o -v: --version

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

       o -s, --silent: --loglevel silent

       o -q, --quiet: --loglevel warn

       o -d: --loglevel info

       o -dd, --verbose: --loglevel verbose

       o -ddd: --loglevel silly

       o -g: --global

       o -C: --prefix

       o -l: --long

       o -m: --message

       o -p, --porcelain: --parseable

       o -reg: --registry

       o -f: --force

       o -desc: --description

       o -S: --save

       o -P: --save-prod

       o -D: --save-dev

       o -O: --save-optional

       o -B: --save-bundle

       o -E: --save-exact

       o -y: --yes

       o -n: --yes false

       o 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  exam-
       ple:

         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
       o Default: restricted

       o 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
       o Default: false

       o Type: Boolean


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

   always-auth
       o Default: false

       o Type: Boolean


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

   also
       o Default: null

       o Type: String


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

   audit
       o Default: true

       o Type: Boolean


       When  "true"  submit  audit  reports  alongside npm install runs to the
       default registry and all registries configured  for  scopes.   See  the
       documentation for npm help audit for details on what is submitted.

   audit-level
       o Default: "low"

       o Type: 'low', 'moderate', 'high', 'critical'


       The  minimum  level  of  vulnerability  for  npm  audit  to exit with a
       non-zero exit code.

   auth-type
       o Default: 'legacy'

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


       What authentication strategy to use with adduser/login.

   bin-links
       o Default: true

       o 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  osten-
       sibly Unix systems.

   browser
       o Default: OS X: "open", Windows: "start", Others: "xdg-open"

       o Type: String


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

   ca
       o Default: The npm CA certificate

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

       See also the strict-ssl config.

   cafile
       o Default: null

       o Type: path


       A path to a file containing one or multiple Certificate Authority sign-
       ing 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
       o Default: Windows: %AppData%\npm-cache, Posix: ~/.npm

       o Type: path


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

   cache-lock-stale
       o Default: 60000 (1 minute)

       o Type: Number


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

   cache-lock-retries
       o Default: 10

       o Type: Number


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

   cache-lock-wait
       o Default: 10000 (10 seconds)

       o Type: Number


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

   cache-max
       o Default: Infinity

       o Type: Number


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

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

   cache-min
       o Default: 10

       o Type: Number


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

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

   cert
       o Default: null

       o Type: String


       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
       o Default: null

       o Type: String, Array, null


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

   color
       o Default: true

       o Type: Boolean or "always"


       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  dis-
       abled when the environment variable NO_COLOR is set to any value.

   depth
       o Default: Infinity

       o Type: Number


       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
       o Default: true

       o Type: Boolean


       Show the description in npm search

   dev
       o Default: false

       o Type: Boolean


       Install dev-dependencies along with packages.

   dry-run
       o Default: false

       o Type: Boolean


       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 some  net-
       work related commands, eg dist-tags, owner, etc.

   editor
       o Default:  EDITOR  environment  variable  if set, or "vi" on Posix, or
         "notepad" on Windows.

       o Type: path


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

   engine-strict
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


       Makes various commands more forceful.

       o lifecycle script failure does not block progress.

       o publishing clobbers previously published versions.

       o skips cache when requesting from the registry.

       o prevents checks against clobbering non-npm files.


   fetch-retries
       o Default: 2

       o Type: Number


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

   fetch-retry-factor
       o Default: 10

       o Type: Number


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

   fetch-retry-mintimeout
       o Default: 10000 (10 seconds)

       o Type: Number


       The "minTimeout" config for the retry module to use when fetching pack-
       ages.

   fetch-retry-maxtimeout
       o Default: 60000 (1 minute)

       o Type: Number


       The "maxTimeout" config for the retry module to use when fetching pack-
       ages.

   git
       o Default: "git"

       o Type: String


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

   git-tag-version
       o Default: true

       o Type: Boolean


       Tag the commit when using the npm version command.

   commit-hooks
       o Default: true

       o Type: Boolean


       Run git commit hooks when using the npm version command.

   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  5
       npm-folders 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


   globalconfig
       o Default: {prefix}/etc/npmrc

       o Type: path


       The config file to read for global config options.

   global-style
       o Default: false

       o Type: Boolean


       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 obvi-
       ously will eliminate  some  deduping.  If  used  with  legacy-bundling,
       legacy-bundling will be preferred.

   group
       o Default: GID of the current process

       o Type: String or Number


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

   heading
       o Default: "npm"

       o Type: String


       The string that starts all the debugging log output.

   https-proxy
       o Default: null

       o Type: url


       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
       o Default: false

       o Type: Boolean


       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 pack-
       age.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 use-
       ful, for example, when running scripts that may  only  apply  for  some
       builds in an otherwise generic CI setup.

   ignore-prepublish
       o Default: false

       o Type: Boolean


       If true, npm will not run prepublish scripts.

   ignore-scripts
       o Default: false

       o Type: Boolean


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

   init-module
       o Default: ~/.npm-init.js

       o Type: path


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

   init-author-name
       o Default: ""

       o Type: String


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

   init-author-email
       o Default: ""

       o Type: String


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

   init-author-url
       o Default: ""

       o Type: String


       The value npm init should use by default for the package author's home-
       page.

   init-license
       o Default: "ISC"

       o Type: String


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

   init-version
       o Default: "1.0.0"

       o Type: semver


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

   json
       o Default: false

       o Type: Boolean


       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
       o Default: null

       o Type: String


       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
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


       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:

       o The package is not already installed globally, or

       o the globally installed version is identical to the  version  that  is
         being installed locally.


   local-address
       o Default: undefined

       o Type: IP 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
       o Default: "notice"

       o Type: String

       o Values:  "silent",  "error",  "warn",  "notice",  "http",   "timing",
         "info", "verbose", "silly"


       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
       o Default: process.stderr

       o Type: Stream


       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  pro-
       grammatically,  you  may  wish  to  send  logs  to somewhere other than
       stderr.

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

   logs-max
       o Default: 10

       o Type: Number


       The maximum number of log files to store.

   long
       o Default: false

       o Type: Boolean


       Show extended information in npm ls and npm search.

   maxsockets
       o Default: 50

       o Type: Number


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

   message
       o Default: "%s"

       o Type: String


       Commit message which is used by npm version when creating version  com-
       mit.

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

   metrics-registry
       o Default: The value of  registry (which defaults to "https://

       o Type: String


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

   node-options
       o Default: null

       o Type: String


       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
       o Default: process.version

       o Type: semver or false


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

   noproxy
       o Default: null

       o Type: String or Array


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

   offline
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: path


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

   only
       o Default: null

       o Type: String


       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
       o Default: true

       o Type: Boolean


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

   otp
       o Default: null

       o Type: Number


       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
       o Default: true

       o Type: Boolean


       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 extrane-
       ous 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
       o Default: false

       o Type: Boolean


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

   parseable
       o Default: false

       o Type: Boolean


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

   prefer-offline
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


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

   prefix
       o Default: see npm help 5 folders

       o Type: path


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

   preid
       o Default: ""

       o Type: String


       The  "prerelease  identifier"  to  use as a prefix for the "prerelease"
       part of a semver. Like the rc in 1.2.0-rc.8.

   production
       o Default: false

       o Type: Boolean


       Set to true to run in "production" mode.

       1. devDependencies are not installed at the topmost level when  running
          local npm install without any arguments.

       2. Set the NODE_ENV="production" for lifecycle scripts.


   progress
       o Default: true, unless TRAVIS or CI env vars set.

       o Type: Boolean


       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
       o Default: null

       o Type: url


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

   read-only
       o Default: false

       o Type: Boolean


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

   rebuild-bundle
       o Default: true

       o Type: Boolean


       Rebuild bundled dependencies after installation.

   registry
       o Default: https://

       o Type: url


       The base URL of the npm package registry.

   rollback
       o Default: true

       o Type: Boolean


       Remove failed installs.

   save
       o Default: true

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


       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 bundleDependen-
       cies list.

       When used with the npm rm command, it removes it from the bundledDepen-
       dencies list.

   save-prod
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


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

       When  used with the npm rm command, it removes it from the devDependen-
       cies object.

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

   save-exact
       o Default: false

       o Type: Boolean


       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
       o Default: false

       o Type: Boolean


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

       When used with the npm rm command, it removes it from the  devDependen-
       cies object.

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

   save-prefix
       o Default: '^'

       o Type: String


       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
       o Default: the scope of the current project, if any, or ""

       o Type: String


       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  installa-
       tion of packages specified according to the pattern @organization/pack-
       age.

   script-shell
       o Default: null

       o Type: path


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

   scripts-prepend-node-path
       o Default: "warn-only"

       o Type: Boolean, "auto" or "warn-only"


       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 vari-
       able if the node executable with which npm was invoked and the one that
       is found first on the PATH are different.

   searchexclude
       o Default: ""

       o Type: String


       Space-separated options that limit the results from search.

   searchopts
       o Default: ""

       o Type: String


       Space-separated options that are always passed to search.

   searchlimit
       o Default: 20

       o Type: Number


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

   searchstaleness
       o Default: 900 (15 minutes)

       o Type: Number


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

   send-metrics
       o Default: false

       o Type: Boolean


       If  true,  success/failure  metrics  will  be  reported to the registry
       stored in metrics-registry.  These requests contain the number of  suc-
       cessful  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
       o Default:  SHELL environment variable, or "bash" on Posix, or "cmd" on
         Windows

       o Type: path


       The shell to run for the npm explore command.

   shrinkwrap
       o Default: true

       o Type: Boolean


       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-commit
       o Default: false

       o Type: Boolean


       If  set to true, then the npm version command will commit the new pack-
       age 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.

   sign-git-tag
       o Default: false

       o Type: Boolean


       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
       o Default: 500

       o Type: Number


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

   sso-type
       o Default: 'oauth'

       o Type: 'oauth', 'saml', or null


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

   strict-ssl
       o Default: true

       o Type: Boolean


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

       See also the ca config.

   tag
       o Default: latest

       o Type: String


       If  you  ask npm to install a package and don't tell it a specific ver-
       sion, 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
       o Default: "v"

       o Type: String


       If set, alters the prefix used when tagging a new version when perform-
       ing a version increment using  npm-version. To remove the prefix  alto-
       gether, 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 pack-
       ages.

   timing
       o Default: false

       o Type: Boolean


       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/_tim-
       ing.json.

   tmp
       o Default: TMPDIR environment variable, or "/tmp"

       o Type: path


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

   unicode
       o Default:  false  on  windows, true on mac/unix systems with a unicode
         locale

       o Type: Boolean


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

   unsafe-perm
       o Default: false if running as root, true otherwise

       o Type: Boolean


       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.

   update-notifier
       o Default: true

       o Type: Boolean


       Set  to  false  to suppress the update notification when using an older
       version of npm than the latest.

   usage
       o Default: false

       o Type: Boolean


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

   user
       o Default: "nobody"

       o Type: String or Number


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

   userconfig
       o Default: ~/.npmrc

       o Type: path


       The location of user-level configuration settings.

   umask
       o Default: 022

       o Type: Octal numeric string in range 0000..0777 (0..511)


       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
       o Default: node/{process.version} {process.platform} {process.arch}

       o Type: String


       Sets a User-Agent to the request header

   version
       o Default: false

       o Type: boolean


       If true, output the npm version and exit successfully.

       Only relevant when specified explicitly on the command line.

   versions
       o Default: false

       o Type: boolean


       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
       o Default: "man" on Posix, "browser" on Windows

       o Type: path


       The program to use to view help content.

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help config

       o npm help 5 npmrc

       o npm help 7 scripts

       o npm help 5 folders

       o npm help npm





NOTES
       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/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018                    NPM-CONFIG(7)