1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
|
<!doctype html>
<html>
<title>config</title>
<meta http-equiv="content-type" value="text/html;utf-8">
<link rel="stylesheet" type="text/css" href="../static/style.css">
<body>
<div id="wrapper">
<h1><a href="../doc/config.html">config</a></h1> <p>Manage the npm configuration file</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<pre><code>npm config set <key> <value> [--global]
npm config get <key>
npm config delete <key>
npm config list
npm config edit
npm get <key>
npm set <key> <value> [--global]</code></pre>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>npm gets its configuration values from 6 sources, in this priority:</p>
<h3 id="Command-Line-Flags">Command Line Flags</h3>
<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. A <code>--flag</code> parameter that is at the <em>end</em> of
the command will be given the value of <code>true</code>.</p>
<h3 id="Environment-Variables">Environment Variables</h3>
<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.</p>
<h3 id="Per-user-config-file">Per-user config file</h3>
<p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set above)</p>
<p>This file is an ini-file formatted list of <code>key = value</code> parameters.</p>
<h3 id="Global-config-file">Global config file</h3>
<p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above):
This file is an ini-file formatted list of <code>key = value</code> parameters</p>
<h3 id="Built-in-config-file">Built-in config file</h3>
<p><code>path/to/npm/itself/npmrc</code></p>
<p>This is an unchangeable "builtin"
configuration file that npm keeps consistent across updates. Set
fields in here using the <code>./configure</code> script that comes with npm.
This is primarily for distribution maintainers to override default
configs in a standard and consistent manner.</p>
<h3 id="Default-Configs">Default Configs</h3>
<p>A set of configuration parameters that are internal to npm, and are
defaults if nothing else is specified.</p>
<h2 id="Sub-commands">Sub-commands</h2>
<p>Config supports the following sub-commands:</p>
<h3 id="set">set</h3>
<pre><code>npm config set key value</code></pre>
<p>Sets the config key to the value.</p>
<p>If value is omitted, then it sets it to "true".</p>
<h3 id="get">get</h3>
<pre><code>npm config get key</code></pre>
<p>Echo the config value to stdout.</p>
<h3 id="list">list</h3>
<pre><code>npm config list</code></pre>
<p>Show all the config settings.</p>
<h3 id="delete">delete</h3>
<pre><code>npm config delete key</code></pre>
<p>Deletes the key from all configuration files.</p>
<h3 id="edit">edit</h3>
<pre><code>npm config edit</code></pre>
<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the
global config.</p>
<h2 id="Shorthands-and-Other-CLI-Niceties">Shorthands and Other CLI Niceties</h2>
<p>The following shorthands are parsed on the command-line:</p>
<ul><li><code>-v</code>: <code>--version</code></li><li><code>-h</code>, <code>-?</code>, <code>--help</code>, <code>-H</code>: <code>--usage</code></li><li><code>-s</code>, <code>--silent</code>: <code>--loglevel silent</code></li><li><code>-q</code>, <code>--quiet</code>: <code>--loglevel warn</code></li><li><code>-d</code>: <code>--loglevel info</code></li><li><code>-dd</code>, <code>--verbose</code>: <code>--loglevel verbose</code></li><li><code>-ddd</code>: <code>--loglevel silly</code></li><li><code>-g</code>: <code>--global</code></li><li><code>-l</code>: <code>--long</code></li><li><code>-m</code>: <code>--message</code></li><li><code>-p</code>, <code>--porcelain</code>: <code>--parseable</code></li><li><code>-reg</code>: <code>--registry</code></li><li><code>-v</code>: <code>--version</code></li><li><code>-f</code>: <code>--force</code></li><li><code>-l</code>: <code>--long</code></li><li><code>-desc</code>: <code>--description</code></li><li><code>-S</code>: <code>--save</code></li><li><code>-D</code>: <code>--save-dev</code></li><li><code>-O</code>: <code>--save-optional</code></li><li><code>-B</code>: <code>--save-bundle</code></li><li><code>-y</code>: <code>--yes</code></li><li><code>-n</code>: <code>--yes false</code></li><li><code>ll</code> and <code>la</code> commands: <code>ls --long</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>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>npm ls -gpld
# same as:
npm ls --global --parseable --long --loglevel info</code></pre>
<h2 id="Per-Package-Config-Settings">Per-Package Config Settings</h2>
<p>When running scripts (see <code><a href="../doc/scripts.html">scripts(1)</a></code>)
the package.json "config" keys are overwritten in the environment if
there is a config param of <code><name>[@<version>]:<key></code>. For example, if
the package.json has this:</p>
<pre><code>{ "name" : "foo"
, "config" : { "port" : "8080" }
, "scripts" : { "start" : "node server.js" } }</code></pre>
<p>and the server.js is this:</p>
<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)</code></pre>
<p>then the user could change the behavior by doing:</p>
<pre><code>npm config set foo:port 80</code></pre>
<h2 id="Config-Settings">Config Settings</h2>
<h3 id="always-auth">always-auth</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Force npm to always require authentication when accessing the registry,
even for <code>GET</code> requests.</p>
<h3 id="browser">browser</h3>
<ul><li>Default: OS X: <code>"open"</code>, others: <code>"google-chrome"</code></li><li>Type: String</li></ul>
<p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
<h3 id="ca">ca</h3>
<ul><li>Default: The npm CA certificate</li><li>Type: String or null</li></ul>
<p>The Certificate Authority signing certificate that is trusted for SSL
connections to the registry.</p>
<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>See also the <code>strict-ssl</code> config.</p>
<h3 id="cache">cache</h3>
<ul><li>Default: Windows: <code>%APPDATA%\npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul>
<p>The location of npm's cache directory. See <code><a href="../doc/cache.html">cache(1)</a></code></p>
<h3 id="cache-lock-stale">cache-lock-stale</h3>
<ul><li>Default: 60000 (1 minute)</li><li>Type: Number</li></ul>
<p>The number of ms before cache folder lockfiles are considered stale.</p>
<h3 id="cache-lock-retries">cache-lock-retries</h3>
<ul><li>Default: 10</li><li>Type: Number</li></ul>
<p>Number of times to retry to acquire a lock on cache folder lockfiles.</p>
<h3 id="cache-lock-wait">cache-lock-wait</h3>
<ul><li>Default: 10000 (10 seconds)</li><li>Type: Number</li></ul>
<p>Number of ms to wait for cache lock files to expire.</p>
<h3 id="cache-max">cache-max</h3>
<ul><li>Default: Infinity</li><li>Type: Number</li></ul>
<p>The maximum time (in seconds) to keep items in the registry cache before
re-checking against the registry.</p>
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
explicitly used, and that only GET requests use the cache.</p>
<h3 id="cache-min">cache-min</h3>
<ul><li>Default: 0</li><li>Type: Number</li></ul>
<p>The minimum time (in seconds) to keep items in the registry cache before
re-checking against the registry.</p>
<p>Note that no purging is done unless the <code>npm cache clean</code> command is
explicitly used, and that only GET requests use the cache.</p>
<h3 id="color">color</h3>
<ul><li>Default: true on Posix, false on Windows</li><li>Type: Boolean or <code>"always"</code></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>
<h3 id="coverage">coverage</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>A flag to tell test-harness to run with their coverage options enabled,
if they respond to the <code>npm_config_coverage</code> environment variable.</p>
<h3 id="depth">depth</h3>
<ul><li>Default: Infinity</li><li>Type: Number</li></ul>
<p>The depth to go when recursing directories for <code>npm ls</code> and
<code>npm cache ls</code>.</p>
<h3 id="description">description</h3>
<ul><li>Default: true</li><li>Type: Boolean</li></ul>
<p>Show the description in <code>npm search</code></p>
<h3 id="dev">dev</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Install <code>dev-dependencies</code> along with packages.</p>
<p>Note that <code>dev-dependencies</code> are also installed if the <code>npat</code> flag is
set.</p>
<h3 id="editor">editor</h3>
<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix,
or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul>
<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</p>
<h3 id="engine-strict">engine-strict</h3>
<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>
<h3 id="force">force</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Makes various commands more forceful.</p>
<ul><li>lifecycle script failure does not block progress.</li><li>publishing clobbers previously published versions.</li><li>skips cache when requesting from the registry.</li><li>prevents checks against clobbering non-npm files.</li></ul>
<h3 id="fetch-retries">fetch-retries</h3>
<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>
<h3 id="fetch-retry-factor">fetch-retry-factor</h3>
<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>
<h3 id="fetch-retry-mintimeout">fetch-retry-mintimeout</h3>
<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>
<h3 id="fetch-retry-maxtimeout">fetch-retry-maxtimeout</h3>
<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>
<h3 id="git">git</h3>
<ul><li>Default: <code>"git"</code></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>
<h3 id="global">global</h3>
<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
<code><a href="../doc/folders.html">folders(1)</a></code> for more on the differences in behavior.</p>
<ul><li>packages are installed into the <code>prefix/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>
<h3 id="globalconfig">globalconfig</h3>
<ul><li>Default: {prefix}/etc/npmrc</li><li>Type: path</li></ul>
<p>The config file to read for global config options.</p>
<h3 id="globalignorefile">globalignorefile</h3>
<ul><li>Default: {prefix}/etc/npmignore</li><li>Type: path</li></ul>
<p>The config file to read for global ignore patterns to apply to all users
and all projects.</p>
<p>If not found, but there is a "gitignore" file in the
same directory, then that will be used instead.</p>
<h3 id="group">group</h3>
<ul><li>Default: GID of the current process</li><li>Type: String or Number</li></ul>
<p>The group to use when running package scripts in global mode as the root
user.</p>
<h3 id="https-proxy">https-proxy</h3>
<ul><li>Default: the <code>HTTPS_PROXY</code> or <code>https_proxy</code> or <code>HTTP_PROXY</code> or
<code>http_proxy</code> environment variables.</li><li>Type: url</li></ul>
<p>A proxy to use for outgoing https requests.</p>
<h3 id="user-agent">user-agent</h3>
<ul><li>Default: npm/{npm.version} node/{process.version}</li><li>Type: String</li></ul>
<p>Sets a User-Agent to the request header</p>
<h3 id="ignore">ignore</h3>
<ul><li>Default: ""</li><li>Type: string</li></ul>
<p>A white-space separated list of glob patterns of files to always exclude
from packages when building tarballs.</p>
<h3 id="init-module">init-module</h3>
<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/isaacs/init-package-json">init-package-json</a> module
for more information, or <a href="../doc/init.html">init(1)</a>.</p>
<h3 id="init-version">init.version</h3>
<ul><li>Default: "0.0.0"</li><li>Type: semver</li></ul>
<p>The value <code>npm init</code> should use by default for the package version.</p>
<h3 id="init-author-name">init.author.name</h3>
<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>
<h3 id="init-author-email">init.author.email</h3>
<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>
<h3 id="init-author-url">init.author.url</h3>
<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 homepage.</p>
<h3 id="json">json</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Whether or not to output JSON data, rather than the normal output.</p>
<p>This feature is currently experimental, and the output data structures
for many commands is either not implemented in JSON yet, or subject to
change. Only the output from <code>npm ls --json</code> is currently valid.</p>
<h3 id="link">link</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>If true, then local installs will link if there is a suitable globally
installed package.</p>
<p>Note that this means that local installs can cause things to be
installed into the global space at the same time. The link is only done
if one of the two conditions are met:</p>
<ul><li>The package is not already installed globally, or</li><li>the globally installed version is identical to the version that is
being installed locally.</li></ul>
<h3 id="loglevel">loglevel</h3>
<ul><li>Default: "http"</li><li>Type: String</li><li>Values: "silent", "win", "error", "warn", "http", "info", "verbose", "silly"</li></ul>
<p>What level of logs to report. On failure, <em>all</em> logs are written to
<code>npm-debug.log</code> in the current working directory.</p>
<p>Any logs of a higher level than the setting are shown.
The default is "http", which shows http, warn, and error output.</p>
<h3 id="logstream">logstream</h3>
<ul><li>Default: process.stderr</li><li>Type: Stream</li></ul>
<p>This is the stream that is passed to the
<a href="https://github.com/isaacs/npmlog">npmlog</a> module at run time.</p>
<p>It cannot be set from the command line, but if you are using npm
programmatically, you may wish to send logs to somewhere other than
stderr.</p>
<p>If the <code>color</code> config is set to true, then this stream will receive
colored output if it is a TTY.</p>
<h3 id="long">long</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Show extended information in <code>npm ls</code></p>
<h3 id="message">message</h3>
<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>
<h3 id="node-version">node-version</h3>
<ul><li>Default: process.version</li><li>Type: semver or false</li></ul>
<p>The node version to use when checking package's "engines" hash.</p>
<h3 id="npat">npat</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Run tests on installation and report results to the
<code>npaturl</code>.</p>
<h3 id="npaturl">npaturl</h3>
<ul><li>Default: Not yet implemented</li><li>Type: url</li></ul>
<p>The url to report npat test results.</p>
<h3 id="onload-script">onload-script</h3>
<ul><li>Default: false</li><li>Type: path</li></ul>
<p>A node module to <code>require()</code> when npm loads. Useful for programmatic
usage.</p>
<h3 id="optional">optional</h3>
<ul><li>Default: true</li><li>Type: Boolean</li></ul>
<p>Attempt to install packages in the <code>optionalDependencies</code> hash. Note
that if these packages fail to install, the overall installation
process is not aborted.</p>
<h3 id="parseable">parseable</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Output parseable results from commands that write to
standard output.</p>
<h3 id="prefix">prefix</h3>
<ul><li>Default: node's process.installPrefix</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>
<h3 id="production">production</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Set to true to run in "production" mode.</p>
<ol><li>devDependencies are not installed at the topmost level when running
local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV="production" for lifecycle scripts.</li></ol>
<h3 id="proprietary-attribs">proprietary-attribs</h3>
<ul><li>Default: true</li><li>Type: Boolean</li></ul>
<p>Whether or not to include proprietary extended attributes in the
tarballs created by npm.</p>
<p>Unless you are expecting to unpack package tarballs with something other
than npm -- particularly a very outdated tar implementation -- leave
this as true.</p>
<h3 id="proxy">proxy</h3>
<ul><li>Default: <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variable, or null</li><li>Type: url</li></ul>
<p>A proxy to use for outgoing http requests.</p>
<h3 id="rebuild-bundle">rebuild-bundle</h3>
<ul><li>Default: true</li><li>Type: Boolean</li></ul>
<p>Rebuild bundled dependencies after installation.</p>
<h3 id="registry">registry</h3>
<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
<p>The base URL of the npm package registry.</p>
<h3 id="rollback">rollback</h3>
<ul><li>Default: true</li><li>Type: Boolean</li></ul>
<p>Remove failed installs.</p>
<h3 id="save">save</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Save installed packages to a package.json file as dependencies.</p>
<p>When used with the <code>npm rm</code> command, it removes it from the dependencies
hash.</p>
<p>Only works if there is already a package.json file present.</p>
<h3 id="save-bundle">save-bundle</h3>
<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>When used with the <code>npm rm</code> command, it removes it from the
bundledDependencies list.</p>
<h3 id="save-dev">save-dev</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Save installed packages to a package.json file as devDependencies.</p>
<p>When used with the <code>npm rm</code> command, it removes it from the devDependencies
hash.</p>
<p>Only works if there is already a package.json file present.</p>
<h3 id="save-optional">save-optional</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Save installed packages to a package.json file as optionalDependencies.</p>
<p>When used with the <code>npm rm</code> command, it removes it from the devDependencies
hash.</p>
<p>Only works if there is already a package.json file present.</p>
<h3 id="searchopts">searchopts</h3>
<ul><li>Default: ""</li><li>Type: String</li></ul>
<p>Space-separated options that are always passed to search.</p>
<h3 id="searchexclude">searchexclude</h3>
<ul><li>Default: ""</li><li>Type: String</li></ul>
<p>Space-separated options that limit the results from search.</p>
<h3 id="searchsort">searchsort</h3>
<ul><li>Default: "name"</li><li>Type: String</li><li>Values: "name", "-name", "date", "-date", "description",
"-description", "keywords", "-keywords"</li></ul>
<p>Indication of which field to sort search results by. Prefix with a <code>-</code>
character to indicate reverse sort.</p>
<h3 id="shell">shell</h3>
<ul><li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
Windows</li><li>Type: path</li></ul>
<p>The shell to run for the <code>npm explore</code> command.</p>
<h3 id="sign-git-tag">sign-git-tag</h3>
<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>
<h3 id="strict-ssl">strict-ssl</h3>
<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>
<h3 id="tag">tag</h3>
<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>Also the tag that is added to the package@version specified by the <code>npm
tag</code> command, if no explicit tag is given.</p>
<h3 id="tmp">tmp</h3>
<ul><li>Default: TMPDIR environment variable, or "/tmp"</li><li>Type: path</li></ul>
<p>Where to store temporary files and folders. All temp files are deleted
on success, but left behind on failure for forensic purposes.</p>
<h3 id="unicode">unicode</h3>
<ul><li>Default: true</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 to draw trees.</p>
<h3 id="unsafe-perm">unsafe-perm</h3>
<ul><li>Default: false if running as root, true otherwise</li><li>Type: Boolean</li></ul>
<p>Set to true to suppress the UID/GID switching when running package
scripts. If set explicitly to false, then installing as a non-root user
will fail.</p>
<h3 id="usage">usage</h3>
<ul><li>Default: false</li><li>Type: Boolean</li></ul>
<p>Set to show short usage output (like the -H output)
instead of complete help when doing <code><a href="../doc/help.html">help(1)</a></code>.</p>
<h3 id="user">user</h3>
<ul><li>Default: "nobody"</li><li>Type: String or Number</li></ul>
<p>The UID to set to when running package scripts as root.</p>
<h3 id="username">username</h3>
<ul><li>Default: null</li><li>Type: String</li></ul>
<p>The username on the npm registry. Set with <code>npm adduser</code></p>
<h3 id="userconfig">userconfig</h3>
<ul><li>Default: ~/.npmrc</li><li>Type: path</li></ul>
<p>The location of user-level configuration settings.</p>
<h3 id="userignorefile">userignorefile</h3>
<ul><li>Default: ~/.npmignore</li><li>Type: path</li></ul>
<p>The location of a user-level ignore file to apply to all packages.</p>
<p>If not found, but there is a .gitignore file in the same directory, then
that will be used instead.</p>
<h3 id="umask">umask</h3>
<ul><li>Default: 022</li><li>Type: Octal numeric string</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>0777</code> masked against
this value. Other files are given a mode which is <code>0666</code> masked against
this value. Thus, the defaults are <code>0755</code> and <code>0644</code> respectively.</p>
<h3 id="version">version</h3>
<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>
<h3 id="versions">versions</h3>
<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>
hash, and exit successfully.</p>
<p>Only relevant when specified explicitly on the command line.</p>
<h3 id="viewer">viewer</h3>
<ul><li>Default: "man" on Posix, "browser" on Windows</li><li>Type: path</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>
<h3 id="yes">yes</h3>
<ul><li>Default: null</li><li>Type: Boolean or null</li></ul>
<p>If set to <code>null</code>, then prompt the user for responses in some
circumstances.</p>
<p>If set to <code>true</code>, then answer "yes" to any prompt. If set to <code>false</code>
then answer "no" to any prompt.</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<ul><li><a href="../doc/folders.html">folders(1)</a></li><li><a href="../doc/npm.html">npm(1)</a></li></ul>
</div>
<p id="footer">config — npm@1.1.59</p>
<script>
;(function () {
var wrapper = document.getElementById("wrapper")
var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
.filter(function (el) {
return el.parentNode === wrapper
&& el.tagName.match(/H[1-6]/)
&& el.id
})
var l = 2
, toc = document.createElement("ul")
toc.innerHTML = els.map(function (el) {
var i = el.tagName.charAt(1)
, out = ""
while (i > l) {
out += "<ul>"
l ++
}
while (i < l) {
out += "</ul>"
l --
}
out += "<li><a href='#" + el.id + "'>" +
( el.innerText || el.text || el.innerHTML)
+ "</a>"
return out
}).join("\n")
toc.id = "toc"
document.body.appendChild(toc)
})()
</script>
</body></html>
|
