org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man5/npmrc.5

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