| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347 |
- <!DOCTYPE html><html><head>
- <meta charset="utf-8">
- <title>.npmrc</title>
- <style>
- body {
- background-color: #ffffff;
- color: #24292e;
- margin: 0;
- line-height: 1.5;
- font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
- }
- #rainbar {
- height: 10px;
- background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
- }
- a {
- text-decoration: none;
- color: #0366d6;
- }
- a:hover {
- text-decoration: underline;
- }
- pre {
- margin: 1em 0px;
- padding: 1em;
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- display: block;
- overflow: auto;
- white-space: pre;
- background-color: #f6f8fa;
- color: #393a34;
- }
- code {
- font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
- font-size: 85%;
- padding: 0.2em 0.4em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- pre > code {
- padding: 0;
- background-color: inherit;
- color: inherit;
- }
- h1, h2, h3 {
- font-weight: 600;
- }
- #logobar {
- background-color: #333333;
- margin: 0 auto;
- padding: 1em 4em;
- }
- #logobar .logo {
- float: left;
- }
- #logobar .title {
- font-weight: 600;
- color: #dddddd;
- float: left;
- margin: 5px 0 0 1em;
- }
- #logobar:after {
- content: "";
- display: block;
- clear: both;
- }
- #content {
- margin: 0 auto;
- padding: 0 4em;
- }
- #table_of_contents > h2 {
- font-size: 1.17em;
- }
- #table_of_contents ul:first-child {
- border: solid 1px #e1e4e8;
- border-radius: 6px;
- padding: 1em;
- background-color: #f6f8fa;
- color: #393a34;
- }
- #table_of_contents ul {
- list-style-type: none;
- padding-left: 1.5em;
- }
- #table_of_contents li {
- font-size: 0.9em;
- }
- #table_of_contents li a {
- color: #000000;
- }
- header.title {
- border-bottom: solid 1px #e1e4e8;
- }
- header.title > h1 {
- margin-bottom: 0.25em;
- }
- header.title > .description {
- display: block;
- margin-bottom: 0.5em;
- line-height: 1;
- }
- header.title .version {
- font-size: 0.8em;
- color: #666666;
- }
- footer#edit {
- border-top: solid 1px #e1e4e8;
- margin: 3em 0 4em 0;
- padding-top: 2em;
- }
- table {
- width: 100%;
- margin: 1em 0;
- border-radius: 6px;
- border: 1px solid #e1e4e8;
- overflow: hidden;
- border-collapse: separate;
- border-spacing: 0;
- }
- table thead {
- background-color: #f6f8fa;
- }
- table tbody {
- background-color: #ffffff;
- }
- table th,
- table td {
- padding: 0.75em;
- text-align: left;
- border-right: 1px solid #e1e4e8;
- border-bottom: 1px solid #e1e4e8;
- }
- table th:last-child,
- table td:last-child {
- border-right: none;
- }
- table tbody tr:last-child td {
- border-bottom: none;
- }
- table th {
- font-weight: 600;
- background-color: #f6f8fa;
- }
- table code {
- white-space: nowrap;
- }
- </style>
- </head>
- <body>
- <div id="banner">
- <div id="rainbar"></div>
- <div id="logobar">
- <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
- <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
- <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
- </svg>
- <div class="title">
- npm command-line interface
- </div>
- </div>
- </div>
- <section id="content">
- <header class="title">
- <h1 id="----npmrc----11120">
- <span>.npmrc</span>
- <span class="version">@11.12.0</span>
- </h1>
- <span class="description">The npm config files</span>
- </header>
- <section id="table_of_contents">
- <h2 id="table-of-contents">Table of contents</h2>
- <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="#unsupported-custom-configuration-keys">Unsupported Custom Configuration Keys</a></li><li><a href="#custom--third-party-config-keys">Custom / third-party config keys</a></li><li><a href="#see-also">See also</a></li></ul></div>
- </section>
- <div id="_content"><h3 id="description">Description</h3>
- <p>npm gets its config settings from the command line, environment variables, and <code>npmrc</code> files.</p>
- <p>The <code>npm config</code> command can be used to update and edit the contents of the user and global npmrc files.</p>
- <p>For a list of available configuration options, see <a href="../using-npm/config.html">config</a>.</p>
- <h3 id="files">Files</h3>
- <p>The four relevant files are:</p>
- <ul>
- <li>per-project config file (<code>/path/to/my/project/.npmrc</code>)</li>
- <li>per-user config file (<code>~/.npmrc</code>)</li>
- <li>global config file (<code>$PREFIX/etc/npmrc</code>)</li>
- <li>npm builtin config file (<code>/path/to/npm/npmrc</code>)</li>
- </ul>
- <p>All npm config files are an ini-formatted list of <code>key = value</code> parameters.
- Environment variables can be replaced using <code>${VARIABLE_NAME}</code>.
- By default if the variable is not defined, it is left unreplaced.
- By adding <code>?</code> after variable name they can be forced to evaluate to an empty string instead.
- For example:</p>
- <pre><code class="language-bash">cache = ${HOME}/.npm-packages
- node-options = "${NODE_OPTIONS?} --use-system-ca"
- </code></pre>
- <p>Each of these files is loaded, and config options are resolved in priority order.
- For example, a setting in the userconfig file would override the setting in the globalconfig file.</p>
- <p>Array values are specified by adding "[]" after the key name.
- For example:</p>
- <pre><code class="language-bash">key[] = "first value"
- key[] = "second value"
- </code></pre>
- <h4 id="comments">Comments</h4>
- <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>
- <p>For example:</p>
- <pre><code class="language-bash"># last modified: 01 Jan 2016
- ; Set a new registry for a scoped package
- @myscope:registry=https://mycustomregistry.example.org
- </code></pre>
- <h4 id="per-project-config-file">Per-project config file</h4>
- <p>When working locally in a project, a <code>.npmrc</code> file in the root of the project (ie, a sibling of <code>node_modules</code> and <code>package.json</code>) will set config values specific to this project.</p>
- <p>Note that this only applies to the root of the project that you're running npm in.
- It has no effect when your module is published.
- For example, you can't publish a module that forces itself to install globally, or in a different location.</p>
- <p>Additionally, this file is not read in global mode, such as when running <code>npm install -g</code>.</p>
- <h4 id="per-user-config-file">Per-user config file</h4>
- <p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set in the environment or on the command line)</p>
- <h4 id="global-config-file">Global config file</h4>
- <p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above): This file is an ini-file formatted list of <code>key = value</code> parameters.
- Environment variables can be replaced as above.</p>
- <h4 id="built-in-config-file">Built-in config file</h4>
- <p><code>path/to/npm/itself/npmrc</code></p>
- <p>This is an unchangeable "builtin" configuration file that npm keeps consistent across updates.
- Set fields in here using the <code>./configure</code> script that comes with npm.
- This is primarily for distribution maintainers to override default configs in a standard and consistent manner.</p>
- <h3 id="auth-related-configuration">Auth related configuration</h3>
- <p>The settings <code>_auth</code>, <code>_authToken</code>, <code>username</code>, <code>_password</code>, <code>certfile</code>, and <code>keyfile</code> must all be scoped to a specific registry.
- This ensures that <code>npm</code> will never send credentials to the wrong host.</p>
- <p>The full list is:</p>
- <ul>
- <li><code>_auth</code> (base64 authentication string)</li>
- <li><code>_authToken</code> (authentication token)</li>
- <li><code>username</code></li>
- <li><code>_password</code></li>
- <li><code>email</code></li>
- <li><code>cafile</code> (path to certificate authority file)</li>
- <li><code>certfile</code> (path to certificate file)</li>
- <li><code>keyfile</code> (path to key file)</li>
- </ul>
- <p>In order to scope these values, they must be prefixed by a URI fragment.
- If the credential is meant for any request to a registry on a single host, the scope may look like <code>//registry.npmjs.org/:</code>.
- If it must be scoped to a specific path on the host that path may also be provided, such as
- <code>//my-custom-registry.org/unique/path:</code>.</p>
- <h3 id="unsupported-custom-configuration-keys">Unsupported Custom Configuration Keys</h3>
- <p>Starting in npm v11.2.0, npm warns when unknown configuration keys are defined in <code>.npmrc</code>. In a future major version of npm, these unknown keys may no longer be accepted.</p>
- <p>Only configuration keys that npm officially supports are recognized. Custom keys intended for third-party tools (for example, <code>electron-builder</code>) should not be placed in <code>.npmrc</code>.</p>
- <p>If you need package-level configuration for use in scripts, use the <code>config</code> field in your <code>package.json</code> instead:</p>
- <pre><code class="language-json">{
- "name": "my-package",
- "config": {
- "mirror": "https://example.com/"
- }
- }
- </code></pre>
- <p>Values defined in <code>package.json#config</code> are exposed to scripts as environment variables prefixed with <code>npm_package_config_</code>. For example:</p>
- <pre><code>npm_package_config_mirror
- </code></pre>
- <p>If you need to pass arguments to a script command, use <code>--</code> to separate npm arguments from script arguments:</p>
- <pre><code>npm run build -- --customFlag
- </code></pre>
- <p>Using environment variables is also recommended for cross-platform configuration instead of defining unsupported keys in <code>.npmrc</code>.</p>
- <pre><code>; bad config
- _authToken=MYTOKEN
- ; good config
- @myorg:registry=https://somewhere-else.com/myorg
- @another:registry=https://somewhere-else.com/another
- //registry.npmjs.org/:_authToken=MYTOKEN
- ; would apply to both @myorg and @another
- //somewhere-else.com/:_authToken=MYTOKEN
- ; would apply only to @myorg
- //somewhere-else.com/myorg/:_authToken=MYTOKEN1
- ; would apply only to @another
- //somewhere-else.com/another/:_authToken=MYTOKEN2
- </code></pre>
- <h3 id="custom--third-party-config-keys">Custom / third-party config keys</h3>
- <p>npm only recognizes its own <a href="../using-npm/config.html">configuration options</a>.
- If your <code>.npmrc</code> contains keys that are not part of npm's config definitions
- (for example, <code>electron_mirror</code> or <code>sass_binary_site</code>), npm will emit a
- warning:</p>
- <pre><code>warn Unknown user config "electron_mirror".
- This will stop working in the next major version of npm.
- </code></pre>
- <p>These keys were historically tolerated but are not officially supported.
- A future major version of npm will treat unknown top-level keys as errors.</p>
- <p>Some tools (such as <code>@electron/get</code> or <code>node-sass</code>) read their own
- configuration from environment variables or from <code>.npmrc</code> by convention.
- You can set these values as environment variables instead:</p>
- <pre><code class="language-bash">export ELECTRON_MIRROR="https://mirrorexample.npmjs.org/mirrors/electron/"
- export ELECTRON_CUSTOM_DIR="{{ version }}"
- </code></pre>
- <p>Environment variables are the most portable approach and work regardless
- of <code>.npmrc</code> format.</p>
- <h3 id="see-also">See also</h3>
- <ul>
- <li><a href="../configuring-npm/folders.html">npm folders</a></li>
- <li><a href="../commands/npm-config.html">npm config</a></li>
- <li><a href="../using-npm/config.html">config</a></li>
- <li><a href="../configuring-npm/package-json.html">package.json</a></li>
- <li><a href="../commands/npm.html">npm</a></li>
- </ul></div>
- <footer id="edit">
- <a href="https://github.com/npm/cli/edit/latest/docs/lib/content/configuring-npm/npmrc.md">
- <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
- <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>
- </svg>
- Edit this page on GitHub
- </a>
- </footer>
- </section>
- </body></html>
|