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

   1 <!doctype html>
   2 <html>
   3   <title>npmrc</title>
   4   <meta charset="utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/files/npmrc.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../files/npmrc.html">npmrc</a></h1> <p>The npm config files</p>
  13 <h2 id="description">DESCRIPTION</h2>
  14 <p>npm gets its config settings from the command line, environment
  15 variables, and <code>npmrc</code> files.</p>
  16 <p>The <code>npm config</code> command can be used to update and edit the contents
  17 of the user and global npmrc files.</p>
  18 <p>For a list of available configuration options, see <a href="../misc/npm-config.html">npm-config(7)</a>.</p>
  19 <h2 id="files">FILES</h2>
  20 <p>The four relevant files are:</p>
  21 <ul>
  22 <li>per-project config file (/path/to/my/project/.npmrc)</li>
  23 <li>per-user config file (~/.npmrc)</li>
  24 <li>global config file ($PREFIX/etc/npmrc)</li>
  25 <li>npm builtin config file (/path/to/npm/npmrc)</li>
  26 </ul>
  27 <p>All npm config files are an ini-formatted list of <code>key = value</code>
  28 parameters.  Environment variables can be replaced using
  29 <code>${VARIABLE_NAME}</code>. For example:</p>
  30 <pre><code>prefix = ${HOME}/.npm-packages
  31 </code></pre><p>Each of these files is loaded, and config options are resolved in
  32 priority order.  For example, a setting in the userconfig file would
  33 override the setting in the globalconfig file.</p>
  34 <p>Array values are specified by adding &quot;[]&quot; after the key name. For
  35 example:</p>
  36 <pre><code>key[] = &quot;first value&quot;
  37 key[] = &quot;second value&quot;
  38 </code></pre><p><strong>NOTE:</strong> Because local (per-project or per-user) <code>.npmrc</code> files can contain
  39 sensitive credentials, they must be readable and writable <em>only</em> by your user
  40 account (i.e. must have a mode of <code>0600</code>), otherwise they <em>will be ignored by
  41 npm!</em></p>
  42 <h4 id="comments">Comments</h4>
  43 <p>Lines in <code>.npmrc</code> files are interpreted as comments when they begin with a <code>;</code> or <code>#</code> character. <code>.npmrc</code> files are parsed by <a href="https://github.com/npm/ini">npm/ini</a>, which specifies this comment syntax.</p>
  44 <p>For example:</p>
  45 <pre><code># last modified: 01 Jan 2016
  46 ; Set a new registry for a scoped package
  47 @myscope:registry=https://mycustomregistry.example.org
  48 </code></pre><h3 id="per-project-config-file">Per-project config file</h3>
  49 <p>When working locally in a project, a <code>.npmrc</code> file in the root of the
  50 project (ie, a sibling of <code>node_modules</code> and <code>package.json</code>) will set
  51 config values specific to this project.</p>
  52 <p>Note that this only applies to the root of the project that you&#39;re
  53 running npm in.  It has no effect when your module is published.  For
  54 example, you can&#39;t publish a module that forces itself to install
  55 globally, or in a different location.</p>
  56 <p>Additionally, this file is not read in global mode, such as when running
  57 <code>npm install -g</code>.</p>
  58 <h3 id="per-user-config-file">Per-user config file</h3>
  59 <p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set in the environment
  60 or on the command line)</p>
  61 <h3 id="global-config-file">Global config file</h3>
  62 <p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above):
  63 This file is an ini-file formatted list of <code>key = value</code> parameters.
  64 Environment variables can be replaced as above.</p>
  65 <h3 id="built-in-config-file">Built-in config file</h3>
  66 <p><code>path/to/npm/itself/npmrc</code></p>
  67 <p>This is an unchangeable &quot;builtin&quot; configuration file that npm keeps
  68 consistent across updates.  Set fields in here using the <code>./configure</code>
  69 script that comes with npm.  This is primarily for distribution
  70 maintainers to override default configs in a standard and consistent
  71 manner.</p>
  72 <h2 id="see-also">SEE ALSO</h2>
  73 <ul>
  74 <li><a href="../files/npm-folders.html">npm-folders(5)</a></li>
  75 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
  76 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
  77 <li><a href="../files/package.json.html">package.json(5)</a></li>
  78 <li><a href="../cli/npm.html">npm(1)</a></li>
  79 </ul>
  80
  81 </div>
  82
  83 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  84 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  85 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  86 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  87 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  88 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  89 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  90 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  91 </table>
  92 <p id="footer">npmrc &mdash; npm@2.15.11</p>
  93