codekingpro/portable-devtools
114k
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
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-config----11130">
190 <span>npm-config</span>
191 <span class="version">@11.13.0</span>
192</h1>
193<span class="description">Manage the npm configuration files</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<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>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm config set <key>=<value> [<key>=<value> ...]
203npm config get [<key> [<key> ...]]
204npm config delete <key> [<key> ...]
205npm config list [--json]
206npm config edit
207npm config fix
208
209alias: c
210</code></pre>
211<p>Note: This command is unaware of workspaces.</p>
212<h3 id="description">Description</h3>
213<p>npm gets its config settings from the command line, environment variables, <code>npmrc</code> files, and in some cases, the <code>package.json</code> file.</p>
214<p>See <a href="../configuring-npm/npmrc.html">npmrc</a> for more information about the npmrc files.</p>
215<p>See <a href="../using-npm/config.html">config</a> for a more thorough explanation of the mechanisms involved, and a full list of config options available.</p>
216<p>The <code>npm config</code> command can be used to update and edit the contents of the user and global npmrc files.</p>
217<h3 id="sub-commands">Sub-commands</h3>
218<p>Config supports the following sub-commands:</p>
219<h4 id="set">set</h4>
220<pre><code class="language-bash">npm config set key=value [key=value...]
221npm set key=value [key=value...]
222</code></pre>
223<p>Sets each of the config keys to the value provided.
224Modifies the user configuration file unless <a href="../commands/npm-config#location.html"><code>location</code></a> is passed.</p>
225<p>If value is omitted, the key will be removed from your config file entirely.</p>
226<p>Note: for backwards compatibility, <code>npm config set key value</code> is supported as an alias for <code>npm config set key=value</code>.</p>
227<h4 id="get">get</h4>
228<pre><code class="language-bash">npm config get [key ...]
229npm get [key ...]
230</code></pre>
231<p>Echo the config value(s) to stdout.</p>
232<p>If multiple keys are provided, then the values will be prefixed with the key names.</p>
233<p>If no keys are provided, then this command behaves the same as <code>npm config list</code>.</p>
234<h4 id="list">list</h4>
235<pre><code class="language-bash">npm config list
236</code></pre>
237<p>Show all the config settings.
238Use <code>-l</code> to also show defaults.
239Use <code>--json</code> to show the settings in json format.</p>
240<h4 id="delete">delete</h4>
241<pre><code class="language-bash">npm config delete key [key ...]
242</code></pre>
243<p>Deletes the specified keys from all configuration files.</p>
244<h4 id="edit2">edit</h4>
245<pre><code class="language-bash">npm config edit
246</code></pre>
247<p>Opens the config file in an editor.
248Use the <code>--global</code> flag to edit the global config.</p>
249<h4 id="fix">fix</h4>
250<pre><code class="language-bash">npm config fix
251</code></pre>
252<p>Attempts to repair invalid configuration items.
253Usually this means attaching authentication config (i.e.
254<code>_auth</code>, <code>_authToken</code>) to the configured <code>registry</code>.</p>
255<h3 id="configuration">Configuration</h3>
256<h4 id="json"><code>json</code></h4>
257<ul>
258<li>Default: false</li>
259<li>Type: Boolean</li>
260</ul>
261<p>Whether or not to output JSON data, rather than the normal output.</p>
262<ul>
263<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
264saving them to your <code>package.json</code>.</li>
265</ul>
266<p>Not supported by all npm commands.</p>
267<h4 id="global"><code>global</code></h4>
268<ul>
269<li>Default: false</li>
270<li>Type: Boolean</li>
271</ul>
272<p>Operates in "global" mode, so that packages are installed into the <code>prefix</code>
273folder instead of the current working directory. See
274<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
275<ul>
276<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
277of the current working directory.</li>
278<li>bin files are linked to <code>{prefix}/bin</code></li>
279<li>man pages are linked to <code>{prefix}/share/man</code></li>
280</ul>
281<h4 id="editor"><code>editor</code></h4>
282<ul>
283<li>Default: The EDITOR or VISUAL environment variables, or
284'%SYSTEMROOT%\notepad.exe' on Windows, or 'vi' on Unix systems</li>
285<li>Type: String</li>
286</ul>
287<p>The command to run for <code>npm edit</code> and <code>npm config edit</code>.</p>
288<h4 id="location"><code>location</code></h4>
289<ul>
290<li>Default: "user" unless <code>--global</code> is passed, which will also set this value
291to "global"</li>
292<li>Type: "global", "user", or "project"</li>
293</ul>
294<p>When passed to <code>npm config</code> this refers to which config file to use.</p>
295<p>When set to "global" mode, packages are installed into the <code>prefix</code> folder
296instead of the current working directory. See
297<a href="../configuring-npm/folders.html">folders</a> for more on the differences in behavior.</p>
298<ul>
299<li>packages are installed into the <code>{prefix}/lib/node_modules</code> folder, instead
300of the current working directory.</li>
301<li>bin files are linked to <code>{prefix}/bin</code></li>
302<li>man pages are linked to <code>{prefix}/share/man</code></li>
303</ul>
304<h4 id="long"><code>long</code></h4>
305<ul>
306<li>Default: false</li>
307<li>Type: Boolean</li>
308</ul>
309<p>Show extended information in <code>ls</code>, <code>search</code>, and <code>help-search</code>.</p>
310<h3 id="see-also">See Also</h3>
311<ul>
312<li><a href="../configuring-npm/folders.html">npm folders</a></li>
313<li><a href="../commands/npm-config.html">npm config</a></li>
314<li><a href="../configuring-npm/package-json.html">package.json</a></li>
315<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
316<li><a href="../commands/npm.html">npm</a></li>
317</ul></div>
318
319<footer id="edit">
320<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-config.md">
321<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
322<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>
323</svg>
324Edit this page on GitHub
325</a>
326</footer>
327</section>
328
329
330
331</body></html>