org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/doc/files/npmrc.md

   1 npmrc(5) -- The npm config files
   2 ================================
   3
   4 ## DESCRIPTION
   5
   6 npm gets its config settings from the command line, environment
   7 variables, and `npmrc` files.
   8
   9 The `npm config` command can be used to update and edit the contents
  10 of the user and global npmrc files.
  11
  12 For a list of available configuration options, see npm-config(7).
  13
  14 ## FILES
  15
  16 The four relevant files are:
  17
  18 * per-project config file (/path/to/my/project/.npmrc)
  19 * per-user config file (~/.npmrc)
  20 * global config file ($PREFIX/etc/npmrc)
  21 * npm builtin config file (/path/to/npm/npmrc)
  22
  23 All npm config files are an ini-formatted list of `key = value`
  24 parameters.  Environment variables can be replaced using
  25 `${VARIABLE_NAME}`. For example:
  26
  27     prefix = ${HOME}/.npm-packages
  28
  29 Each of these files is loaded, and config options are resolved in
  30 priority order.  For example, a setting in the userconfig file would
  31 override the setting in the globalconfig file.
  32
  33 Array values are specified by adding "[]" after the key name. For
  34 example:
  35
  36     key[] = "first value"
  37     key[] = "second value"
  38
  39 **NOTE:** Because local (per-project or per-user) `.npmrc` files can contain
  40 sensitive credentials, they must be readable and writable _only_ by your user
  41 account (i.e. must have a mode of `0600`), otherwise they _will be ignored by
  42 npm!_
  43
  44 #### Comments
  45
  46 Lines in `.npmrc` files are interpreted as comments when they begin with a `;` or `#` character. `.npmrc` files are parsed by [npm/ini](https://github.com/npm/ini), which specifies this comment syntax.
  47
  48 For example:
  49
  50     # last modified: 01 Jan 2016
  51     ; Set a new registry for a scoped package
  52     @myscope:registry=https://mycustomregistry.example.org
  53
  54 ### Per-project config file
  55
  56 When working locally in a project, a `.npmrc` file in the root of the
  57 project (ie, a sibling of `node_modules` and `package.json`) will set
  58 config values specific to this project.
  59
  60 Note that this only applies to the root of the project that you're
  61 running npm in.  It has no effect when your module is published.  For
  62 example, you can't publish a module that forces itself to install
  63 globally, or in a different location.
  64
  65 Additionally, this file is not read in global mode, such as when running
  66 `npm install -g`.
  67
  68 ### Per-user config file
  69
  70 `$HOME/.npmrc` (or the `userconfig` param, if set in the environment
  71 or on the command line)
  72
  73 ### Global config file
  74
  75 `$PREFIX/etc/npmrc` (or the `globalconfig` param, if set above):
  76 This file is an ini-file formatted list of `key = value` parameters.
  77 Environment variables can be replaced as above.
  78
  79 ### Built-in config file
  80
  81 `path/to/npm/itself/npmrc`
  82
  83 This is an unchangeable "builtin" configuration file that npm keeps
  84 consistent across updates.  Set fields in here using the `./configure`
  85 script that comes with npm.  This is primarily for distribution
  86 maintainers to override default configs in a standard and consistent
  87 manner.
  88
  89 ## SEE ALSO
  90
  91 * npm-folders(5)
  92 * npm-config(1)
  93 * npm-config(7)
  94 * package.json(5)
  95 * npm(1)