11cb0ef41Sopenharmony_ci<!DOCTYPE html><html><head> 21cb0ef41Sopenharmony_ci<meta charset="utf-8"> 31cb0ef41Sopenharmony_ci<title>npm-config</title> 41cb0ef41Sopenharmony_ci<style> 51cb0ef41Sopenharmony_cibody { 61cb0ef41Sopenharmony_ci background-color: #ffffff; 71cb0ef41Sopenharmony_ci color: #24292e; 81cb0ef41Sopenharmony_ci 91cb0ef41Sopenharmony_ci margin: 0; 101cb0ef41Sopenharmony_ci 111cb0ef41Sopenharmony_ci line-height: 1.5; 121cb0ef41Sopenharmony_ci 131cb0ef41Sopenharmony_ci font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 141cb0ef41Sopenharmony_ci} 151cb0ef41Sopenharmony_ci#rainbar { 161cb0ef41Sopenharmony_ci height: 10px; 171cb0ef41Sopenharmony_ci background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 181cb0ef41Sopenharmony_ci} 191cb0ef41Sopenharmony_ci 201cb0ef41Sopenharmony_cia { 211cb0ef41Sopenharmony_ci text-decoration: none; 221cb0ef41Sopenharmony_ci color: #0366d6; 231cb0ef41Sopenharmony_ci} 241cb0ef41Sopenharmony_cia:hover { 251cb0ef41Sopenharmony_ci text-decoration: underline; 261cb0ef41Sopenharmony_ci} 271cb0ef41Sopenharmony_ci 281cb0ef41Sopenharmony_cipre { 291cb0ef41Sopenharmony_ci margin: 1em 0px; 301cb0ef41Sopenharmony_ci padding: 1em; 311cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 321cb0ef41Sopenharmony_ci border-radius: 6px; 331cb0ef41Sopenharmony_ci 341cb0ef41Sopenharmony_ci display: block; 351cb0ef41Sopenharmony_ci overflow: auto; 361cb0ef41Sopenharmony_ci 371cb0ef41Sopenharmony_ci white-space: pre; 381cb0ef41Sopenharmony_ci 391cb0ef41Sopenharmony_ci background-color: #f6f8fa; 401cb0ef41Sopenharmony_ci color: #393a34; 411cb0ef41Sopenharmony_ci} 421cb0ef41Sopenharmony_cicode { 431cb0ef41Sopenharmony_ci font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 441cb0ef41Sopenharmony_ci font-size: 85%; 451cb0ef41Sopenharmony_ci padding: 0.2em 0.4em; 461cb0ef41Sopenharmony_ci background-color: #f6f8fa; 471cb0ef41Sopenharmony_ci color: #393a34; 481cb0ef41Sopenharmony_ci} 491cb0ef41Sopenharmony_cipre > code { 501cb0ef41Sopenharmony_ci padding: 0; 511cb0ef41Sopenharmony_ci background-color: inherit; 521cb0ef41Sopenharmony_ci color: inherit; 531cb0ef41Sopenharmony_ci} 541cb0ef41Sopenharmony_cih1, h2, h3 { 551cb0ef41Sopenharmony_ci font-weight: 600; 561cb0ef41Sopenharmony_ci} 571cb0ef41Sopenharmony_ci 581cb0ef41Sopenharmony_ci#logobar { 591cb0ef41Sopenharmony_ci background-color: #333333; 601cb0ef41Sopenharmony_ci margin: 0 auto; 611cb0ef41Sopenharmony_ci padding: 1em 4em; 621cb0ef41Sopenharmony_ci} 631cb0ef41Sopenharmony_ci#logobar .logo { 641cb0ef41Sopenharmony_ci float: left; 651cb0ef41Sopenharmony_ci} 661cb0ef41Sopenharmony_ci#logobar .title { 671cb0ef41Sopenharmony_ci font-weight: 600; 681cb0ef41Sopenharmony_ci color: #dddddd; 691cb0ef41Sopenharmony_ci float: left; 701cb0ef41Sopenharmony_ci margin: 5px 0 0 1em; 711cb0ef41Sopenharmony_ci} 721cb0ef41Sopenharmony_ci#logobar:after { 731cb0ef41Sopenharmony_ci content: ""; 741cb0ef41Sopenharmony_ci display: block; 751cb0ef41Sopenharmony_ci clear: both; 761cb0ef41Sopenharmony_ci} 771cb0ef41Sopenharmony_ci 781cb0ef41Sopenharmony_ci#content { 791cb0ef41Sopenharmony_ci margin: 0 auto; 801cb0ef41Sopenharmony_ci padding: 0 4em; 811cb0ef41Sopenharmony_ci} 821cb0ef41Sopenharmony_ci 831cb0ef41Sopenharmony_ci#table_of_contents > h2 { 841cb0ef41Sopenharmony_ci font-size: 1.17em; 851cb0ef41Sopenharmony_ci} 861cb0ef41Sopenharmony_ci#table_of_contents ul:first-child { 871cb0ef41Sopenharmony_ci border: solid 1px #e1e4e8; 881cb0ef41Sopenharmony_ci border-radius: 6px; 891cb0ef41Sopenharmony_ci padding: 1em; 901cb0ef41Sopenharmony_ci background-color: #f6f8fa; 911cb0ef41Sopenharmony_ci color: #393a34; 921cb0ef41Sopenharmony_ci} 931cb0ef41Sopenharmony_ci#table_of_contents ul { 941cb0ef41Sopenharmony_ci list-style-type: none; 951cb0ef41Sopenharmony_ci padding-left: 1.5em; 961cb0ef41Sopenharmony_ci} 971cb0ef41Sopenharmony_ci#table_of_contents li { 981cb0ef41Sopenharmony_ci font-size: 0.9em; 991cb0ef41Sopenharmony_ci} 1001cb0ef41Sopenharmony_ci#table_of_contents li a { 1011cb0ef41Sopenharmony_ci color: #000000; 1021cb0ef41Sopenharmony_ci} 1031cb0ef41Sopenharmony_ci 1041cb0ef41Sopenharmony_ciheader.title { 1051cb0ef41Sopenharmony_ci border-bottom: solid 1px #e1e4e8; 1061cb0ef41Sopenharmony_ci} 1071cb0ef41Sopenharmony_ciheader.title > h1 { 1081cb0ef41Sopenharmony_ci margin-bottom: 0.25em; 1091cb0ef41Sopenharmony_ci} 1101cb0ef41Sopenharmony_ciheader.title > .description { 1111cb0ef41Sopenharmony_ci display: block; 1121cb0ef41Sopenharmony_ci margin-bottom: 0.5em; 1131cb0ef41Sopenharmony_ci line-height: 1; 1141cb0ef41Sopenharmony_ci} 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_cifooter#edit { 1171cb0ef41Sopenharmony_ci border-top: solid 1px #e1e4e8; 1181cb0ef41Sopenharmony_ci margin: 3em 0 4em 0; 1191cb0ef41Sopenharmony_ci padding-top: 2em; 1201cb0ef41Sopenharmony_ci} 1211cb0ef41Sopenharmony_ci</style> 1221cb0ef41Sopenharmony_ci</head> 1231cb0ef41Sopenharmony_ci<body> 1241cb0ef41Sopenharmony_ci<div id="banner"> 1251cb0ef41Sopenharmony_ci<div id="rainbar"></div> 1261cb0ef41Sopenharmony_ci<div id="logobar"> 1271cb0ef41Sopenharmony_ci<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 1281cb0ef41Sopenharmony_ci<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 1291cb0ef41Sopenharmony_ci<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 1301cb0ef41Sopenharmony_ci</svg> 1311cb0ef41Sopenharmony_ci<div class="title"> 1321cb0ef41Sopenharmony_cinpm command-line interface 1331cb0ef41Sopenharmony_ci</div> 1341cb0ef41Sopenharmony_ci</div> 1351cb0ef41Sopenharmony_ci</div> 1361cb0ef41Sopenharmony_ci 1371cb0ef41Sopenharmony_ci<section id="content"> 1381cb0ef41Sopenharmony_ci<header class="title"> 1391cb0ef41Sopenharmony_ci<h1 id="npm-config">npm-config</h1> 1401cb0ef41Sopenharmony_ci<span class="description">Manage the npm configuration files</span> 1411cb0ef41Sopenharmony_ci</header> 1421cb0ef41Sopenharmony_ci 1431cb0ef41Sopenharmony_ci<section id="table_of_contents"> 1441cb0ef41Sopenharmony_ci<h2 id="table-of-contents">Table of contents</h2> 1451cb0ef41Sopenharmony_ci<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#sub-commands">Sub-commands</a></li><ul><li><a href="#set">set</a></li><li><a href="#get">get</a></li><li><a href="#list">list</a></li><li><a href="#delete">delete</a></li><li><a href="#edit2">edit</a></li><li><a href="#fix">fix</a></li></ul><li><a href="#configuration">Configuration</a></li><ul><li><a href="#json"><code>json</code></a></li><li><a href="#global"><code>global</code></a></li><li><a href="#editor"><code>editor</code></a></li><li><a href="#location"><code>location</code></a></li><li><a href="#long"><code>long</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div> 1461cb0ef41Sopenharmony_ci</section> 1471cb0ef41Sopenharmony_ci 1481cb0ef41Sopenharmony_ci<div id="_content"><h3 id="synopsis">Synopsis</h3> 1491cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config set <key>=<value> [<key>=<value> ...] 1501cb0ef41Sopenharmony_cinpm config get [<key> [<key> ...]] 1511cb0ef41Sopenharmony_cinpm config delete <key> [<key> ...] 1521cb0ef41Sopenharmony_cinpm config list [--json] 1531cb0ef41Sopenharmony_cinpm config edit 1541cb0ef41Sopenharmony_cinpm config fix 1551cb0ef41Sopenharmony_ci 1561cb0ef41Sopenharmony_cialias: c 1571cb0ef41Sopenharmony_ci</code></pre> 1581cb0ef41Sopenharmony_ci<p>Note: This command is unaware of workspaces.</p> 1591cb0ef41Sopenharmony_ci<h3 id="description">Description</h3> 1601cb0ef41Sopenharmony_ci<p>npm gets its config settings from the command line, environment 1611cb0ef41Sopenharmony_civariables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p> 1621cb0ef41Sopenharmony_ci<p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more information about the npmrc 1631cb0ef41Sopenharmony_cifiles.</p> 1641cb0ef41Sopenharmony_ci<p>See <a href="../using-npm/config.html">config</a> for a more thorough explanation of the 1651cb0ef41Sopenharmony_cimechanisms involved, and a full list of config options available.</p> 1661cb0ef41Sopenharmony_ci<p>The <code>npm config</code> command can be used to update and edit the contents 1671cb0ef41Sopenharmony_ciof the user and global npmrc files.</p> 1681cb0ef41Sopenharmony_ci<h3 id="sub-commands">Sub-commands</h3> 1691cb0ef41Sopenharmony_ci<p>Config supports the following sub-commands:</p> 1701cb0ef41Sopenharmony_ci<h4 id="set">set</h4> 1711cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config set key=value [key=value...] 1721cb0ef41Sopenharmony_cinpm set key=value [key=value...] 1731cb0ef41Sopenharmony_ci</code></pre> 1741cb0ef41Sopenharmony_ci<p>Sets each of the config keys to the value provided. Modifies the user configuration 1751cb0ef41Sopenharmony_cifile unless <a href="../commands/npm-config#location.html"><code>location</code></a> is passed.</p> 1761cb0ef41Sopenharmony_ci<p>If value is omitted, the key will be removed from your config file entirely.</p> 1771cb0ef41Sopenharmony_ci<p>Note: for backwards compatibility, <code>npm config set key value</code> is supported 1781cb0ef41Sopenharmony_cias an alias for <code>npm config set key=value</code>.</p> 1791cb0ef41Sopenharmony_ci<h4 id="get">get</h4> 1801cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config get [key ...] 1811cb0ef41Sopenharmony_cinpm get [key ...] 1821cb0ef41Sopenharmony_ci</code></pre> 1831cb0ef41Sopenharmony_ci<p>Echo the config value(s) to stdout.</p> 1841cb0ef41Sopenharmony_ci<p>If multiple keys are provided, then the values will be prefixed with the 1851cb0ef41Sopenharmony_cikey names.</p> 1861cb0ef41Sopenharmony_ci<p>If no keys are provided, then this command behaves the same as <code>npm config list</code>.</p> 1871cb0ef41Sopenharmony_ci<h4 id="list">list</h4> 1881cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config list 1891cb0ef41Sopenharmony_ci</code></pre> 1901cb0ef41Sopenharmony_ci<p>Show all the config settings. Use <code>-l</code> to also show defaults. Use <code>--json</code> 1911cb0ef41Sopenharmony_cito show the settings in json format.</p> 1921cb0ef41Sopenharmony_ci<h4 id="delete">delete</h4> 1931cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config delete key [key ...] 1941cb0ef41Sopenharmony_ci</code></pre> 1951cb0ef41Sopenharmony_ci<p>Deletes the specified keys from all configuration files.</p> 1961cb0ef41Sopenharmony_ci<h4 id="edit2">edit</h4> 1971cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config edit 1981cb0ef41Sopenharmony_ci</code></pre> 1991cb0ef41Sopenharmony_ci<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the 2001cb0ef41Sopenharmony_ciglobal config.</p> 2011cb0ef41Sopenharmony_ci<h4 id="fix">fix</h4> 2021cb0ef41Sopenharmony_ci<pre><code class="language-bash">npm config fix 2031cb0ef41Sopenharmony_ci</code></pre> 2041cb0ef41Sopenharmony_ci<p>Attempts to repair invalid configuration items. Usually this means 2051cb0ef41Sopenharmony_ciattaching authentication config (i.e. <code>_auth</code>, <code>_authToken</code>) to the 2061cb0ef41Sopenharmony_ciconfigured <code>registry</code>.</p> 2071cb0ef41Sopenharmony_ci<h3 id="configuration">Configuration</h3> 2081cb0ef41Sopenharmony_ci<h4 id="json"><code>json</code></h4> 2091cb0ef41Sopenharmony_ci<ul> 2101cb0ef41Sopenharmony_ci<li>Default: false</li> 2111cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2121cb0ef41Sopenharmony_ci</ul> 2131cb0ef41Sopenharmony_ci<p>Whether or not to output JSON data, rather than the normal output.</p> 2141cb0ef41Sopenharmony_ci<ul> 2151cb0ef41Sopenharmony_ci<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before 2161cb0ef41Sopenharmony_cisaving them to your <code>package.json</code>.</li> 2171cb0ef41Sopenharmony_ci</ul> 2181cb0ef41Sopenharmony_ci<p>Not supported by all npm commands.</p> 2191cb0ef41Sopenharmony_ci<h4 id="global"><code>global</code></h4> 2201cb0ef41Sopenharmony_ci<ul> 2211cb0ef41Sopenharmony_ci<li>Default: false</li> 2221cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2231cb0ef41Sopenharmony_ci</ul> 2241cb0ef41Sopenharmony_ci<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code> 2251cb0ef41Sopenharmony_cifolder instead of the current working directory. See 2261cb0ef41Sopenharmony_ci<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 2271cb0ef41Sopenharmony_ci<ul> 2281cb0ef41Sopenharmony_ci<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 2291cb0ef41Sopenharmony_ciof the current working directory.</li> 2301cb0ef41Sopenharmony_ci<li>bin files are linked to <code>{prefix}/bin</code></li> 2311cb0ef41Sopenharmony_ci<li>man pages are linked to <code>{prefix}/share/man</code></li> 2321cb0ef41Sopenharmony_ci</ul> 2331cb0ef41Sopenharmony_ci<h4 id="editor"><code>editor</code></h4> 2341cb0ef41Sopenharmony_ci<ul> 2351cb0ef41Sopenharmony_ci<li>Default: The EDITOR or VISUAL environment variables, or 2361cb0ef41Sopenharmony_ci'%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems</li> 2371cb0ef41Sopenharmony_ci<li>Type: String</li> 2381cb0ef41Sopenharmony_ci</ul> 2391cb0ef41Sopenharmony_ci<p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p> 2401cb0ef41Sopenharmony_ci<h4 id="location"><code>location</code></h4> 2411cb0ef41Sopenharmony_ci<ul> 2421cb0ef41Sopenharmony_ci<li>Default: "user" unless <code>--global</code> is passed, which will also set this value 2431cb0ef41Sopenharmony_cito "global"</li> 2441cb0ef41Sopenharmony_ci<li>Type: "global", "user", or "project"</li> 2451cb0ef41Sopenharmony_ci</ul> 2461cb0ef41Sopenharmony_ci<p>When passed to <code>npm config</code> this refers to which config file to use.</p> 2471cb0ef41Sopenharmony_ci<p>When set to "global" mode, packages are installed into the <code>prefix</code> folder 2481cb0ef41Sopenharmony_ciinstead of the current working directory. See 2491cb0ef41Sopenharmony_ci<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 2501cb0ef41Sopenharmony_ci<ul> 2511cb0ef41Sopenharmony_ci<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 2521cb0ef41Sopenharmony_ciof the current working directory.</li> 2531cb0ef41Sopenharmony_ci<li>bin files are linked to <code>{prefix}/bin</code></li> 2541cb0ef41Sopenharmony_ci<li>man pages are linked to <code>{prefix}/share/man</code></li> 2551cb0ef41Sopenharmony_ci</ul> 2561cb0ef41Sopenharmony_ci<h4 id="long"><code>long</code></h4> 2571cb0ef41Sopenharmony_ci<ul> 2581cb0ef41Sopenharmony_ci<li>Default: false</li> 2591cb0ef41Sopenharmony_ci<li>Type: Boolean</li> 2601cb0ef41Sopenharmony_ci</ul> 2611cb0ef41Sopenharmony_ci<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> 2621cb0ef41Sopenharmony_ci<h3 id="see-also">See Also</h3> 2631cb0ef41Sopenharmony_ci<ul> 2641cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/folders.html">npm folders</a></li> 2651cb0ef41Sopenharmony_ci<li><a href="../commands/npm-config.html">npm config</a></li> 2661cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/package-json.html">package.json</a></li> 2671cb0ef41Sopenharmony_ci<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 2681cb0ef41Sopenharmony_ci<li><a href="../commands/npm.html">npm</a></li> 2691cb0ef41Sopenharmony_ci</ul></div> 2701cb0ef41Sopenharmony_ci 2711cb0ef41Sopenharmony_ci<footer id="edit"> 2721cb0ef41Sopenharmony_ci<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-config.md"> 2731cb0ef41Sopenharmony_ci<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 2741cb0ef41Sopenharmony_ci<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> 2751cb0ef41Sopenharmony_ci</svg> 2761cb0ef41Sopenharmony_ciEdit this page on GitHub 2771cb0ef41Sopenharmony_ci</a> 2781cb0ef41Sopenharmony_ci</footer> 2791cb0ef41Sopenharmony_ci</section> 2801cb0ef41Sopenharmony_ci 2811cb0ef41Sopenharmony_ci 2821cb0ef41Sopenharmony_ci 2831cb0ef41Sopenharmony_ci</body></html>