11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>npmrc</title> 41cb0ef41Sopenharmony_ci<style> 51cb0ef41Sopenharmony_cibody { 61cb0ef41Sopenharmony_ci background-color: #ffffff; 71cb0ef41Sopenharmony_ci color: #24292e; 81cb0ef41Sopenharmony_ci 91cb0ef41Sopenharmony_ci margin: 0; 101cb0ef41Sopenharmony_ci 111cb0ef41Sopenharmony_ci line-height: 1.5; 121cb0ef41Sopenharmony_ci 131cb0ef41Sopenharmony_ci font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 141cb0ef41Sopenharmony_ci} 151cb0ef41Sopenharmony_ci#rainbar { 161cb0ef41Sopenharmony_ci height: 10px; 171cb0ef41Sopenharmony_ci background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 181cb0ef41Sopenharmony_ci} 191cb0ef41Sopenharmony_ci 201cb0ef41Sopenharmony_cia { 211cb0ef41Sopenharmony_ci text-decoration: none; 221cb0ef41Sopenharmony_ci color: #0366d6; 231cb0ef41Sopenharmony_ci} 241cb0ef41Sopenharmony_cia:hover { 251cb0ef41Sopenharmony_ci text-decoration: underline; 261cb0ef41Sopenharmony_ci} 271cb0ef41Sopenharmony_ci 281cb0ef41Sopenharmony_cipre { 291cb0ef41Sopenharmony_ci margin: 1em 0px; 301cb0ef41Sopenharmony_ci padding: 1em; 311cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 321cb0ef41Sopenharmony_ci border-radius: 6px; 331cb0ef41Sopenharmony_ci 341cb0ef41Sopenharmony_ci display: block; 351cb0ef41Sopenharmony_ci overflow: auto; 361cb0ef41Sopenharmony_ci 371cb0ef41Sopenharmony_ci white-space: pre; 381cb0ef41Sopenharmony_ci 391cb0ef41Sopenharmony_ci background-color: #f6f8fa; 401cb0ef41Sopenharmony_ci color: #393a34; 411cb0ef41Sopenharmony_ci} 421cb0ef41Sopenharmony_cicode { 431cb0ef41Sopenharmony_ci font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 441cb0ef41Sopenharmony_ci font-size: 85%; 451cb0ef41Sopenharmony_ci padding: 0.2em 0.4em; 461cb0ef41Sopenharmony_ci background-color: #f6f8fa; 471cb0ef41Sopenharmony_ci color: #393a34; 481cb0ef41Sopenharmony_ci} 491cb0ef41Sopenharmony_cipre > code { 501cb0ef41Sopenharmony_ci padding: 0; 511cb0ef41Sopenharmony_ci background-color: inherit; 521cb0ef41Sopenharmony_ci color: inherit; 531cb0ef41Sopenharmony_ci} 541cb0ef41Sopenharmony_cih1, h2, h3 { 551cb0ef41Sopenharmony_ci font-weight: 600; 561cb0ef41Sopenharmony_ci} 571cb0ef41Sopenharmony_ci 581cb0ef41Sopenharmony_ci#logobar { 591cb0ef41Sopenharmony_ci background-color: #333333; 601cb0ef41Sopenharmony_ci margin: 0 auto; 611cb0ef41Sopenharmony_ci padding: 1em 4em; 621cb0ef41Sopenharmony_ci} 631cb0ef41Sopenharmony_ci#logobar .logo { 641cb0ef41Sopenharmony_ci float: left; 651cb0ef41Sopenharmony_ci} 661cb0ef41Sopenharmony_ci#logobar .title { 671cb0ef41Sopenharmony_ci font-weight: 600; 681cb0ef41Sopenharmony_ci color: #dddddd; 691cb0ef41Sopenharmony_ci float: left; 701cb0ef41Sopenharmony_ci margin: 5px 0 0 1em; 711cb0ef41Sopenharmony_ci} 721cb0ef41Sopenharmony_ci#logobar:after { 731cb0ef41Sopenharmony_ci content: ""; 741cb0ef41Sopenharmony_ci display: block; 751cb0ef41Sopenharmony_ci clear: both; 761cb0ef41Sopenharmony_ci} 771cb0ef41Sopenharmony_ci 781cb0ef41Sopenharmony_ci#content { 791cb0ef41Sopenharmony_ci margin: 0 auto; 801cb0ef41Sopenharmony_ci padding: 0 4em; 811cb0ef41Sopenharmony_ci} 821cb0ef41Sopenharmony_ci 831cb0ef41Sopenharmony_ci#table_of_contents > h2 { 841cb0ef41Sopenharmony_ci font-size: 1.17em; 851cb0ef41Sopenharmony_ci} 861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child { 871cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 881cb0ef41Sopenharmony_ci border-radius: 6px; 891cb0ef41Sopenharmony_ci padding: 1em; 901cb0ef41Sopenharmony_ci background-color: #f6f8fa; 911cb0ef41Sopenharmony_ci color: #393a34; 921cb0ef41Sopenharmony_ci} 931cb0ef41Sopenharmony_ci#table_of_contents ul { 941cb0ef41Sopenharmony_ci list-style-type: none; 951cb0ef41Sopenharmony_ci padding-left: 1.5em; 961cb0ef41Sopenharmony_ci} 971cb0ef41Sopenharmony_ci#table_of_contents li { 981cb0ef41Sopenharmony_ci font-size: 0.9em; 991cb0ef41Sopenharmony_ci} 1001cb0ef41Sopenharmony_ci#table_of_contents li a { 1011cb0ef41Sopenharmony_ci color: #000000; 1021cb0ef41Sopenharmony_ci} 1031cb0ef41Sopenharmony_ci 1041cb0ef41Sopenharmony_ciheader.title { 1051cb0ef41Sopenharmony_ci border-bottom: solid 1px #e1e4e8; 1061cb0ef41Sopenharmony_ci} 1071cb0ef41Sopenharmony_ciheader.title > h1 { 1081cb0ef41Sopenharmony_ci margin-bottom: 0.25em; 1091cb0ef41Sopenharmony_ci} 1101cb0ef41Sopenharmony_ciheader.title > .description { 1111cb0ef41Sopenharmony_ci display: block; 1121cb0ef41Sopenharmony_ci margin-bottom: 0.5em; 1131cb0ef41Sopenharmony_ci line-height: 1; 1141cb0ef41Sopenharmony_ci} 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_cifooter#edit { 1171cb0ef41Sopenharmony_ci border-top: solid 1px #e1e4e8; 1181cb0ef41Sopenharmony_ci margin: 3em 0 4em 0; 1191cb0ef41Sopenharmony_ci padding-top: 2em; 1201cb0ef41Sopenharmony_ci} 1211cb0ef41Sopenharmony_ci</style> 1221cb0ef41Sopenharmony_ci</head> 1231cb0ef41Sopenharmony_ci<body> 1241cb0ef41Sopenharmony_ci<div id="banner"> 1251cb0ef41Sopenharmony_ci<div id="rainbar"></div> 1261cb0ef41Sopenharmony_ci<div id="logobar"> 1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 1301cb0ef41Sopenharmony_ci</svg> 1311cb0ef41Sopenharmony_ci<div class="title"> 1321cb0ef41Sopenharmony_cinpm command-line interface 1331cb0ef41Sopenharmony_ci</div> 1341cb0ef41Sopenharmony_ci</div> 1351cb0ef41Sopenharmony_ci</div> 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci<section id="content"> 1381cb0ef41Sopenharmony_ci<header class="title"> 1391cb0ef41Sopenharmony_ci<h1 id="npmrc">npmrc</h1> 1401cb0ef41Sopenharmony_ci<span class="description">The npm config files</span> 1411cb0ef41Sopenharmony_ci</header> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci<section id="table_of_contents"> 1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2> 1451cb0ef41Sopenharmony_ci<div id="_table_of_contents"><ul><li><a href="#description">Description</a></li><li><a href="#files">Files</a></li><ul><li><a href="#comments">Comments</a></li><li><a href="#per-project-config-file">Per-project config file</a></li><li><a href="#per-user-config-file">Per-user config file</a></li><li><a href="#global-config-file">Global config file</a></li><li><a href="#built-in-config-file">Built-in config file</a></li></ul><li><a href="#auth-related-configuration">Auth related configuration</a></li><li><a href="#see-also">See also</a></li></ul></div> 1461cb0ef41Sopenharmony_ci</section> 1471cb0ef41Sopenharmony_ci 1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="description">Description</h3> 1491cb0ef41Sopenharmony_ci<p>npm gets its config settings from the command line, environment variables, 1501cb0ef41Sopenharmony_ciand <code>npmrc</code> files.</p> 1511cb0ef41Sopenharmony_ci<p>The <code>npm config</code> command can be used to update and edit the contents of the 1521cb0ef41Sopenharmony_ciuser and global npmrc files.</p> 1531cb0ef41Sopenharmony_ci<p>For a list of available configuration options, see 1541cb0ef41Sopenharmony_ci<a href="../using-npm/config.html">config</a>.</p> 1551cb0ef41Sopenharmony_ci<h3 id="files">Files</h3> 1561cb0ef41Sopenharmony_ci<p>The four relevant files are:</p> 1571cb0ef41Sopenharmony_ci<ul> 1581cb0ef41Sopenharmony_ci<li>per-project config file (<code>/path/to/my/project/.npmrc</code>)</li> 1591cb0ef41Sopenharmony_ci<li>per-user config file (<code>~/.npmrc</code>)</li> 1601cb0ef41Sopenharmony_ci<li>global config file (<code>$PREFIX/etc/npmrc</code>)</li> 1611cb0ef41Sopenharmony_ci<li>npm builtin config file (<code>/path/to/npm/npmrc</code>)</li> 1621cb0ef41Sopenharmony_ci</ul> 1631cb0ef41Sopenharmony_ci<p>All npm config files are an ini-formatted list of <code>key = value</code> parameters. 1641cb0ef41Sopenharmony_ciEnvironment variables can be replaced using <code>${VARIABLE_NAME}</code>. For 1651cb0ef41Sopenharmony_ciexample:</p> 1661cb0ef41Sopenharmony_ci<pre><code class="language-bash">prefix = ${HOME}/.npm-packages 1671cb0ef41Sopenharmony_ci</code></pre> 1681cb0ef41Sopenharmony_ci<p>Each of these files is loaded, and config options are resolved in priority 1691cb0ef41Sopenharmony_ciorder. For example, a setting in the userconfig file would override the 1701cb0ef41Sopenharmony_cisetting in the globalconfig file.</p> 1711cb0ef41Sopenharmony_ci<p>Array values are specified by adding "[]" after the key name. For example:</p> 1721cb0ef41Sopenharmony_ci<pre><code class="language-bash">key[] = "first value" 1731cb0ef41Sopenharmony_cikey[] = "second value" 1741cb0ef41Sopenharmony_ci</code></pre> 1751cb0ef41Sopenharmony_ci<h4 id="comments">Comments</h4> 1761cb0ef41Sopenharmony_ci<p>Lines in <code>.npmrc</code> files are interpreted as comments when they begin with a 1771cb0ef41Sopenharmony_ci<code>;</code> or <code>#</code> character. <code>.npmrc</code> files are parsed by 1781cb0ef41Sopenharmony_ci<a href="https://github.com/npm/ini">npm/ini</a>, which specifies this comment syntax.</p> 1791cb0ef41Sopenharmony_ci<p>For example:</p> 1801cb0ef41Sopenharmony_ci<pre><code class="language-bash"># last modified: 01 Jan 2016 1811cb0ef41Sopenharmony_ci; Set a new registry for a scoped package 1821cb0ef41Sopenharmony_ci@myscope:registry=https://mycustomregistry.example.org 1831cb0ef41Sopenharmony_ci</code></pre> 1841cb0ef41Sopenharmony_ci<h4 id="per-project-config-file">Per-project config file</h4> 1851cb0ef41Sopenharmony_ci<p>When working locally in a project, a <code>.npmrc</code> file in the root of the 1861cb0ef41Sopenharmony_ciproject (ie, a sibling of <code>node_modules</code> and <code>package.json</code>) will set 1871cb0ef41Sopenharmony_ciconfig values specific to this project.</p> 1881cb0ef41Sopenharmony_ci<p>Note that this only applies to the root of the project that you're running 1891cb0ef41Sopenharmony_cinpm in. It has no effect when your module is published. For example, you 1901cb0ef41Sopenharmony_cican't publish a module that forces itself to install globally, or in a 1911cb0ef41Sopenharmony_cidifferent location.</p> 1921cb0ef41Sopenharmony_ci<p>Additionally, this file is not read in global mode, such as when running 1931cb0ef41Sopenharmony_ci<code>npm install -g</code>.</p> 1941cb0ef41Sopenharmony_ci<h4 id="per-user-config-file">Per-user config file</h4> 1951cb0ef41Sopenharmony_ci<p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set in the environment or on 1961cb0ef41Sopenharmony_cithe command line)</p> 1971cb0ef41Sopenharmony_ci<h4 id="global-config-file">Global config file</h4> 1981cb0ef41Sopenharmony_ci<p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above): This file 1991cb0ef41Sopenharmony_ciis an ini-file formatted list of <code>key = value</code> parameters. Environment 2001cb0ef41Sopenharmony_civariables can be replaced as above.</p> 2011cb0ef41Sopenharmony_ci<h4 id="built-in-config-file">Built-in config file</h4> 2021cb0ef41Sopenharmony_ci<p><code>path/to/npm/itself/npmrc</code></p> 2031cb0ef41Sopenharmony_ci<p>This is an unchangeable "builtin" configuration file that npm keeps 2041cb0ef41Sopenharmony_ciconsistent across updates. Set fields in here using the <code>./configure</code> 2051cb0ef41Sopenharmony_ciscript that comes with npm. This is primarily for distribution maintainers 2061cb0ef41Sopenharmony_cito override default configs in a standard and consistent manner.</p> 2071cb0ef41Sopenharmony_ci<h3 id="auth-related-configuration">Auth related configuration</h3> 2081cb0ef41Sopenharmony_ci<p>The settings <code>_auth</code>, <code>_authToken</code>, <code>username</code> and <code>_password</code> must all be 2091cb0ef41Sopenharmony_ciscoped to a specific registry. This ensures that <code>npm</code> will never send 2101cb0ef41Sopenharmony_cicredentials to the wrong host.</p> 2111cb0ef41Sopenharmony_ci<p>The full list is:</p> 2121cb0ef41Sopenharmony_ci<ul> 2131cb0ef41Sopenharmony_ci<li><code>_auth</code> (base64 authentication string)</li> 2141cb0ef41Sopenharmony_ci<li><code>_authToken</code> (authentication token)</li> 2151cb0ef41Sopenharmony_ci<li><code>username</code></li> 2161cb0ef41Sopenharmony_ci<li><code>_password</code></li> 2171cb0ef41Sopenharmony_ci<li><code>email</code></li> 2181cb0ef41Sopenharmony_ci<li><code>certfile</code> (path to certificate file)</li> 2191cb0ef41Sopenharmony_ci<li><code>keyfile</code> (path to key file)</li> 2201cb0ef41Sopenharmony_ci</ul> 2211cb0ef41Sopenharmony_ci<p>In order to scope these values, they must be prefixed by a URI fragment. 2221cb0ef41Sopenharmony_ciIf the credential is meant for any request to a registry on a single host, 2231cb0ef41Sopenharmony_cithe scope may look like <code>//registry.npmjs.org/:</code>. If it must be scoped to a 2241cb0ef41Sopenharmony_cispecific path on the host that path may also be provided, such as 2251cb0ef41Sopenharmony_ci<code>//my-custom-registry.org/unique/path:</code>.</p> 2261cb0ef41Sopenharmony_ci<pre><code>; bad config 2271cb0ef41Sopenharmony_ci_authToken=MYTOKEN 2281cb0ef41Sopenharmony_ci 2291cb0ef41Sopenharmony_ci; good config 2301cb0ef41Sopenharmony_ci@myorg:registry=https://somewhere-else.com/myorg 2311cb0ef41Sopenharmony_ci@another:registry=https://somewhere-else.com/another 2321cb0ef41Sopenharmony_ci//registry.npmjs.org/:_authToken=MYTOKEN 2331cb0ef41Sopenharmony_ci; would apply to both @myorg and @another 2341cb0ef41Sopenharmony_ci; //somewhere-else.com/:_authToken=MYTOKEN 2351cb0ef41Sopenharmony_ci; would apply only to @myorg 2361cb0ef41Sopenharmony_ci//somewhere-else.com/myorg/:_authToken=MYTOKEN1 2371cb0ef41Sopenharmony_ci; would apply only to @another 2381cb0ef41Sopenharmony_ci//somewhere-else.com/another/:_authToken=MYTOKEN2 2391cb0ef41Sopenharmony_ci</code></pre> 2401cb0ef41Sopenharmony_ci<h3 id="see-also">See also</h3> 2411cb0ef41Sopenharmony_ci<ul> 2421cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/folders.html">npm folders</a></li> 2431cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li> 2441cb0ef41Sopenharmony_ci<li><a href="../using-npm/config.html">config</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/package-json.html">package.json</a></li> 2461cb0ef41Sopenharmony_ci<li><a href="../commands/npm.html">npm</a></li> 2471cb0ef41Sopenharmony_ci</ul></div> 2481cb0ef41Sopenharmony_ci 2491cb0ef41Sopenharmony_ci<footer id="edit"> 2501cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/configuring-npm/npmrc.md"> 2511cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 2521cb0ef41Sopenharmony_ci<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> 2531cb0ef41Sopenharmony_ci</svg> 2541cb0ef41Sopenharmony_ciEdit this page on GitHub 2551cb0ef41Sopenharmony_ci</a> 2561cb0ef41Sopenharmony_ci</footer> 2571cb0ef41Sopenharmony_ci</section> 2581cb0ef41Sopenharmony_ci 2591cb0ef41Sopenharmony_ci 2601cb0ef41Sopenharmony_ci 2611cb0ef41Sopenharmony_ci</body></html>