1<!DOCTYPE html><html><head> 2<meta charset="utf-8"> 3<title>npm-config</title> 4<style> 5body { 6 background-color: #ffffff; 7 color: #24292e; 8 9 margin: 0; 10 11 line-height: 1.5; 12 13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; 14} 15#rainbar { 16 height: 10px; 17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); 18} 19 20a { 21 text-decoration: none; 22 color: #0366d6; 23} 24a:hover { 25 text-decoration: underline; 26} 27 28pre { 29 margin: 1em 0px; 30 padding: 1em; 31 border: solid 1px #e1e4e8; 32 border-radius: 6px; 33 34 display: block; 35 overflow: auto; 36 37 white-space: pre; 38 39 background-color: #f6f8fa; 40 color: #393a34; 41} 42code { 43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; 44 font-size: 85%; 45 padding: 0.2em 0.4em; 46 background-color: #f6f8fa; 47 color: #393a34; 48} 49pre > code { 50 padding: 0; 51 background-color: inherit; 52 color: inherit; 53} 54h1, h2, h3 { 55 font-weight: 600; 56} 57 58#logobar { 59 background-color: #333333; 60 margin: 0 auto; 61 padding: 1em 4em; 62} 63#logobar .logo { 64 float: left; 65} 66#logobar .title { 67 font-weight: 600; 68 color: #dddddd; 69 float: left; 70 margin: 5px 0 0 1em; 71} 72#logobar:after { 73 content: ""; 74 display: block; 75 clear: both; 76} 77 78#content { 79 margin: 0 auto; 80 padding: 0 4em; 81} 82 83#table_of_contents > h2 { 84 font-size: 1.17em; 85} 86#table_of_contents ul:first-child { 87 border: solid 1px #e1e4e8; 88 border-radius: 6px; 89 padding: 1em; 90 background-color: #f6f8fa; 91 color: #393a34; 92} 93#table_of_contents ul { 94 list-style-type: none; 95 padding-left: 1.5em; 96} 97#table_of_contents li { 98 font-size: 0.9em; 99} 100#table_of_contents li a { 101 color: #000000; 102} 103 104header.title { 105 border-bottom: solid 1px #e1e4e8; 106} 107header.title > h1 { 108 margin-bottom: 0.25em; 109} 110header.title > .description { 111 display: block; 112 margin-bottom: 0.5em; 113 line-height: 1; 114} 115 116footer#edit { 117 border-top: solid 1px #e1e4e8; 118 margin: 3em 0 4em 0; 119 padding-top: 2em; 120} 121</style> 122</head> 123<body> 124<div id="banner"> 125<div id="rainbar"></div> 126<div id="logobar"> 127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700"> 128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> 129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> 130</svg> 131<div class="title"> 132npm command-line interface 133</div> 134</div> 135</div> 136 137<section id="content"> 138<header class="title"> 139<h1 id="npm-config">npm-config</h1> 140<span class="description">Manage the npm configuration files</span> 141</header> 142 143<section id="table_of_contents"> 144<h2 id="table-of-contents">Table of contents</h2> 145<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> 146</section> 147 148<div id="_content"><h3 id="synopsis">Synopsis</h3> 149<pre><code class="language-bash">npm config set <key>=<value> [<key>=<value> ...] 150npm config get [<key> [<key> ...]] 151npm config delete <key> [<key> ...] 152npm config list [--json] 153npm config edit 154npm config fix 155 156alias: c 157</code></pre> 158<p>Note: This command is unaware of workspaces.</p> 159<h3 id="description">Description</h3> 160<p>npm gets its config settings from the command line, environment 161variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p> 162<p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more information about the npmrc 163files.</p> 164<p>See <a href="../using-npm/config.html">config</a> for a more thorough explanation of the 165mechanisms involved, and a full list of config options available.</p> 166<p>The <code>npm config</code> command can be used to update and edit the contents 167of the user and global npmrc files.</p> 168<h3 id="sub-commands">Sub-commands</h3> 169<p>Config supports the following sub-commands:</p> 170<h4 id="set">set</h4> 171<pre><code class="language-bash">npm config set key=value [key=value...] 172npm set key=value [key=value...] 173</code></pre> 174<p>Sets each of the config keys to the value provided.</p> 175<p>If value is omitted, the key will be removed from your config file entirely.</p> 176<p>Note: for backwards compatibility, <code>npm config set key value</code> is supported 177as an alias for <code>npm config set key=value</code>.</p> 178<h4 id="get">get</h4> 179<pre><code class="language-bash">npm config get [key ...] 180npm get [key ...] 181</code></pre> 182<p>Echo the config value(s) to stdout.</p> 183<p>If multiple keys are provided, then the values will be prefixed with the 184key names.</p> 185<p>If no keys are provided, then this command behaves the same as <code>npm config list</code>.</p> 186<h4 id="list">list</h4> 187<pre><code class="language-bash">npm config list 188</code></pre> 189<p>Show all the config settings. Use <code>-l</code> to also show defaults. Use <code>--json</code> 190to show the settings in json format.</p> 191<h4 id="delete">delete</h4> 192<pre><code class="language-bash">npm config delete key [key ...] 193</code></pre> 194<p>Deletes the specified keys from all configuration files.</p> 195<h4 id="edit2">edit</h4> 196<pre><code class="language-bash">npm config edit 197</code></pre> 198<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the 199global config.</p> 200<h4 id="fix">fix</h4> 201<pre><code class="language-bash">npm config fix 202</code></pre> 203<p>Attempts to repair invalid configuration items. Usually this means 204attaching authentication config (i.e. <code>_auth</code>, <code>_authToken</code>) to the 205configured <code>registry</code>.</p> 206<h3 id="configuration">Configuration</h3> 207<h4 id="json"><code>json</code></h4> 208<ul> 209<li>Default: false</li> 210<li>Type: Boolean</li> 211</ul> 212<p>Whether or not to output JSON data, rather than the normal output.</p> 213<ul> 214<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before 215saving them to your <code>package.json</code>.</li> 216</ul> 217<p>Not supported by all npm commands.</p> 218<h4 id="global"><code>global</code></h4> 219<ul> 220<li>Default: false</li> 221<li>Type: Boolean</li> 222</ul> 223<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code> 224folder instead of the current working directory. See 225<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 226<ul> 227<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 228of the current working directory.</li> 229<li>bin files are linked to <code>{prefix}/bin</code></li> 230<li>man pages are linked to <code>{prefix}/share/man</code></li> 231</ul> 232<h4 id="editor"><code>editor</code></h4> 233<ul> 234<li>Default: The EDITOR or VISUAL environment variables, or 235'%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems</li> 236<li>Type: String</li> 237</ul> 238<p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p> 239<h4 id="location"><code>location</code></h4> 240<ul> 241<li>Default: "user" unless <code>--global</code> is passed, which will also set this value 242to "global"</li> 243<li>Type: "global", "user", or "project"</li> 244</ul> 245<p>When passed to <code>npm config</code> this refers to which config file to use.</p> 246<p>When set to "global" mode, packages are installed into the <code>prefix</code> folder 247instead of the current working directory. See 248<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p> 249<ul> 250<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead 251of the current working directory.</li> 252<li>bin files are linked to <code>{prefix}/bin</code></li> 253<li>man pages are linked to <code>{prefix}/share/man</code></li> 254</ul> 255<h4 id="long"><code>long</code></h4> 256<ul> 257<li>Default: false</li> 258<li>Type: Boolean</li> 259</ul> 260<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p> 261<h3 id="see-also">See Also</h3> 262<ul> 263<li><a href="../configuring-npm/folders.html">npm folders</a></li> 264<li><a href="../commands/npm-config.html">npm config</a></li> 265<li><a href="../configuring-npm/package-json.html">package.json</a></li> 266<li><a href="../configuring-npm/npmrc.html">npmrc</a></li> 267<li><a href="../commands/npm.html">npm</a></li> 268</ul></div> 269 270<footer id="edit"> 271<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-config.md"> 272<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> 273<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> 274</svg> 275Edit this page on GitHub 276</a> 277</footer> 278</section> 279 280 281 282</body></html>