| <!DOCTYPE html><html><head>
|
| <meta charset="utf-8">
|
| <title>Config</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="----config----11121">
|
| <span>Config</span>
|
| <span class="version">@11.12.1</span>
|
| </h1>
|
| <span class="description">About npm configuration</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><ul><li><a href="#command-line-flags">Command Line Flags</a></li><li><a href="#environment-variables">Environment Variables</a></li><li><a href="#npmrc-files">npmrc Files</a></li><li><a href="#default-configs">Default Configs</a></li></ul><li><a href="#shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</a></li><li><a href="#config-settings">Config Settings</a></li><ul><li><a href="#auth"><code>_auth</code></a></li><li><a href="#access"><code>access</code></a></li><li><a href="#all"><code>all</code></a></li><li><a href="#allow-git"><code>allow-git</code></a></li><li><a href="#allow-same-version"><code>allow-same-version</code></a></li><li><a href="#audit"><code>audit</code></a></li><li><a href="#audit-level"><code>audit-level</code></a></li><li><a href="#auth-type"><code>auth-type</code></a></li><li><a href="#before"><code>before</code></a></li><li><a href="#bin-links"><code>bin-links</code></a></li><li><a href="#browser"><code>browser</code></a></li><li><a href="#bypass-2fa"><code>bypass-2fa</code></a></li><li><a href="#ca"><code>ca</code></a></li><li><a href="#cache"><code>cache</code></a></li><li><a href="#cafile"><code>cafile</code></a></li><li><a href="#call"><code>call</code></a></li><li><a href="#cidr"><code>cidr</code></a></li><li><a href="#color"><code>color</code></a></li><li><a href="#commit-hooks"><code>commit-hooks</code></a></li><li><a href="#cpu"><code>cpu</code></a></li><li><a href="#depth"><code>depth</code></a></li><li><a href="#description2"><code>description</code></a></li><li><a href="#diff"><code>diff</code></a></li><li><a href="#diff-dst-prefix"><code>diff-dst-prefix</code></a></li><li><a href="#diff-ignore-all-space"><code>diff-ignore-all-space</code></a></li><li><a href="#diff-name-only"><code>diff-name-only</code></a></li><li><a href="#diff-no-prefix"><code>diff-no-prefix</code></a></li><li><a href="#diff-src-prefix"><code>diff-src-prefix</code></a></li><li><a href="#diff-text"><code>diff-text</code></a></li><li><a href="#diff-unified"><code>diff-unified</code></a></li><li><a href="#dry-run"><code>dry-run</code></a></li><li><a href="#editor"><code>editor</code></a></li><li><a href="#engine-strict"><code>engine-strict</code></a></li><li><a href="#expect-result-count"><code>expect-result-count</code></a></li><li><a href="#expect-results"><code>expect-results</code></a></li><li><a href="#expires"><code>expires</code></a></li><li><a href="#fetch-retries"><code>fetch-retries</code></a></li><li><a href="#fetch-retry-factor"><code>fetch-retry-factor</code></a></li><li><a href="#fetch-retry-maxtimeout"><code>fetch-retry-maxtimeout</code></a></li><li><a href="#fetch-retry-mintimeout"><code>fetch-retry-mintimeout</code></a></li><li><a href="#fetch-timeout"><code>fetch-timeout</code></a></li><li><a href="#force"><code>force</code></a></li><li><a href="#foreground-scripts"><code>foreground-scripts</code></a></li><li><a href="#format-package-lock"><code>format-package-lock</code></a></li><li><a href="#fund"><code>fund</code></a></li><li><a href="#git"><code>git</code></a></li><li><a href="#git-tag-version"><code>git-tag-version</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#globalconfig"><code>globalconfig</code></a></li><li><a href="#heading"><code>heading</code></a></li><li><a href="#https-proxy"><code>https-proxy</code></a></li><li><a href="#if-present"><code>if-present</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li><li><a href="#include"><code>include</code></a></li><li><a href="#include-attestations"><code>include-attestations</code></a></li><li><a href="#include-staged"><code>include-staged</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#init-author-email"><code>init-author-email</code></a></li><li><a href="#init-author-name"><code>init-author-name</code></a></li><li><a href="#init-author-url"><code>init-author-url</code></a></li><li><a href="#init-license"><code>init-license</code></a></li><li><a href="#init-module"><code>init-module</code></a></li><li><a href="#init-private"><code>init-private</code></a></li><li><a href="#init-type"><code>init-type</code></a></li><li><a href="#init-version"><code>init-version</code></a></li><li><a href="#install-links"><code>install-links</code></a></li><li><a href="#install-strategy"><code>install-strategy</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#legacy-peer-deps"><code>legacy-peer-deps</code></a></li><li><a href="#libc"><code>libc</code></a></li><li><a href="#link"><code>link</code></a></li><li><a href="#local-address"><code>local-address</code></a></li><li><a href="#location"><code>location</code></a></li><li><a href="#lockfile-version"><code>lockfile-version</code></a></li><li><a href="#loglevel"><code>loglevel</code></a></li><li><a href="#logs-dir"><code>logs-dir</code></a></li><li><a href="#logs-max"><code>logs-max</code></a></li><li><a href="#long"><code>long</code></a></li><li><a href="#maxsockets"><code>maxsockets</code></a></li><li><a href="#message"><code>message</code></a></li><li><a href="#min-release-age"><code>min-release-age</code></a></li><li><a href="#name"><code>name</code></a></li><li><a href="#node-gyp"><code>node-gyp</code></a></li><li><a href="#node-options"><code>node-options</code></a></li><li><a href="#noproxy"><code>noproxy</code></a></li><li><a href="#offline"><code>offline</code></a></li><li><a href="#omit"><code>omit</code></a></li><li><a href="#omit-lockfile-registry-resolved"><code>omit-lockfile-registry-resolved</code></a></li><li><a href="#orgs"><code>orgs</code></a></li><li><a href="#orgs-permission"><code>orgs-permission</code></a></li><li><a href="#os"><code>os</code></a></li><li><a href="#otp"><code>otp</code></a></li><li><a href="#pack-destination"><code>pack-destination</code></a></li><li><a href="#package"><code>package</code></a></li><li><a href="#package-lock"><code>package-lock</code></a></li><li><a href="#package-lock-only"><code>package-lock-only</code></a></li><li><a href="#packages"><code>packages</code></a></li><li><a href="#packages-all"><code>packages-all</code></a></li><li><a href="#packages-and-scopes-permission"><code>packages-and-scopes-permission</code></a></li><li><a href="#parseable"><code>parseable</code></a></li><li><a href="#password"><code>password</code></a></li><li><a href="#prefer-dedupe"><code>prefer-dedupe</code></a></li><li><a href="#prefer-offline"><code>prefer-offline</code></a></li><li><a href="#prefer-online"><code>prefer-online</code></a></li><li><a href="#prefix"><code>prefix</code></a></li><li><a href="#preid"><code>preid</code></a></li><li><a href="#progress"><code>progress</code></a></li><li><a href="#provenance"><code>provenance</code></a></li><li><a href="#provenance-file"><code>provenance-file</code></a></li><li><a href="#proxy"><code>proxy</code></a></li><li><a href="#read-only"><code>read-only</code></a></li><li><a href="#rebuild-bundle"><code>rebuild-bundle</code></a></li><li><a href="#registry"><code>registry</code></a></li><li><a href="#replace-registry-host"><code>replace-registry-host</code></a></li><li><a href="#save"><code>save</code></a></li><li><a href="#save-bundle"><code>save-bundle</code></a></li><li><a href="#save-dev"><code>save-dev</code></a></li><li><a href="#save-exact"><code>save-exact</code></a></li><li><a href="#save-optional"><code>save-optional</code></a></li><li><a href="#save-peer"><code>save-peer</code></a></li><li><a href="#save-prefix"><code>save-prefix</code></a></li><li><a href="#save-prod"><code>save-prod</code></a></li><li><a href="#sbom-format"><code>sbom-format</code></a></li><li><a href="#sbom-type"><code>sbom-type</code></a></li><li><a href="#scope"><code>scope</code></a></li><li><a href="#scopes"><code>scopes</code></a></li><li><a href="#script-shell"><code>script-shell</code></a></li><li><a href="#searchexclude"><code>searchexclude</code></a></li><li><a href="#searchlimit"><code>searchlimit</code></a></li><li><a href="#searchopts"><code>searchopts</code></a></li><li><a href="#searchstaleness"><code>searchstaleness</code></a></li><li><a href="#shell"><code>shell</code></a></li><li><a href="#sign-git-commit"><code>sign-git-commit</code></a></li><li><a href="#sign-git-tag"><code>sign-git-tag</code></a></li><li><a href="#strict-peer-deps"><code>strict-peer-deps</code></a></li><li><a href="#strict-ssl"><code>strict-ssl</code></a></li><li><a href="#tag"><code>tag</code></a></li><li><a href="#tag-version-prefix"><code>tag-version-prefix</code></a></li><li><a href="#timing"><code>timing</code></a></li><li><a href="#token-description"><code>token-description</code></a></li><li><a href="#umask"><code>umask</code></a></li><li><a href="#unicode"><code>unicode</code></a></li><li><a href="#update-notifier"><code>update-notifier</code></a></li><li><a href="#usage"><code>usage</code></a></li><li><a href="#user-agent"><code>user-agent</code></a></li><li><a href="#userconfig"><code>userconfig</code></a></li><li><a href="#version"><code>version</code></a></li><li><a href="#versions"><code>versions</code></a></li><li><a href="#viewer"><code>viewer</code></a></li><li><a href="#which"><code>which</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#workspaces-update"><code>workspaces-update</code></a></li><li><a href="#yes"><code>yes</code></a></li><li><a href="#also"><code>also</code></a></li><li><a href="#cache-max"><code>cache-max</code></a></li><li><a href="#cache-min"><code>cache-min</code></a></li><li><a href="#cert"><code>cert</code></a></li><li><a href="#dev"><code>dev</code></a></li><li><a href="#global-style"><code>global-style</code></a></li><li><a href="#initauthoremail"><code>init.author.email</code></a></li><li><a href="#initauthorname"><code>init.author.name</code></a></li><li><a href="#initauthorurl"><code>init.author.url</code></a></li><li><a href="#initlicense"><code>init.license</code></a></li><li><a href="#initmodule"><code>init.module</code></a></li><li><a href="#initversion"><code>init.version</code></a></li><li><a href="#key"><code>key</code></a></li><li><a href="#legacy-bundling"><code>legacy-bundling</code></a></li><li><a href="#only"><code>only</code></a></li><li><a href="#optional"><code>optional</code></a></li><li><a href="#production"><code>production</code></a></li><li><a href="#shrinkwrap"><code>shrinkwrap</code></a></li></ul><li><a href="#see-also">See also</a></li></ul></div>
|
| </section>
|
|
|
| <div id="_content"><h3 id="description">Description</h3>
|
| <p>This article details npm configuration in general.
|
| To learn about the <code>config</code> command, see <a href="../commands/npm-config.html"><code>npm config</code></a>.</p>
|
| <p>npm gets its configuration values from the following sources, sorted by priority:</p>
|
| <h4 id="command-line-flags">Command Line Flags</h4>
|
| <p>Putting <code>--foo bar</code> on the command line sets the <code>foo</code> configuration parameter to <code>"bar"</code>.
|
| A <code>--</code> argument tells the cli parser to stop reading flags.
|
| Using <code>--flag</code> without specifying any value will set the value to <code>true</code>.</p>
|
| <p>Example: <code>--flag1 --flag2</code> will set both configuration parameters to <code>true</code>, while <code>--flag1 --flag2 bar</code> will set <code>flag1</code> to <code>true</code>, and <code>flag2</code> to <code>bar</code>.
|
| Finally, <code>--flag1 --flag2 -- bar</code> will set both configuration parameters to <code>true</code>, and the <code>bar</code> is taken as a command argument.</p>
|
| <p><strong>Common examples:</strong></p>
|
| <ul>
|
| <li><code>npm install --prefix /path/to/dir</code> - Runs npm commands in a different directory without changing the current working directory</li>
|
| <li><code>npm install --global</code> - Installs packages globally (shorthand: <code>-g</code>)</li>
|
| <li><code>npm install --save-dev</code> - Saves to devDependencies (shorthand: <code>-D</code>)</li>
|
| </ul>
|
| <p>Any configuration option documented in the <a href="#config-settings">Config Settings</a> section below can be set via command line flags using <code>--option-name value</code> syntax.</p>
|
| <h4 id="environment-variables">Environment Variables</h4>
|
| <p>Any environment variables that start with <code>npm_config_</code> will be interpreted as a configuration parameter.
|
| For example, putting <code>npm_config_foo=bar</code> in your environment will set the <code>foo</code> configuration parameter to <code>bar</code>.
|
| Any environment configurations that are not given a value will be given the value of <code>true</code>.
|
| Config values are case-insensitive, so <code>NPM_CONFIG_FOO=bar</code> will work the same.
|
| However, please note that inside <a href="../using-npm/scripts.html"><code>scripts</code></a> npm will set its own environment variables and Node will prefer those lowercase versions over any uppercase ones that you might set.
|
| For details see <a href="https://github.com/npm/npm/issues/14528">this issue</a>.</p>
|
| <p>Notice that you need to use underscores instead of dashes, so <code>--allow-same-version</code> would become <code>npm_config_allow_same_version=true</code>.</p>
|
| <p><strong>Important:</strong> When defining custom configuration keys in <code>.npmrc</code> files, use hyphens instead of underscores (e.g., <code>custom-key=value</code>). This ensures they can be overridden by environment variables, since npm automatically converts underscores to hyphens when reading environment variables. Keys with underscores in <code>.npmrc</code> files cannot be overridden via environment variables.</p>
|
| <h4 id="npmrc-files">npmrc Files</h4>
|
| <p>The four relevant files are:</p>
|
| <ul>
|
| <li>per-project configuration file (<code>/path/to/my/project/.npmrc</code>)</li>
|
| <li>per-user configuration file (defaults to <code>$HOME/.npmrc</code>; configurable via CLI option <code>--userconfig</code> or environment variable <code>$NPM_CONFIG_USERCONFIG</code>)</li>
|
| <li>global configuration file (defaults to <code>$PREFIX/etc/npmrc</code>; configurable via CLI option <code>--globalconfig</code> or environment variable <code>$NPM_CONFIG_GLOBALCONFIG</code>)</li>
|
| <li>npm's built-in configuration file (<code>/path/to/npm/npmrc</code>)</li>
|
| </ul>
|
| <p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more details.</p>
|
| <h4 id="default-configs">Default Configs</h4>
|
| <p>Run <code>npm config ls -l</code> to see a set of configuration parameters that are internal to npm, and are defaults if nothing else is specified.</p>
|
| <h3 id="shorthands-and-other-cli-niceties">Shorthands and Other CLI Niceties</h3>
|
| <p>The following shorthands are parsed on the command-line:</p>
|
| <ul>
|
| <li><code>-a</code>: <code>--all</code></li>
|
| <li><code>--enjoy-by</code>: <code>--before</code></li>
|
| <li><code>-c</code>: <code>--call</code></li>
|
| <li><code>--desc</code>: <code>--description</code></li>
|
| <li><code>-f</code>: <code>--force</code></li>
|
| <li><code>-g</code>: <code>--global</code></li>
|
| <li><code>--iwr</code>: <code>--include-workspace-root</code></li>
|
| <li><code>-L</code>: <code>--location</code></li>
|
| <li><code>-d</code>: <code>--loglevel info</code></li>
|
| <li><code>-s</code>: <code>--loglevel silent</code></li>
|
| <li><code>--silent</code>: <code>--loglevel silent</code></li>
|
| <li><code>--ddd</code>: <code>--loglevel silly</code></li>
|
| <li><code>--dd</code>: <code>--loglevel verbose</code></li>
|
| <li><code>--verbose</code>: <code>--loglevel verbose</code></li>
|
| <li><code>-q</code>: <code>--loglevel warn</code></li>
|
| <li><code>--quiet</code>: <code>--loglevel warn</code></li>
|
| <li><code>-l</code>: <code>--long</code></li>
|
| <li><code>-m</code>: <code>--message</code></li>
|
| <li><code>--local</code>: <code>--no-global</code></li>
|
| <li><code>-n</code>: <code>--no-yes</code></li>
|
| <li><code>--no</code>: <code>--no-yes</code></li>
|
| <li><code>-p</code>: <code>--parseable</code></li>
|
| <li><code>--porcelain</code>: <code>--parseable</code></li>
|
| <li><code>-C</code>: <code>--prefix</code></li>
|
| <li><code>--readonly</code>: <code>--read-only</code></li>
|
| <li><code>--reg</code>: <code>--registry</code></li>
|
| <li><code>-S</code>: <code>--save</code></li>
|
| <li><code>-B</code>: <code>--save-bundle</code></li>
|
| <li><code>-D</code>: <code>--save-dev</code></li>
|
| <li><code>-E</code>: <code>--save-exact</code></li>
|
| <li><code>-O</code>: <code>--save-optional</code></li>
|
| <li><code>-P</code>: <code>--save-prod</code></li>
|
| <li><code>-?</code>: <code>--usage</code></li>
|
| <li><code>-h</code>: <code>--usage</code></li>
|
| <li><code>-H</code>: <code>--usage</code></li>
|
| <li><code>--help</code>: <code>--usage</code></li>
|
| <li><code>-v</code>: <code>--version</code></li>
|
| <li><code>-w</code>: <code>--workspace</code></li>
|
| <li><code>--ws</code>: <code>--workspaces</code></li>
|
| <li><code>-y</code>: <code>--yes</code></li>
|
| </ul>
|
| <p>If the specified configuration param resolves unambiguously to a known configuration parameter, then it is expanded to that configuration parameter.
|
| For example:</p>
|
| <pre><code class="language-bash">npm ls --par
|
| # same as:
|
| npm ls --parseable
|
| </code></pre>
|
| <p>If multiple single-character shorthands are strung together, and the resulting combination is unambiguously not some other configuration param, then it is expanded to its various component pieces.
|
| For example:</p>
|
| <pre><code class="language-bash">npm ls -gpld
|
| # same as:
|
| npm ls --global --parseable --long --loglevel info
|
| </code></pre>
|
| <h3 id="config-settings">Config Settings</h3>
|
| <h4 id="auth"><code>_auth</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>A basic-auth string to use when authenticating against the npm registry.
|
| This will ONLY be used to authenticate against the npm registry. For other
|
| registries you will need to scope it like "//other-registry.tld/:_auth"</p>
|
| <p>Warning: This should generally not be set via a command-line option. It is
|
| safer to use a registry-provided authentication bearer token stored in the
|
| ~/.npmrc file by running <code>npm login</code>.</p>
|
| <h4 id="access"><code>access</code></h4>
|
| <ul>
|
| <li>Default: 'public' for new packages, existing packages it will not change the
|
| current level</li>
|
| <li>Type: null, "restricted", or "public"</li>
|
| </ul>
|
| <p>If you do not want your scoped package to be publicly viewable (and
|
| installable) set <code>--access=restricted</code>.</p>
|
| <p>Unscoped packages cannot be set to <code>restricted</code>.</p>
|
| <p>Note: This defaults to not changing the current access level for existing
|
| packages. Specifying a value of <code>restricted</code> or <code>public</code> during publish will
|
| change the access for an existing package the same way that <code>npm access set status</code> would.</p>
|
| <h4 id="all"><code>all</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When running <code>npm outdated</code> and <code>npm ls</code>, setting <code>--all</code> will show all
|
| outdated or installed packages, rather than only those directly depended
|
| upon by the current project.</p>
|
| <h4 id="allow-git"><code>allow-git</code></h4>
|
| <ul>
|
| <li>Default: "all"</li>
|
| <li>Type: "all", "none", or "root"</li>
|
| </ul>
|
| <p>Limits the ability for npm to fetch dependencies from git references. That
|
| is, dependencies that point to a git repo instead of a version or semver
|
| range. Please note that this could leave your tree incomplete and some
|
| packages may not function as intended or designed.</p>
|
| <p><code>all</code> allows any git dependencies to be fetched and installed. <code>none</code>
|
| prevents any git dependencies from being fetched and installed. <code>root</code> only
|
| allows git dependencies defined in your project's package.json to be fetched
|
| installed. Also allows git dependencies to be fetched for other commands
|
| like <code>npm view</code></p>
|
| <h4 id="allow-same-version"><code>allow-same-version</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Prevents throwing an error when <code>npm version</code> is used to set the new version
|
| to the same value as the current version.</p>
|
| <h4 id="audit"><code>audit</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When "true" submit audit reports alongside the current npm command to the
|
| default registry and all registries configured for scopes. See the
|
| documentation for <a href="../commands/npm-audit.html"><code>npm audit</code></a> for details on what is
|
| submitted.</p>
|
| <h4 id="audit-level"><code>audit-level</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, "info", "low", "moderate", "high", "critical", or "none"</li>
|
| </ul>
|
| <p>The minimum level of vulnerability for <code>npm audit</code> to exit with a non-zero
|
| exit code.</p>
|
| <h4 id="auth-type"><code>auth-type</code></h4>
|
| <ul>
|
| <li>Default: "web"</li>
|
| <li>Type: "legacy" or "web"</li>
|
| </ul>
|
| <p>What authentication strategy to use with <code>login</code>. Note that if an <code>otp</code>
|
| config is given, this value will always be set to <code>legacy</code>.</p>
|
| <h4 id="before"><code>before</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Date</li>
|
| </ul>
|
| <p>If passed to <code>npm install</code>, will rebuild the npm tree such that only
|
| versions that were available <strong>on or before</strong> the given date are installed.
|
| If there are no versions available for the current set of dependencies, the
|
| command will error.</p>
|
| <p>If the requested version is a <code>dist-tag</code> and the given tag does not pass the
|
| <code>--before</code> filter, the most recent version less than or equal to that tag
|
| will be used. For example, <code>foo@latest</code> might install <code>foo@1.2</code> even though
|
| <code>latest</code> is <code>2.0</code>.</p>
|
| <p>This config cannot be used with: <code>min-release-age</code></p>
|
| <h4 id="bin-links"><code>bin-links</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Tells npm to create symlinks (or <code>.cmd</code> shims on Windows) for package
|
| executables.</p>
|
| <p>Set to false to have it not do this. This can be used to work around the
|
| fact that some file systems don't support symlinks, even on ostensibly Unix
|
| systems.</p>
|
| <h4 id="browser"><code>browser</code></h4>
|
| <ul>
|
| <li>Default: macOS: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
| <li>Type: null, Boolean, or String</li>
|
| </ul>
|
| <p>The browser that is called by npm commands to open websites.</p>
|
| <p>Set to <code>false</code> to suppress browser behavior and instead print urls to
|
| terminal.</p>
|
| <p>Set to <code>true</code> to use default system URL opener.</p>
|
| <h4 id="bypass-2fa"><code>bypass-2fa</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, setting this
|
| to true will allow the token to bypass two-factor authentication. This is
|
| useful for automation and CI/CD workflows.</p>
|
| <h4 id="ca"><code>ca</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String (can be set multiple times)</li>
|
| </ul>
|
| <p>The Certificate Authority signing certificate that is trusted for SSL
|
| connections to the registry. Values should be in PEM format (Windows calls
|
| it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string
|
| "\n". For example:</p>
|
| <pre><code class="language-ini">ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
|
| </code></pre>
|
| <p>Set to <code>null</code> to only allow "known" registrars, or to a specific CA cert to
|
| trust only that specific signing authority.</p>
|
| <p>Multiple CAs can be trusted by specifying an array of certificates:</p>
|
| <pre><code class="language-ini">ca[]="..."
|
| ca[]="..."
|
| </code></pre>
|
| <p>See also the <code>strict-ssl</code> config.</p>
|
| <h4 id="cache"><code>cache</code></h4>
|
| <ul>
|
| <li>Default: Windows: <code>%LocalAppData%\npm-cache</code>, Posix: <code>~/.npm</code></li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>The location of npm's cache directory.</p>
|
| <h4 id="cafile"><code>cafile</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>A path to a file containing one or multiple Certificate Authority signing
|
| certificates. Similar to the <code>ca</code> setting, but allows for multiple CA's, as
|
| well as for the CA information to be stored in a file on disk.</p>
|
| <h4 id="call"><code>call</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Optional companion option for <code>npm exec</code>, <code>npx</code> that allows for specifying a
|
| custom command to be run along with the installed packages.</p>
|
| <pre><code class="language-bash">npm exec --package yo --package generator-node --call "yo node"
|
| </code></pre>
|
| <h4 id="cidr"><code>cidr</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String (can be set multiple times)</li>
|
| </ul>
|
| <p>This is a list of CIDR address to be used when configuring limited access
|
| tokens with the <code>npm token create</code> command.</p>
|
| <h4 id="color"><code>color</code></h4>
|
| <ul>
|
| <li>Default: true unless the NO_COLOR environ is set to something other than '0'</li>
|
| <li>Type: "always" or Boolean</li>
|
| </ul>
|
| <p>If false, never shows colors. If <code>"always"</code> then always shows colors. If
|
| true, then only prints color codes for tty file descriptors.</p>
|
| <h4 id="commit-hooks"><code>commit-hooks</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Run git commit hooks when using the <code>npm version</code> command.</p>
|
| <h4 id="cpu"><code>cpu</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Override CPU architecture of native modules to install. Acceptable values
|
| are same as <code>cpu</code> field of package.json, which comes from <code>process.arch</code>.</p>
|
| <h4 id="depth"><code>depth</code></h4>
|
| <ul>
|
| <li>Default: <code>Infinity</code> if <code>--all</code> is set; otherwise, <code>0</code></li>
|
| <li>Type: null or Number</li>
|
| </ul>
|
| <p>The depth to go when recursing packages for <code>npm ls</code>.</p>
|
| <p>If not set, <code>npm ls</code> will show only the immediate dependencies of the root
|
| project. If <code>--all</code> is set, then npm will show all dependencies by default.</p>
|
| <h4 id="description2"><code>description</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Show the description in <code>npm search</code></p>
|
| <h4 id="diff"><code>diff</code></h4>
|
| <ul>
|
| <li>Default:</li>
|
| <li>Type: String (can be set multiple times)</li>
|
| </ul>
|
| <p>Define arguments to compare in <code>npm diff</code>.</p>
|
| <h4 id="diff-dst-prefix"><code>diff-dst-prefix</code></h4>
|
| <ul>
|
| <li>Default: "b/"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Destination prefix to be used in <code>npm diff</code> output.</p>
|
| <h4 id="diff-ignore-all-space"><code>diff-ignore-all-space</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Ignore whitespace when comparing lines in <code>npm diff</code>.</p>
|
| <h4 id="diff-name-only"><code>diff-name-only</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Prints only filenames when using <code>npm diff</code>.</p>
|
| <h4 id="diff-no-prefix"><code>diff-no-prefix</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Do not show any source or destination prefix in <code>npm diff</code> output.</p>
|
| <p>Note: this causes <code>npm diff</code> to ignore the <code>--diff-src-prefix</code> and
|
| <code>--diff-dst-prefix</code> configs.</p>
|
| <h4 id="diff-src-prefix"><code>diff-src-prefix</code></h4>
|
| <ul>
|
| <li>Default: "a/"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Source prefix to be used in <code>npm diff</code> output.</p>
|
| <h4 id="diff-text"><code>diff-text</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Treat all files as text in <code>npm diff</code>.</p>
|
| <h4 id="diff-unified"><code>diff-unified</code></h4>
|
| <ul>
|
| <li>Default: 3</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The number of lines of context to print in <code>npm diff</code>.</p>
|
| <h4 id="dry-run"><code>dry-run</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Indicates that you don't want npm to make any changes and that it should
|
| only report what it would have done. This can be passed into any of the
|
| commands that modify your local installation, eg, <code>install</code>, <code>update</code>,
|
| <code>dedupe</code>, <code>uninstall</code>, as well as <code>pack</code> and <code>publish</code>.</p>
|
| <p>Note: This is NOT honored by other network related commands, eg <code>dist-tags</code>,
|
| <code>owner</code>, etc.</p>
|
| <h4 id="editor"><code>editor</code></h4>
|
| <ul>
|
| <li>Default: The EDITOR or VISUAL environment variables, or
|
| '%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
|
| <h4 id="engine-strict"><code>engine-strict</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to true, then npm will stubbornly refuse to install (or even consider
|
| installing) any package that claims to not be compatible with the current
|
| Node.js version.</p>
|
| <p>This can be overridden by setting the <code>--force</code> flag.</p>
|
| <h4 id="expect-result-count"><code>expect-result-count</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Number</li>
|
| </ul>
|
| <p>Tells to expect a specific number of results from the command.</p>
|
| <p>This config cannot be used with: <code>expect-results</code></p>
|
| <h4 id="expect-results"><code>expect-results</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Boolean</li>
|
| </ul>
|
| <p>Tells npm whether or not to expect results from the command. Can be either
|
| true (expect some results) or false (expect no results).</p>
|
| <p>This config cannot be used with: <code>expect-result-count</code></p>
|
| <h4 id="expires"><code>expires</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Number</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, this sets the
|
| expiration in days. If not specified, the server will determine the default
|
| expiration.</p>
|
| <h4 id="fetch-retries"><code>fetch-retries</code></h4>
|
| <ul>
|
| <li>Default: 2</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The "retries" config for the <code>retry</code> module to use when fetching packages
|
| from the registry.</p>
|
| <p>npm will retry idempotent read requests to the registry in the case of
|
| network failures or 5xx HTTP errors.</p>
|
| <h4 id="fetch-retry-factor"><code>fetch-retry-factor</code></h4>
|
| <ul>
|
| <li>Default: 10</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The "factor" config for the <code>retry</code> module to use when fetching packages.</p>
|
| <h4 id="fetch-retry-maxtimeout"><code>fetch-retry-maxtimeout</code></h4>
|
| <ul>
|
| <li>Default: 60000 (1 minute)</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The "maxTimeout" config for the <code>retry</code> module to use when fetching
|
| packages.</p>
|
| <h4 id="fetch-retry-mintimeout"><code>fetch-retry-mintimeout</code></h4>
|
| <ul>
|
| <li>Default: 10000 (10 seconds)</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The "minTimeout" config for the <code>retry</code> module to use when fetching
|
| packages.</p>
|
| <h4 id="fetch-timeout"><code>fetch-timeout</code></h4>
|
| <ul>
|
| <li>Default: 300000 (5 minutes)</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The maximum amount of time to wait for HTTP requests to complete.</p>
|
| <h4 id="force"><code>force</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Removes various protections against unfortunate side effects, common
|
| mistakes, unnecessary performance degradation, and malicious input.</p>
|
| <ul>
|
| <li>Allow clobbering non-npm files in global installs.</li>
|
| <li>Allow the <code>npm version</code> command to work on an unclean git repository.</li>
|
| <li>Allow deleting the cache folder with <code>npm cache clean</code>.</li>
|
| <li>Allow installing packages that have an <code>engines</code> declaration requiring a
|
| different version of npm.</li>
|
| <li>Allow installing packages that have an <code>engines</code> declaration requiring a
|
| different version of <code>node</code>, even if <code>--engine-strict</code> is enabled.</li>
|
| <li>Allow <code>npm audit fix</code> to install modules outside your stated dependency
|
| range (including SemVer-major changes).</li>
|
| <li>Allow unpublishing all versions of a published package.</li>
|
| <li>Allow conflicting peerDependencies to be installed in the root project.</li>
|
| <li>Implicitly set <code>--yes</code> during <code>npm init</code>.</li>
|
| <li>Allow clobbering existing values in <code>npm pkg</code></li>
|
| <li>Allow unpublishing of entire packages (not just a single version).</li>
|
| </ul>
|
| <p>If you don't have a clear idea of what you want to do, it is strongly
|
| recommended that you do not use this option!</p>
|
| <h4 id="foreground-scripts"><code>foreground-scripts</code></h4>
|
| <ul>
|
| <li>Default: <code>false</code> unless when using <code>npm pack</code> or <code>npm publish</code> where it
|
| defaults to <code>true</code></li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Run all build scripts (ie, <code>preinstall</code>, <code>install</code>, and <code>postinstall</code>)
|
| scripts for installed packages in the foreground process, sharing standard
|
| input, output, and error with the main npm process.</p>
|
| <p>Note that this will generally make installs run slower, and be much noisier,
|
| but can be useful for debugging.</p>
|
| <h4 id="format-package-lock"><code>format-package-lock</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Format <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> as a human readable
|
| file.</p>
|
| <h4 id="fund"><code>fund</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When "true" displays the message at the end of each <code>npm install</code>
|
| acknowledging the number of dependencies looking for funding. See <a href="../commands/npm-fund.html"><code>npm fund</code></a> for details.</p>
|
| <h4 id="git"><code>git</code></h4>
|
| <ul>
|
| <li>Default: "git"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The command to use for git commands. If git is installed on the computer,
|
| but is not in the <code>PATH</code>, then set this to the full path to the git binary.</p>
|
| <h4 id="git-tag-version"><code>git-tag-version</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Tag the commit when using the <code>npm version</code> command. Setting this to false
|
| results in no commit being made at all.</p>
|
| <h4 id="global"><code>global</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
|
| folder instead of the current working directory. See
|
| <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
|
| <ul>
|
| <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
|
| of the current working directory.</li>
|
| <li>bin files are linked to <code>{prefix}/bin</code></li>
|
| <li>man pages are linked to <code>{prefix}/share/man</code></li>
|
| </ul>
|
| <h4 id="globalconfig"><code>globalconfig</code></h4>
|
| <ul>
|
| <li>Default: The global --prefix setting plus 'etc/npmrc'. For example,
|
| '/usr/local/etc/npmrc'</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>The config file to read for global config options.</p>
|
| <h4 id="heading"><code>heading</code></h4>
|
| <ul>
|
| <li>Default: "npm"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The string that starts all the debugging log output.</p>
|
| <h4 id="https-proxy"><code>https-proxy</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or URL</li>
|
| </ul>
|
| <p>A proxy to use for outgoing https requests. If the <code>HTTPS_PROXY</code> or
|
| <code>https_proxy</code> or <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variables are set,
|
| proxy settings will be honored by the underlying <code>make-fetch-happen</code>
|
| library.</p>
|
| <h4 id="if-present"><code>if-present</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, npm will not exit with an error code when <code>run</code> is invoked for a
|
| script that isn't defined in the <code>scripts</code> section of <code>package.json</code>. This
|
| option can be used when it's desirable to optionally run a script when it's
|
| present and fail if the script fails. This is useful, for example, when
|
| running scripts that may only apply for some builds in an otherwise generic
|
| CI setup.</p>
|
| <p>This value is not exported to the environment for child processes.</p>
|
| <h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, npm does not run scripts specified in package.json files.</p>
|
| <p>Note that commands explicitly intended to run a particular script, such as
|
| <code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
|
| run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
|
| run any pre- or post-scripts.</p>
|
| <h4 id="include"><code>include</code></h4>
|
| <ul>
|
| <li>Default:</li>
|
| <li>Type: "prod", "dev", "optional", or "peer" (can be set multiple times)</li>
|
| </ul>
|
| <p>Option that allows for defining which types of dependencies to install.</p>
|
| <p>This is the inverse of <code>--omit=<type></code>.</p>
|
| <p>Dependency types specified in <code>--include</code> will not be omitted, regardless of
|
| the order in which omit/include are specified on the command-line.</p>
|
| <h4 id="include-attestations"><code>include-attestations</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When used with <code>npm audit signatures --json</code>, includes the full sigstore
|
| attestation bundles in the JSON output for each verified package. The
|
| bundles contain DSSE envelopes, verification material, and transparency log
|
| entries.</p>
|
| <h4 id="include-staged"><code>include-staged</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Allow installing "staged" published packages, as defined by <a href="https://github.com/npm/rfcs/pull/92">npm RFC PR
|
| #92</a>.</p>
|
| <p>This is experimental, and not implemented by the npm public registry.</p>
|
| <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Include the workspace root when workspaces are enabled for a command.</p>
|
| <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
|
| all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
|
| the specified workspaces, and not on the root project.</p>
|
| <p>This value is not exported to the environment for child processes.</p>
|
| <h4 id="init-author-email"><code>init-author-email</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The value <code>npm init</code> should use by default for the package author's email.</p>
|
| <h4 id="init-author-name"><code>init-author-name</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The value <code>npm init</code> should use by default for the package author's name.</p>
|
| <h4 id="init-author-url"><code>init-author-url</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: "" or URL</li>
|
| </ul>
|
| <p>The value <code>npm init</code> should use by default for the package author's
|
| homepage.</p>
|
| <h4 id="init-license"><code>init-license</code></h4>
|
| <ul>
|
| <li>Default: "ISC"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The value <code>npm init</code> should use by default for the package license.</p>
|
| <h4 id="init-module"><code>init-module</code></h4>
|
| <ul>
|
| <li>Default: "~/.npm-init.js"</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>A module that will be loaded by the <code>npm init</code> command. See the
|
| documentation for the
|
| <a href="https://github.com/npm/init-package-json">init-package-json</a> module for
|
| more information, or <a href="../commands/npm-init.html">npm init</a>.</p>
|
| <h4 id="init-private"><code>init-private</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>The value <code>npm init</code> should use by default for the package's private flag.</p>
|
| <h4 id="init-type"><code>init-type</code></h4>
|
| <ul>
|
| <li>Default: "commonjs"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The value that <code>npm init</code> should use by default for the package.json type
|
| field.</p>
|
| <h4 id="init-version"><code>init-version</code></h4>
|
| <ul>
|
| <li>Default: "1.0.0"</li>
|
| <li>Type: SemVer string</li>
|
| </ul>
|
| <p>The value that <code>npm init</code> should use by default for the package version
|
| number, if not already set in package.json.</p>
|
| <h4 id="install-links"><code>install-links</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When set file: protocol dependencies will be packed and installed as regular
|
| dependencies instead of creating a symlink. This option has no effect on
|
| workspaces.</p>
|
| <h4 id="install-strategy"><code>install-strategy</code></h4>
|
| <ul>
|
| <li>Default: "hoisted"</li>
|
| <li>Type: "hoisted", "nested", "shallow", or "linked"</li>
|
| </ul>
|
| <p>Sets the strategy for installing packages in node_modules. hoisted
|
| (default): Install non-duplicated in top-level, and duplicated as necessary
|
| within directory structure. nested: (formerly --legacy-bundling) install in
|
| place, no hoisting. shallow (formerly --global-style) only install direct
|
| deps at top-level. linked: (experimental) install in node_modules/.store,
|
| link in place, unhoisted.</p>
|
| <h4 id="json"><code>json</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Whether or not to output JSON data, rather than the normal output.</p>
|
| <ul>
|
| <li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
|
| saving them to your <code>package.json</code>.</li>
|
| </ul>
|
| <p>Not supported by all npm commands.</p>
|
| <h4 id="legacy-peer-deps"><code>legacy-peer-deps</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Causes npm to completely ignore <code>peerDependencies</code> when building a package
|
| tree, as in npm versions 3 through 6.</p>
|
| <p>If a package cannot be installed because of overly strict <code>peerDependencies</code>
|
| that collide, it provides a way to move forward resolving the situation.</p>
|
| <p>This differs from <code>--omit=peer</code>, in that <code>--omit=peer</code> will avoid unpacking
|
| <code>peerDependencies</code> on disk, but will still design a tree such that
|
| <code>peerDependencies</code> <em>could</em> be unpacked in a correct place.</p>
|
| <p>Use of <code>legacy-peer-deps</code> is not recommended, as it will not enforce the
|
| <code>peerDependencies</code> contract that meta-dependencies may rely on.</p>
|
| <h4 id="libc"><code>libc</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Override libc of native modules to install. Acceptable values are same as
|
| <code>libc</code> field of package.json</p>
|
| <h4 id="link"><code>link</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Used with <code>npm ls</code>, limiting output to only those packages that are linked.</p>
|
| <h4 id="local-address"><code>local-address</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: IP Address</li>
|
| </ul>
|
| <p>The IP address of the local interface to use when making connections to the
|
| npm registry. Must be IPv4 in versions of Node prior to 0.12.</p>
|
| <h4 id="location"><code>location</code></h4>
|
| <ul>
|
| <li>Default: "user" unless <code>--global</code> is passed, which will also set this value
|
| to "global"</li>
|
| <li>Type: "global", "user", or "project"</li>
|
| </ul>
|
| <p>When passed to <code>npm config</code> this refers to which config file to use.</p>
|
| <p>When set to "global" mode, packages are installed into the <code>prefix</code> folder
|
| instead of the current working directory. See
|
| <a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
|
| <ul>
|
| <li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
|
| of the current working directory.</li>
|
| <li>bin files are linked to <code>{prefix}/bin</code></li>
|
| <li>man pages are linked to <code>{prefix}/share/man</code></li>
|
| </ul>
|
| <h4 id="lockfile-version"><code>lockfile-version</code></h4>
|
| <ul>
|
| <li>Default: Version 3 if no lockfile, auto-converting v1 lockfiles to v3;
|
| otherwise, maintain current lockfile version.</li>
|
| <li>Type: null, 1, 2, 3, "1", "2", or "3"</li>
|
| </ul>
|
| <p>Set the lockfile format version to be used in package-lock.json and
|
| npm-shrinkwrap-json files. Possible options are:</p>
|
| <p>1: The lockfile version used by npm versions 5 and 6. Lacks some data that
|
| is used during the install, resulting in slower and possibly less
|
| deterministic installs. Prevents lockfile churn when interoperating with
|
| older npm versions.</p>
|
| <p>2: The default lockfile version used by npm version 7 and 8. Includes both
|
| the version 1 lockfile data and version 3 lockfile data, for maximum
|
| determinism and interoperability, at the expense of more bytes on disk.</p>
|
| <p>3: Only the new lockfile information introduced in npm version 7. Smaller on
|
| disk than lockfile version 2, but not interoperable with older npm versions.
|
| Ideal if all users are on npm version 7 and higher.</p>
|
| <h4 id="loglevel"><code>loglevel</code></h4>
|
| <ul>
|
| <li>Default: "notice"</li>
|
| <li>Type: "silent", "error", "warn", "notice", "http", "info", "verbose", or
|
| "silly"</li>
|
| </ul>
|
| <p>What level of logs to report. All logs are written to a debug log, with the
|
| path to that file printed if the execution of a command fails.</p>
|
| <p>Any logs of a higher level than the setting are shown. The default is
|
| "notice".</p>
|
| <p>See also the <code>foreground-scripts</code> config.</p>
|
| <h4 id="logs-dir"><code>logs-dir</code></h4>
|
| <ul>
|
| <li>Default: A directory named <code>_logs</code> inside the cache</li>
|
| <li>Type: null or Path</li>
|
| </ul>
|
| <p>The location of npm's log directory. See <a href="../using-npm/logging.html"><code>npm logging</code></a>
|
| for more information.</p>
|
| <h4 id="logs-max"><code>logs-max</code></h4>
|
| <ul>
|
| <li>Default: 10</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The maximum number of log files to store.</p>
|
| <p>If set to 0, no log files will be written for the current run.</p>
|
| <h4 id="long"><code>long</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
|
| <h4 id="maxsockets"><code>maxsockets</code></h4>
|
| <ul>
|
| <li>Default: 15</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The maximum number of connections to use per origin (protocol/host/port
|
| combination).</p>
|
| <h4 id="message"><code>message</code></h4>
|
| <ul>
|
| <li>Default: "%s"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Commit message which is used by <code>npm version</code> when creating version commit.</p>
|
| <p>Any "%s" in the message will be replaced with the version number.</p>
|
| <h4 id="min-release-age"><code>min-release-age</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Number</li>
|
| </ul>
|
| <p>If set, npm will build the npm tree such that only versions that were
|
| available more than the given number of days ago will be installed. If there
|
| are no versions available for the current set of dependencies, the command
|
| will error.</p>
|
| <p>This flag is a complement to <code>before</code>, which accepts an exact date instead
|
| of a relative number of days.</p>
|
| <p>This config cannot be used with: <code>before</code></p>
|
| <p>This value is not exported to the environment for child processes.</p>
|
| <h4 id="name"><code>name</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, this sets the
|
| name/description for the token.</p>
|
| <h4 id="node-gyp"><code>node-gyp</code></h4>
|
| <ul>
|
| <li>Default: The path to the node-gyp bin that ships with npm</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>This is the location of the "node-gyp" bin. By default it uses one that
|
| ships with npm itself.</p>
|
| <p>You can use this config to specify your own "node-gyp" to run when it is
|
| required to build a package.</p>
|
| <h4 id="node-options"><code>node-options</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Options to pass through to Node.js via the <code>NODE_OPTIONS</code> environment
|
| variable. This does not impact how npm itself is executed but it does impact
|
| how lifecycle scripts are called.</p>
|
| <h4 id="noproxy"><code>noproxy</code></h4>
|
| <ul>
|
| <li>Default: The value of the NO_PROXY environment variable</li>
|
| <li>Type: String (can be set multiple times)</li>
|
| </ul>
|
| <p>Domain extensions that should bypass any proxies.</p>
|
| <p>Also accepts a comma-delimited string.</p>
|
| <h4 id="offline"><code>offline</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Force offline mode: no network requests will be done during install. To
|
| allow the CLI to fill in missing cache data, see <code>--prefer-offline</code>.</p>
|
| <h4 id="omit"><code>omit</code></h4>
|
| <ul>
|
| <li>Default: 'dev' if the <code>NODE_ENV</code> environment variable is set to
|
| 'production'; otherwise, empty.</li>
|
| <li>Type: "dev", "optional", or "peer" (can be set multiple times)</li>
|
| </ul>
|
| <p>Dependency types to omit from the installation tree on disk.</p>
|
| <p>Note that these dependencies <em>are</em> still resolved and added to the
|
| <code>package-lock.json</code> or <code>npm-shrinkwrap.json</code> file. They are just not
|
| physically installed on disk.</p>
|
| <p>If a package type appears in both the <code>--include</code> and <code>--omit</code> lists, then
|
| it will be included.</p>
|
| <p>If the resulting omit list includes <code>'dev'</code>, then the <code>NODE_ENV</code> environment
|
| variable will be set to <code>'production'</code> for all lifecycle scripts.</p>
|
| <h4 id="omit-lockfile-registry-resolved"><code>omit-lockfile-registry-resolved</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>This option causes npm to create lock files without a <code>resolved</code> key for
|
| registry dependencies. Subsequent installs will need to resolve tarball
|
| endpoints with the configured registry, likely resulting in a longer install
|
| time.</p>
|
| <h4 id="orgs"><code>orgs</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String (can be set multiple times)</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, this limits
|
| the token access to specific organizations.</p>
|
| <h4 id="orgs-permission"><code>orgs-permission</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, "read-only", "read-write", or "no-access"</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, sets the
|
| permission level for organizations. Options are "read-only", "read-write",
|
| or "no-access".</p>
|
| <h4 id="os"><code>os</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Override OS of native modules to install. Acceptable values are same as <code>os</code>
|
| field of package.json, which comes from <code>process.platform</code>.</p>
|
| <h4 id="otp"><code>otp</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>This is a one-time password from a two-factor authenticator. It's needed
|
| when publishing or changing package permissions with <code>npm access</code>.</p>
|
| <p>If not set, and a registry response fails with a challenge for a one-time
|
| password, npm will prompt on the command line for one.</p>
|
| <h4 id="pack-destination"><code>pack-destination</code></h4>
|
| <ul>
|
| <li>Default: "."</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Directory in which <code>npm pack</code> will save tarballs.</p>
|
| <h4 id="package"><code>package</code></h4>
|
| <ul>
|
| <li>Default:</li>
|
| <li>Type: String (can be set multiple times)</li>
|
| </ul>
|
| <p>The package or packages to install for <a href="../commands/npm-exec.html"><code>npm exec</code></a></p>
|
| <h4 id="package-lock"><code>package-lock</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to false, then ignore <code>package-lock.json</code> files when installing. This
|
| will also prevent <em>writing</em> <code>package-lock.json</code> if <code>save</code> is true.</p>
|
| <h4 id="package-lock-only"><code>package-lock-only</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to true, the current operation will only use the <code>package-lock.json</code>,
|
| ignoring <code>node_modules</code>.</p>
|
| <p>For <code>update</code> this means only the <code>package-lock.json</code> will be updated,
|
| instead of checking <code>node_modules</code> and downloading dependencies.</p>
|
| <p>For <code>list</code> this means the output will be based on the tree described by the
|
| <code>package-lock.json</code>, rather than the contents of <code>node_modules</code>.</p>
|
| <h4 id="packages"><code>packages</code></h4>
|
| <ul>
|
| <li>Default:</li>
|
| <li>Type: null or String (can be set multiple times)</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, this limits
|
| the token access to specific packages.</p>
|
| <h4 id="packages-all"><code>packages-all</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, grants the
|
| token access to all packages instead of limiting to specific packages.</p>
|
| <h4 id="packages-and-scopes-permission"><code>packages-and-scopes-permission</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, "read-only", "read-write", or "no-access"</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, sets the
|
| permission level for packages and scopes. Options are "read-only",
|
| "read-write", or "no-access".</p>
|
| <h4 id="parseable"><code>parseable</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Output parseable results from commands that write to standard output. For
|
| <code>npm search</code>, this will be tab-separated table format.</p>
|
| <h4 id="password"><code>password</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Password for authentication. Can be provided via command line when creating
|
| tokens, though it's generally safer to be prompted for it.</p>
|
| <h4 id="prefer-dedupe"><code>prefer-dedupe</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Prefer to deduplicate packages if possible, rather than choosing a newer
|
| version of a dependency.</p>
|
| <h4 id="prefer-offline"><code>prefer-offline</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, staleness checks for cached data will be bypassed, but missing data
|
| will be requested from the server. To force full offline mode, use
|
| <code>--offline</code>.</p>
|
| <h4 id="prefer-online"><code>prefer-online</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, staleness checks for cached data will be forced, making the CLI
|
| look for updates immediately even for fresh package data.</p>
|
| <h4 id="prefix"><code>prefix</code></h4>
|
| <ul>
|
| <li>Default: In global mode, the folder where the node executable is installed.
|
| Otherwise, the nearest parent folder containing either a package.json file
|
| or a node_modules folder.</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>The location to install global items. If set on the command line, then it
|
| forces non-global commands to run in the specified folder.</p>
|
| <h4 id="preid"><code>preid</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The "prerelease identifier" to use as a prefix for the "prerelease" part of
|
| a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p>
|
| <h4 id="progress"><code>progress</code></h4>
|
| <ul>
|
| <li>Default: <code>true</code> when not in CI and both stderr and stdout are TTYs and not
|
| in a dumb terminal</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When set to <code>true</code>, npm will display a progress bar during time intensive
|
| operations, if <code>process.stderr</code> and <code>process.stdout</code> are a TTY.</p>
|
| <p>Set to <code>false</code> to suppress the progress bar.</p>
|
| <h4 id="provenance"><code>provenance</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When publishing from a supported cloud CI/CD system, the package will be
|
| publicly linked to where it was built and published from.</p>
|
| <p>This config cannot be used with: <code>provenance-file</code></p>
|
| <h4 id="provenance-file"><code>provenance-file</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>When publishing, the provenance bundle at the given path will be used.</p>
|
| <p>This config cannot be used with: <code>provenance</code></p>
|
| <h4 id="proxy"><code>proxy</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, false, or URL</li>
|
| </ul>
|
| <p>A proxy to use for outgoing http requests. If the <code>HTTP_PROXY</code> or
|
| <code>http_proxy</code> environment variables are set, proxy settings will be honored
|
| by the underlying <code>request</code> library.</p>
|
| <h4 id="read-only"><code>read-only</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>This is used to mark a token as unable to publish when configuring limited
|
| access tokens with the <code>npm token create</code> command.</p>
|
| <h4 id="rebuild-bundle"><code>rebuild-bundle</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Rebuild bundled dependencies after installation.</p>
|
| <h4 id="registry"><code>registry</code></h4>
|
| <ul>
|
| <li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
|
| <li>Type: URL</li>
|
| </ul>
|
| <p>The base URL of the npm registry.</p>
|
| <h4 id="replace-registry-host"><code>replace-registry-host</code></h4>
|
| <ul>
|
| <li>Default: "npmjs"</li>
|
| <li>Type: "npmjs", "never", "always", or String</li>
|
| </ul>
|
| <p>Defines behavior for replacing the registry host in a lockfile with the
|
| configured registry.</p>
|
| <p>The default behavior is to replace package dist URLs from the default
|
| registry (<a href="https://registry.npmjs.org">https://registry.npmjs.org</a>) to the configured registry. If set to
|
| "never", then use the registry value. If set to "always", then replace the
|
| registry host with the configured host every time.</p>
|
| <p>You may also specify a bare hostname (e.g., "registry.npmjs.org").</p>
|
| <h4 id="save"><code>save</code></h4>
|
| <ul>
|
| <li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Save installed packages to a <code>package.json</code> file as dependencies.</p>
|
| <p>When used with the <code>npm rm</code> command, removes the dependency from
|
| <code>package.json</code>.</p>
|
| <p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
|
| <h4 id="save-bundle"><code>save-bundle</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If a package would be saved at install time by the use of <code>--save</code>,
|
| <code>--save-dev</code>, or <code>--save-optional</code>, then also put it in the
|
| <code>bundleDependencies</code> list.</p>
|
| <p>Ignored if <code>--save-peer</code> is set, since peerDependencies cannot be bundled.</p>
|
| <h4 id="save-dev"><code>save-dev</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Save installed packages to a package.json file as <code>devDependencies</code>.</p>
|
| <p>This config cannot be used with: <code>save-optional</code>, <code>save-peer</code>, <code>save-prod</code></p>
|
| <h4 id="save-exact"><code>save-exact</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Dependencies saved to package.json will be configured with an exact version
|
| rather than using npm's default semver range operator.</p>
|
| <h4 id="save-optional"><code>save-optional</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Save installed packages to a package.json file as <code>optionalDependencies</code>.</p>
|
| <p>This config cannot be used with: <code>save-dev</code>, <code>save-peer</code>, <code>save-prod</code></p>
|
| <h4 id="save-peer"><code>save-peer</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Save installed packages to a package.json file as <code>peerDependencies</code></p>
|
| <p>This config cannot be used with: <code>save-dev</code>, <code>save-optional</code>, <code>save-prod</code></p>
|
| <h4 id="save-prefix"><code>save-prefix</code></h4>
|
| <ul>
|
| <li>Default: "^"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Configure how versions of packages installed to a package.json file via
|
| <code>--save</code> or <code>--save-dev</code> get prefixed.</p>
|
| <p>For example if a package has version <code>1.2.3</code>, by default its version is set
|
| to <code>^1.2.3</code> which allows minor upgrades for that package, but after <code>npm config set save-prefix='~'</code> it would be set to <code>~1.2.3</code> which only allows
|
| patch upgrades.</p>
|
| <h4 id="save-prod"><code>save-prod</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Save installed packages into <code>dependencies</code> specifically. This is useful if
|
| a package already exists in <code>devDependencies</code> or <code>optionalDependencies</code>, but
|
| you want to move it to be a non-optional production dependency.</p>
|
| <p>This is the default behavior if <code>--save</code> is true, and neither <code>--save-dev</code>
|
| or <code>--save-optional</code> are true.</p>
|
| <p>This config cannot be used with: <code>save-dev</code>, <code>save-optional</code>, <code>save-peer</code></p>
|
| <h4 id="sbom-format"><code>sbom-format</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: "cyclonedx" or "spdx"</li>
|
| </ul>
|
| <p>SBOM format to use when generating SBOMs.</p>
|
| <h4 id="sbom-type"><code>sbom-type</code></h4>
|
| <ul>
|
| <li>Default: "library"</li>
|
| <li>Type: "library", "application", or "framework"</li>
|
| </ul>
|
| <p>The type of package described by the generated SBOM. For SPDX, this is the
|
| value for the <code>primaryPackagePurpose</code> field. For CycloneDX, this is the
|
| value for the <code>type</code> field.</p>
|
| <h4 id="scope"><code>scope</code></h4>
|
| <ul>
|
| <li>Default: the scope of the current project, if any, or ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Associate an operation with a scope for a scoped registry.</p>
|
| <p>Useful when logging in to or out of a private registry:</p>
|
| <pre><code># log in, linking the scope to the custom registry
|
| npm login --scope=@mycorp --registry=https://registry.mycorp.com
|
|
|
| # log out, removing the link and the auth token
|
| npm logout --scope=@mycorp
|
| </code></pre>
|
| <p>This will cause <code>@mycorp</code> to be mapped to the registry for future
|
| installation of packages specified according to the pattern
|
| <code>@mycorp/package</code>.</p>
|
| <p>This will also cause <code>npm init</code> to create a scoped package.</p>
|
| <pre><code># accept all defaults, and create a package named "@foo/whatever",
|
| # instead of just named "whatever"
|
| npm init --scope=@foo --yes
|
| </code></pre>
|
| <h4 id="scopes"><code>scopes</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String (can be set multiple times)</li>
|
| </ul>
|
| <p>When creating a Granular Access Token with <code>npm token create</code>, this limits
|
| the token access to specific scopes. Provide a scope name (with or without @
|
| prefix).</p>
|
| <h4 id="script-shell"><code>script-shell</code></h4>
|
| <ul>
|
| <li>Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>The shell to use for scripts run with the <code>npm exec</code>, <code>npm run</code> and <code>npm init <package-spec></code> commands.</p>
|
| <h4 id="searchexclude"><code>searchexclude</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Space-separated options that limit the results from search.</p>
|
| <h4 id="searchlimit"><code>searchlimit</code></h4>
|
| <ul>
|
| <li>Default: 20</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>Number of items to limit search results to. Will not apply at all to legacy
|
| searches.</p>
|
| <h4 id="searchopts"><code>searchopts</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Space-separated options that are always passed to search.</p>
|
| <h4 id="searchstaleness"><code>searchstaleness</code></h4>
|
| <ul>
|
| <li>Default: 900</li>
|
| <li>Type: Number</li>
|
| </ul>
|
| <p>The age of the cache, in seconds, before another registry request is made if
|
| using legacy search endpoint.</p>
|
| <h4 id="shell"><code>shell</code></h4>
|
| <ul>
|
| <li>Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on
|
| Windows</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The shell to run for the <code>npm explore</code> command.</p>
|
| <h4 id="sign-git-commit"><code>sign-git-commit</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to true, then the <code>npm version</code> command will commit the new package
|
| version using <code>-S</code> to add a signature.</p>
|
| <p>Note that git requires you to have set up GPG keys in your git configs for
|
| this to work properly.</p>
|
| <h4 id="sign-git-tag"><code>sign-git-tag</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to true, then the <code>npm version</code> command will tag the version using
|
| <code>-s</code> to add a signature.</p>
|
| <p>Note that git requires you to have set up GPG keys in your git configs for
|
| this to work properly.</p>
|
| <h4 id="strict-peer-deps"><code>strict-peer-deps</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to <code>true</code>, and <code>--legacy-peer-deps</code> is not set, then <em>any</em>
|
| conflicting <code>peerDependencies</code> will be treated as an install failure, even
|
| if npm could reasonably guess the appropriate resolution based on non-peer
|
| dependency relationships.</p>
|
| <p>By default, conflicting <code>peerDependencies</code> deep in the dependency graph will
|
| be resolved using the nearest non-peer dependency specification, even if
|
| doing so will result in some packages receiving a peer dependency outside
|
| the range set in their package's <code>peerDependencies</code> object.</p>
|
| <p>When such an override is performed, a warning is printed, explaining the
|
| conflict and the packages involved. If <code>--strict-peer-deps</code> is set, then
|
| this warning is treated as a failure.</p>
|
| <h4 id="strict-ssl"><code>strict-ssl</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Whether or not to do SSL key validation when making requests to the registry
|
| via https.</p>
|
| <p>See also the <code>ca</code> config.</p>
|
| <h4 id="tag"><code>tag</code></h4>
|
| <ul>
|
| <li>Default: "latest"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>If you ask npm to install a package and don't tell it a specific version,
|
| then it will install the specified tag.</p>
|
| <p>It is the tag added to the package@version specified in the <code>npm dist-tag add</code> command, if no explicit tag is given.</p>
|
| <p>When used by the <code>npm diff</code> command, this is the tag used to fetch the
|
| tarball that will be compared with the local files by default.</p>
|
| <p>If used in the <code>npm publish</code> command, this is the tag that will be added to
|
| the package submitted to the registry.</p>
|
| <h4 id="tag-version-prefix"><code>tag-version-prefix</code></h4>
|
| <ul>
|
| <li>Default: "v"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>If set, alters the prefix used when tagging a new version when performing a
|
| version increment using <code>npm version</code>. To remove the prefix altogether, set
|
| it to the empty string: <code>""</code>.</p>
|
| <p>Because other tools may rely on the convention that npm version tags look
|
| like <code>v1.0.0</code>, <em>only use this property if it is absolutely necessary</em>. In
|
| particular, use care when overriding this setting for public packages.</p>
|
| <h4 id="timing"><code>timing</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, writes timing information to a process specific json file in the
|
| cache or <code>logs-dir</code>. The file name ends with <code>-timing.json</code>.</p>
|
| <p>You can quickly view it with this <a href="https://npm.im/json">json</a> command line:
|
| <code>cat ~/.npm/_logs/*-timing.json | npm exec -- json -g</code>.</p>
|
| <p>Timing information will also be reported in the terminal. To suppress this
|
| while still writing the timing file, use <code>--silent</code>.</p>
|
| <h4 id="token-description"><code>token-description</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| </ul>
|
| <p>Description text for the token when using <code>npm token create</code>.</p>
|
| <h4 id="umask"><code>umask</code></h4>
|
| <ul>
|
| <li>Default: 0</li>
|
| <li>Type: Octal numeric string in range 0000..0777 (0..511)</li>
|
| </ul>
|
| <p>The "umask" value to use when setting the file creation mode on files and
|
| folders.</p>
|
| <p>Folders and executables are given a mode which is <code>0o777</code> masked against
|
| this value. Other files are given a mode which is <code>0o666</code> masked against
|
| this value.</p>
|
| <p>Note that the underlying system will <em>also</em> apply its own umask value to
|
| files and folders that are created, and npm does not circumvent this, but
|
| rather adds the <code>--umask</code> config to it.</p>
|
| <p>Thus, the effective default umask value on most POSIX systems is 0o22,
|
| meaning that folders and executables are created with a mode of 0o755 and
|
| other files are created with a mode of 0o644.</p>
|
| <h4 id="unicode"><code>unicode</code></h4>
|
| <ul>
|
| <li>Default: false on windows, true on mac/unix systems with a unicode locale,
|
| as defined by the <code>LC_ALL</code>, <code>LC_CTYPE</code>, or <code>LANG</code> environment variables.</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>When set to true, npm uses unicode characters in the tree output. When
|
| false, it uses ascii characters instead of unicode glyphs.</p>
|
| <h4 id="update-notifier"><code>update-notifier</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Set to false to suppress the update notification when using an older version
|
| of npm than the latest.</p>
|
| <h4 id="usage"><code>usage</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>Show short usage output about the command specified.</p>
|
| <h4 id="user-agent"><code>user-agent</code></h4>
|
| <ul>
|
| <li>Default: "npm/{npm-version} node/{node-version} {platform} {arch}
|
| workspaces/{workspaces} {ci}"</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>Sets the User-Agent request header. The following fields are replaced with
|
| their actual counterparts:</p>
|
| <ul>
|
| <li><code>{npm-version}</code> - The npm version in use</li>
|
| <li><code>{node-version}</code> - The Node.js version in use</li>
|
| <li><code>{platform}</code> - The value of <code>process.platform</code></li>
|
| <li><code>{arch}</code> - The value of <code>process.arch</code></li>
|
| <li><code>{workspaces}</code> - Set to <code>true</code> if the <code>workspaces</code> or <code>workspace</code> options
|
| are set.</li>
|
| <li><code>{ci}</code> - The value of the <code>ci-name</code> config, if set, prefixed with <code>ci/</code>, or
|
| an empty string if <code>ci-name</code> is empty.</li>
|
| </ul>
|
| <h4 id="userconfig"><code>userconfig</code></h4>
|
| <ul>
|
| <li>Default: "~/.npmrc"</li>
|
| <li>Type: Path</li>
|
| </ul>
|
| <p>The location of user-level configuration settings.</p>
|
| <p>This may be overridden by the <code>npm_config_userconfig</code> environment variable
|
| or the <code>--userconfig</code> command line option, but may <em>not</em> be overridden by
|
| settings in the <code>globalconfig</code> file.</p>
|
| <h4 id="version"><code>version</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, output the npm version and exit successfully.</p>
|
| <p>Only relevant when specified explicitly on the command line.</p>
|
| <h4 id="versions"><code>versions</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If true, output the npm version as well as node's <code>process.versions</code> map and
|
| the version in the current working directory's <code>package.json</code> file if one
|
| exists, and exit successfully.</p>
|
| <p>Only relevant when specified explicitly on the command line.</p>
|
| <h4 id="viewer"><code>viewer</code></h4>
|
| <ul>
|
| <li>Default: "man" on Posix, "browser" on Windows</li>
|
| <li>Type: String</li>
|
| </ul>
|
| <p>The program to use to view help content.</p>
|
| <p>Set to <code>"browser"</code> to view html help content in the default web browser.</p>
|
| <h4 id="which"><code>which</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Number</li>
|
| </ul>
|
| <p>If there are multiple funding sources, which 1-indexed source URL to open.</p>
|
| <h4 id="workspace"><code>workspace</code></h4>
|
| <ul>
|
| <li>Default:</li>
|
| <li>Type: String (can be set multiple times)</li>
|
| </ul>
|
| <p>Enable running a command in the context of the configured workspaces of the
|
| current project while filtering by running only the workspaces defined by
|
| this configuration option.</p>
|
| <p>Valid values for the <code>workspace</code> config are either:</p>
|
| <ul>
|
| <li>Workspace names</li>
|
| <li>Path to a workspace directory</li>
|
| <li>Path to a parent workspace directory (will result in selecting all
|
| workspaces within that folder)</li>
|
| </ul>
|
| <p>When set for the <code>npm init</code> command, this may be set to the folder of a
|
| workspace which does not yet exist, to create the folder and set it up as a
|
| brand new workspace within the project.</p>
|
| <p>This value is not exported to the environment for child processes.</p>
|
| <h4 id="workspaces"><code>workspaces</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Boolean</li>
|
| </ul>
|
| <p>Set to true to run the command in the context of <strong>all</strong> configured
|
| workspaces.</p>
|
| <p>Explicitly setting this to false will cause commands like <code>install</code> to
|
| ignore workspaces altogether. When not set explicitly:</p>
|
| <ul>
|
| <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
|
| will link workspaces into the <code>node_modules</code> folder. - Commands that do
|
| other things (test, exec, publish, etc.) will operate on the root project,
|
| <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
|
| </ul>
|
| <p>This value is not exported to the environment for child processes.</p>
|
| <h4 id="workspaces-update"><code>workspaces-update</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| </ul>
|
| <p>If set to true, the npm cli will run an update after operations that may
|
| possibly change the workspaces installed to the <code>node_modules</code> folder.</p>
|
| <h4 id="yes"><code>yes</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Boolean</li>
|
| </ul>
|
| <p>Automatically answer "yes" to any prompts that npm might print on the
|
| command line.</p>
|
| <h4 id="also"><code>also</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, "dev", or "development"</li>
|
| <li>DEPRECATED: Please use --include=dev instead.</li>
|
| </ul>
|
| <p>When set to <code>dev</code> or <code>development</code>, this is an alias for <code>--include=dev</code>.</p>
|
| <h4 id="cache-max"><code>cache-max</code></h4>
|
| <ul>
|
| <li>Default: Infinity</li>
|
| <li>Type: Number</li>
|
| <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-online</code></li>
|
| </ul>
|
| <p><code>--cache-max=0</code> is an alias for <code>--prefer-online</code></p>
|
| <h4 id="cache-min"><code>cache-min</code></h4>
|
| <ul>
|
| <li>Default: 0</li>
|
| <li>Type: Number</li>
|
| <li>DEPRECATED: This option has been deprecated in favor of <code>--prefer-offline</code>.</li>
|
| </ul>
|
| <p><code>--cache-min=9999 (or bigger)</code> is an alias for <code>--prefer-offline</code>.</p>
|
| <h4 id="cert"><code>cert</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| <li>DEPRECATED: <code>key</code> and <code>cert</code> are no longer used for most registry
|
| operations. Use registry scoped <code>keyfile</code> and <code>certfile</code> instead. Example:
|
| //other-registry.tld/:keyfile=/path/to/key.pem
|
| //other-registry.tld/:certfile=/path/to/cert.crt</li>
|
| </ul>
|
| <p>A client certificate to pass when accessing the registry. Values should be
|
| in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with
|
| newlines replaced by the string "\n". For example:</p>
|
| <pre><code class="language-ini">cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
|
| </code></pre>
|
| <p>It is <em>not</em> the path to a certificate file, though you can set a
|
| registry-scoped "certfile" path like
|
| "//other-registry.tld/:certfile=/path/to/cert.pem".</p>
|
| <h4 id="dev"><code>dev</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| <li>DEPRECATED: Please use --include=dev instead.</li>
|
| </ul>
|
| <p>Alias for <code>--include=dev</code>.</p>
|
| <h4 id="global-style"><code>global-style</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| <li>DEPRECATED: This option has been deprecated in favor of
|
| <code>--install-strategy=shallow</code></li>
|
| </ul>
|
| <p>Only install direct dependencies in the top level <code>node_modules</code>, but hoist
|
| on deeper dependencies. Sets <code>--install-strategy=shallow</code>.</p>
|
| <h4 id="initauthoremail"><code>init.author.email</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| <li>DEPRECATED: Use <code>--init-author-email</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-author-email</code></p>
|
| <h4 id="initauthorname"><code>init.author.name</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: String</li>
|
| <li>DEPRECATED: Use <code>--init-author-name</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-author-name</code></p>
|
| <h4 id="initauthorurl"><code>init.author.url</code></h4>
|
| <ul>
|
| <li>Default: ""</li>
|
| <li>Type: "" or URL</li>
|
| <li>DEPRECATED: Use <code>--init-author-url</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-author-url</code></p>
|
| <h4 id="initlicense"><code>init.license</code></h4>
|
| <ul>
|
| <li>Default: "ISC"</li>
|
| <li>Type: String</li>
|
| <li>DEPRECATED: Use <code>--init-license</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-license</code></p>
|
| <h4 id="initmodule"><code>init.module</code></h4>
|
| <ul>
|
| <li>Default: "~/.npm-init.js"</li>
|
| <li>Type: Path</li>
|
| <li>DEPRECATED: Use <code>--init-module</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-module</code></p>
|
| <h4 id="initversion"><code>init.version</code></h4>
|
| <ul>
|
| <li>Default: "1.0.0"</li>
|
| <li>Type: SemVer string</li>
|
| <li>DEPRECATED: Use <code>--init-version</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--init-version</code></p>
|
| <h4 id="key"><code>key</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or String</li>
|
| <li>DEPRECATED: <code>key</code> and <code>cert</code> are no longer used for most registry
|
| operations. Use registry scoped <code>keyfile</code> and <code>certfile</code> instead. Example:
|
| //other-registry.tld/:keyfile=/path/to/key.pem
|
| //other-registry.tld/:certfile=/path/to/cert.crt</li>
|
| </ul>
|
| <p>A client key to pass when accessing the registry. Values should be in PEM
|
| format with newlines replaced by the string "\n". For example:</p>
|
| <pre><code class="language-ini">key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
|
| </code></pre>
|
| <p>It is <em>not</em> the path to a key file, though you can set a registry-scoped
|
| "keyfile" path like "//other-registry.tld/:keyfile=/path/to/key.pem".</p>
|
| <h4 id="legacy-bundling"><code>legacy-bundling</code></h4>
|
| <ul>
|
| <li>Default: false</li>
|
| <li>Type: Boolean</li>
|
| <li>DEPRECATED: This option has been deprecated in favor of
|
| <code>--install-strategy=nested</code></li>
|
| </ul>
|
| <p>Instead of hoisting package installs in <code>node_modules</code>, install packages in
|
| the same manner that they are depended on. This may cause very deep
|
| directory structures and duplicate package installs as there is no
|
| de-duplicating. Sets <code>--install-strategy=nested</code>.</p>
|
| <h4 id="only"><code>only</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null, "prod", or "production"</li>
|
| <li>DEPRECATED: Use <code>--omit=dev</code> to omit dev dependencies from the install.</li>
|
| </ul>
|
| <p>When set to <code>prod</code> or <code>production</code>, this is an alias for <code>--omit=dev</code>.</p>
|
| <h4 id="optional"><code>optional</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Boolean</li>
|
| <li>DEPRECATED: Use <code>--omit=optional</code> to exclude optional dependencies, or
|
| <code>--include=optional</code> to include them.</li>
|
| </ul>
|
| <p>Default value does install optional deps unless otherwise omitted.</p>
|
| <p>Alias for --include=optional or --omit=optional</p>
|
| <h4 id="production"><code>production</code></h4>
|
| <ul>
|
| <li>Default: null</li>
|
| <li>Type: null or Boolean</li>
|
| <li>DEPRECATED: Use <code>--omit=dev</code> instead.</li>
|
| </ul>
|
| <p>Alias for <code>--omit=dev</code></p>
|
| <h4 id="shrinkwrap"><code>shrinkwrap</code></h4>
|
| <ul>
|
| <li>Default: true</li>
|
| <li>Type: Boolean</li>
|
| <li>DEPRECATED: Use the --package-lock setting instead.</li>
|
| </ul>
|
| <p>Alias for --package-lock</p>
|
| <h3 id="see-also">See also</h3>
|
| <ul>
|
| <li><a href="../commands/npm-config.html">npm config</a></li>
|
| <li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
|
| <li><a href="../using-npm/scripts.html">npm scripts</a></li>
|
| <li><a href="../configuring-npm/folders.html">npm folders</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/using-npm/config.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> |
