Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 782 lines (781 sloc) 12.278 kb
f2ccd17 isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
1 .\" Generated with Ronnjs/v0.1
2 .\" http://github.com/kapouer/ronnjs/
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
3 .
0ce9853 isaacs make doc
isaacs authored
4 .TH "NPM\-CONFIG" "1" "March 2011" "" ""
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
5 .
6 .SH "NAME"
f2ccd17 isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
7 \fBnpm-config\fR \-\- Manage the npm configuration file
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
5e36298 isaacs make doc
isaacs authored
12 npm config set <key> <value> [\-\-global]
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
13 npm config get <key>
14 npm config delete <key>
15 npm config list
8a5eaa6 isaacs document config edit
isaacs authored
16 npm config edit
9796e7b isaacs Alias set/get docs to config
isaacs authored
17 npm get <key>
18 npm set <key> <value> [\-\-global]
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
19 .
20 .fi
21 .
22 .SH "DESCRIPTION"
5e36298 isaacs make doc
isaacs authored
23 npm gets its configuration values from 5 sources, in this priority:
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
24 .
f2ccd17 isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
25 .IP "\(bu" 4
26 cli:
27 The command line flags\. Putting \fB\-\-foo bar\fR on the command line sets the \fBfoo\fR configuration parameter to \fB"bar"\fR\|\. A \fB\-\-\fR argument tells the cli
28 parser to stop reading flags\. A \fB\-\-flag\fR parameter that is at the \fIend\fR of
29 the command will be given the value of \fBtrue\fR\|\.
30 .
31 .IP "\(bu" 4
32 env:
33 Any environment variables that start with \fBnpm_config_\fR will be interpreted
34 as a configuration parameter\. For example, putting \fBnpm_config_foo=bar\fR in
35 your environment will set the \fBfoo\fR configuration parameter to \fBbar\fR\|\. Any
36 environment configurations that are not given a value will be given the value
37 of \fBtrue\fR\|\. Config values are case\-insensitive, so \fBNPM_CONFIG_FOO=bar\fR will
38 work the same\.
39 .
40 .IP "\(bu" 4
41 $HOME/\.npmrc (or the \fBuserconfig\fR param, if set above):
5e36298 isaacs make doc
isaacs authored
42 This file is an ini\-file formatted list of \fBkey = value\fR parameters\.
43 .
f2ccd17 isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
44 .IP "\(bu" 4
45 $PREFIX/etc/npmrc (or the \fBglobalconfig\fR param, if set above):
5e36298 isaacs make doc
isaacs authored
46 This file is an ini\-file formatted list of \fBkey = value\fR parameters
47 .
f2ccd17 isaacs Use ronnjs instead of the ronn rubygem to build docs
isaacs authored
48 .IP "\(bu" 4
49 default configs:
50 This is a set of configuration parameters that are internal to npm, and are
51 defaults if nothing else is specified\.
52 .
53 .IP "" 0
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
54 .
55 .SH "Sub\-commands"
56 Config supports the following sub\-commands:
57 .
58 .SS "set"
59 .
60 .nf
61 npm config set key value
62 .
63 .fi
64 .
65 .P
e937a72 isaacs Update all man pages using new version of ronn
isaacs authored
66 Sets the config key to the value\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
67 .
0b249b6 isaacs make doc for 1.0
isaacs authored
68 .P
69 If value is omitted, then it sets it to "true"\.
70 .
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
71 .SS "get"
72 .
73 .nf
74 npm config get key
75 .
76 .fi
77 .
78 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
79 Echo the config value to stdout\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
80 .
81 .SS "list"
82 .
83 .nf
84 npm config list
85 .
86 .fi
87 .
88 .P
e937a72 isaacs Update all man pages using new version of ronn
isaacs authored
89 Show all the config settings\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
90 .
91 .SS "delete"
92 .
93 .nf
94 npm config delete key
95 .
96 .fi
97 .
98 .P
5e36298 isaacs make doc
isaacs authored
99 Deletes the key from all configuration files\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
100 .
8a5eaa6 isaacs document config edit
isaacs authored
101 .SS "edit"
102 .
103 .nf
104 npm config edit
105 .
106 .fi
107 .
108 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
109 Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the
110 global config\.
111 .
112 .SH "Shorthands and Other CLI Niceties"
113 The following shorthands are parsed on the command\-line:
114 .
115 .IP "\(bu" 4
116 \fB\-v\fR: \fB\-\-version\fR
117 .
118 .IP "\(bu" 4
119 \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR, \fB\-H\fR: \fB\-\-usage\fR
120 .
121 .IP "\(bu" 4
122 \fB\-s\fR, \fB\-\-silent\fR: \fB\-\-loglevel silent\fR
123 .
124 .IP "\(bu" 4
125 \fB\-d\fR: \fB\-\-loglevel info\fR
126 .
127 .IP "\(bu" 4
128 \fB\-dd\fR, \fB\-\-verbose\fR: \fB\-\-loglevel verbose\fR
129 .
130 .IP "\(bu" 4
131 \fB\-ddd\fR: \fB\-\-loglevel silly\fR
132 .
133 .IP "\(bu" 4
134 \fB\-g\fR: \fB\-\-global\fR
135 .
136 .IP "\(bu" 4
137 \fB\-l\fR: \fB\-\-long\fR
138 .
139 .IP "\(bu" 4
140 \fB\-p\fR, \fB\-\-porcelain\fR: \fB\-\-parseable\fR
141 .
142 .IP "\(bu" 4
143 \fB\-reg\fR: \fB\-\-registry\fR
144 .
145 .IP "\(bu" 4
146 \fB\-v\fR: \fB\-\-version\fR
147 .
148 .IP "\(bu" 4
149 \fB\-f\fR: \fB\-\-force\fR
150 .
151 .IP "\(bu" 4
152 \fB\-l\fR: \fB\-\-long\fR
153 .
154 .IP "\(bu" 4
155 \fB\-desc\fR: \fB\-\-description\fR
156 .
157 .IP "\(bu" 4
158 \fBll\fR and \fBla\fR commands: \fBls \-\-long\fR
159 .
160 .IP "" 0
161 .
162 .P
163 If the specified configuration param resolves unambiguously to a known
164 configuration parameter, then it is expanded to that configuration
165 parameter\. For example:
166 .
167 .IP "" 4
168 .
169 .nf
170 npm ls \-\-par
171 # same as:
172 npm ls \-\-parseable
173 .
174 .fi
175 .
176 .IP "" 0
177 .
178 .P
179 If multiple single\-character shorthands are strung together, and the
180 resulting combination is unambiguously not some other configuration
181 param, then it is expanded to its various component pieces\. For
182 example:
183 .
184 .IP "" 4
185 .
186 .nf
187 npm ls \-gpld
188 # same as:
189 npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info
190 .
191 .fi
192 .
193 .IP "" 0
8a5eaa6 isaacs document config edit
isaacs authored
194 .
39985c8 isaacs make doc
isaacs authored
195 .SH "Per\-Package Config Settings"
196 When running scripts (see \fBnpm help scripts\fR)
197 the package\.json "config" keys are overwritten in the environment if
198 there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, if
199 the package\.json has this:
200 .
201 .IP "" 4
202 .
203 .nf
204 { "name" : "foo"
205 , "config" : { "port" : "8080" }
206 , "scripts" : { "start" : "node server\.js" } }
207 .
208 .fi
209 .
210 .IP "" 0
211 .
212 .P
213 and the server\.js is this:
214 .
215 .IP "" 4
216 .
217 .nf
218 http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port)
219 .
220 .fi
221 .
222 .IP "" 0
223 .
224 .P
225 then the user could change the behavior by doing:
226 .
227 .IP "" 4
228 .
229 .nf
230 npm config set foo:port 80
231 .
232 .fi
233 .
234 .IP "" 0
235 .
57729b7 isaacs Documentation updates
isaacs authored
236 .SH "Config Settings"
237 .
0b249b6 isaacs make doc for 1.0
isaacs authored
238 .SS "browser"
239 .
240 .IP "\(bu" 4
241 Default: OS X: \fB"open"\fR, others: \fB"google\-chrome"\fR
242 .
243 .IP "\(bu" 4
244 Type: String
245 .
246 .IP "" 0
57729b7 isaacs Documentation updates
isaacs authored
247 .
248 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
249 The browser that is called by the \fBnpm docs\fR command to open websites\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
250 .
0b249b6 isaacs make doc for 1.0
isaacs authored
251 .SS "cache"
252 .
253 .IP "\(bu" 4
254 Default: Windows: \fB~/npm\-cache\fR, Posix: \fB~/\.npm\fR
255 .
256 .IP "\(bu" 4
257 Type: path
258 .
259 .IP "" 0
260 .
261 .P
262 The location of npm\'s cache directory\. See \fBnpm help cache\fR
263 .
264 .SS "color"
265 .
266 .IP "\(bu" 4
76a635f isaacs Add a rebuild-bundle config for Bryan
isaacs authored
267 Default: true
268 .
0b249b6 isaacs make doc for 1.0
isaacs authored
269 .IP "\(bu" 4
270 Type: Boolean or \fB"always"\fR
271 .
272 .IP "" 0
273 .
76a635f isaacs Add a rebuild-bundle config for Bryan
isaacs authored
274 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
275 If false, never shows colors\. If \fB"always"\fR then always shows colors\.
276 If true, then only prints color codes for tty file descriptors\.
76a635f isaacs Add a rebuild-bundle config for Bryan
isaacs authored
277 .
0b249b6 isaacs make doc for 1.0
isaacs authored
278 .SS "depth"
279 .
280 .IP "\(bu" 4
281 Default: Infinity
282 .
283 .IP "\(bu" 4
284 Type: Number
285 .
286 .IP "" 0
2881227 isaacs make doc
isaacs authored
287 .
288 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
289 The depth to go when recursing directories for \fBnpm ls\fR and \fBnpm cache ls\fR\|\.
2881227 isaacs make doc
isaacs authored
290 .
0b249b6 isaacs make doc for 1.0
isaacs authored
291 .SS "description"
2881227 isaacs make doc
isaacs authored
292 .
0b249b6 isaacs make doc for 1.0
isaacs authored
293 .IP "\(bu" 4
294 Default: true
2881227 isaacs make doc
isaacs authored
295 .
0b249b6 isaacs make doc for 1.0
isaacs authored
296 .IP "\(bu" 4
297 Type: Boolean
2881227 isaacs make doc
isaacs authored
298 .
299 .IP "" 0
300 .
301 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
302 Whether or not to show the description in \fBnpm search\fR
2881227 isaacs make doc
isaacs authored
303 .
0b249b6 isaacs make doc for 1.0
isaacs authored
304 .SS "dev"
305 .
306 .IP "\(bu" 4
307 Default: false
308 .
309 .IP "\(bu" 4
310 Type: Boolean
311 .
312 .IP "" 0
4ff3ddf isaacs Docs for loglevel conf setting.
isaacs authored
313 .
314 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
315 Whether or not to install \fBdev\-dependencies\fR along with packages\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
316 .
317 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
318 Note that \fBdev\-dependencies\fR are also installed if the \fBnpat\fR flag is
319 set\.
320 .
321 .SS "editor"
322 .
323 .IP "\(bu" 4
324 Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR
325 .
326 .IP "\(bu" 4
327 Type: path
328 .
329 .IP "" 0
329a996 isaacs Make doc (new version of ronn)
isaacs authored
330 .
331 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
332 The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\.
333 .
334 .SS "force"
329a996 isaacs Make doc (new version of ronn)
isaacs authored
335 .
336 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
337 Default: false
329a996 isaacs Make doc (new version of ronn)
isaacs authored
338 .
339 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
340 Type: Boolean
341 .
342 .IP "" 0
343 .
344 .P
345 Makes various commands more forceful\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
346 .
347 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
348 lifecycle script failure does not block progress\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
349 .
350 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
351 publishing clobbers previously published versions\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
352 .
353 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
354 skips cache when requesting from the registry\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
355 .
356 .IP "\(bu" 4
0b249b6 isaacs make doc for 1.0
isaacs authored
357 prevents checks against clobbering non\-npm files\.
329a996 isaacs Make doc (new version of ronn)
isaacs authored
358 .
359 .IP "" 0
360 .
0b249b6 isaacs make doc for 1.0
isaacs authored
361 .SS "global"
4ff3ddf isaacs Docs for loglevel conf setting.
isaacs authored
362 .
0b249b6 isaacs make doc for 1.0
isaacs authored
363 .IP "\(bu" 4
364 Default: false
a0eb2fa isaacs Rename auto-update to update-dependents, and update docs to reflect this
isaacs authored
365 .
0b249b6 isaacs make doc for 1.0
isaacs authored
366 .IP "\(bu" 4
367 Type: Boolean
a0eb2fa isaacs Rename auto-update to update-dependents, and update docs to reflect this
isaacs authored
368 .
0b249b6 isaacs make doc for 1.0
isaacs authored
369 .IP "" 0
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
370 .
371 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
372 Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory\. See \fBnpm help global\fR for more on the differences in behavior\.
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
373 .
0b249b6 isaacs make doc for 1.0
isaacs authored
374 .IP "\(bu" 4
375 packages are installed into the \fBprefix/node_modules\fR folder, instead of the
376 current working directory\.
57729b7 isaacs Documentation updates
isaacs authored
377 .
0b249b6 isaacs make doc for 1.0
isaacs authored
378 .IP "\(bu" 4
379 bin files are linked to \fBprefix/bin\fR
57729b7 isaacs Documentation updates
isaacs authored
380 .
0b249b6 isaacs make doc for 1.0
isaacs authored
381 .IP "\(bu" 4
382 man pages are linked to \fBprefix/share/man\fR
c1cc130 isaacs make doc
isaacs authored
383 .
0b249b6 isaacs make doc for 1.0
isaacs authored
384 .IP "" 0
c1cc130 isaacs make doc
isaacs authored
385 .
0b249b6 isaacs make doc for 1.0
isaacs authored
386 .SS "globalconfig"
c1cc130 isaacs make doc
isaacs authored
387 .
0b249b6 isaacs make doc for 1.0
isaacs authored
388 .IP "\(bu" 4
389 Default: {prefix}/etc/npmrc
c1cc130 isaacs make doc
isaacs authored
390 .
0b249b6 isaacs make doc for 1.0
isaacs authored
391 .IP "\(bu" 4
392 Type: path
393 .
394 .IP "" 0
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
395 .
396 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
397 The config file to read for global config options\.
398 .
399 .SS "group"
400 .
401 .IP "\(bu" 4
402 Default: GID of the current process
403 .
404 .IP "\(bu" 4
405 Type: String or Number
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
406 .
0b249b6 isaacs make doc for 1.0
isaacs authored
407 .IP "" 0
b70b2a0 isaacs Add built documentation to project, so that the install doesn't require ...
isaacs authored
408 .
409 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
410 The group to use when running package scripts in global mode as the root
411 user\.
57729b7 isaacs Documentation updates
isaacs authored
412 .
0b249b6 isaacs make doc for 1.0
isaacs authored
413 .SS "gzipbin"
57729b7 isaacs Documentation updates
isaacs authored
414 .
0b249b6 isaacs make doc for 1.0
isaacs authored
415 .IP "\(bu" 4
416 Default: "gzip"
57729b7 isaacs Documentation updates
isaacs authored
417 .
0b249b6 isaacs make doc for 1.0
isaacs authored
418 .IP "\(bu" 4
419 Type: path
57729b7 isaacs Documentation updates
isaacs authored
420 .
421 .IP "" 0
422 .
0b249b6 isaacs make doc for 1.0
isaacs authored
423 .P
424 The gzip binary
c42fe61 Cliffano Subagio Add proxy support
cliffano authored
425 .
0b249b6 isaacs make doc for 1.0
isaacs authored
426 .SS "logfd"
427 .
428 .IP "\(bu" 4
429 Default: stderr file descriptor
430 .
431 .IP "\(bu" 4
432 Type: Number or Stream
433 .
434 .IP "" 0
c42fe61 Cliffano Subagio Add proxy support
cliffano authored
435 .
436 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
437 The location to write log output\.
c42fe61 Cliffano Subagio Add proxy support
cliffano authored
438 .
0b249b6 isaacs make doc for 1.0
isaacs authored
439 .SS "loglevel"
9dd1d79 isaacs make doc
isaacs authored
440 .
0b249b6 isaacs make doc for 1.0
isaacs authored
441 .IP "\(bu" 4
442 Default: "warn"
9dd1d79 isaacs make doc
isaacs authored
443 .
0b249b6 isaacs make doc for 1.0
isaacs authored
444 .IP "\(bu" 4
445 Type: String
9dd1d79 isaacs make doc
isaacs authored
446 .
0b249b6 isaacs make doc for 1.0
isaacs authored
447 .IP "\(bu" 4
448 Values: "silent", "win", "error", "warn", "info", "verbose", "silly"
5e36298 isaacs make doc
isaacs authored
449 .
0b249b6 isaacs make doc for 1.0
isaacs authored
450 .IP "" 0
5651cdf isaacs make doc
isaacs authored
451 .
452 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
453 What level of logs to report\. On failure, \fIall\fR logs are written to \fBnpm\-debug\.log\fR in the current working directory\.
5651cdf isaacs make doc
isaacs authored
454 .
0b249b6 isaacs make doc for 1.0
isaacs authored
455 .SS "long"
5651cdf isaacs make doc
isaacs authored
456 .
0b249b6 isaacs make doc for 1.0
isaacs authored
457 .IP "\(bu" 4
458 Default: false
5e36298 isaacs make doc
isaacs authored
459 .
0b249b6 isaacs make doc for 1.0
isaacs authored
460 .IP "\(bu" 4
461 Type: Boolean
5e36298 isaacs make doc
isaacs authored
462 .
0b249b6 isaacs make doc for 1.0
isaacs authored
463 .IP "" 0
5e36298 isaacs make doc
isaacs authored
464 .
465 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
466 Whether or not to show extended information in \fBnpm ls\fR
5e36298 isaacs make doc
isaacs authored
467 .
0b249b6 isaacs make doc for 1.0
isaacs authored
468 .SS "node\-version"
6f7987b isaacs Document the 'dev' config
isaacs authored
469 .
0b249b6 isaacs make doc for 1.0
isaacs authored
470 .IP "\(bu" 4
471 Default: process\.version
6f7987b isaacs Document the 'dev' config
isaacs authored
472 .
0b249b6 isaacs make doc for 1.0
isaacs authored
473 .IP "\(bu" 4
474 Type: semver
bef47ee isaacs document "tar" conf
isaacs authored
475 .
0b249b6 isaacs make doc for 1.0
isaacs authored
476 .IP "" 0
bef47ee isaacs document "tar" conf
isaacs authored
477 .
478 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
479 The node version to use when checking package\'s "engines" hash\.
fcd9f2b isaacs Document "gzip" config
isaacs authored
480 .
0b249b6 isaacs make doc for 1.0
isaacs authored
481 .SS "npat"
fcd9f2b isaacs Document "gzip" config
isaacs authored
482 .
0b249b6 isaacs make doc for 1.0
isaacs authored
483 .IP "\(bu" 4
484 Default: false
8f3ee0c isaacs document the 'usage' config
isaacs authored
485 .
0b249b6 isaacs make doc for 1.0
isaacs authored
486 .IP "\(bu" 4
487 Type: Boolean
488 .
489 .IP "" 0
8f3ee0c isaacs document the 'usage' config
isaacs authored
490 .
491 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
492 Whether or not to run tests on installation and report results to the \fBnpaturl\fR\|\.
42b4afa isaacs make doc
isaacs authored
493 .
0b249b6 isaacs make doc for 1.0
isaacs authored
494 .SS "npaturl"
42b4afa isaacs make doc
isaacs authored
495 .
0b249b6 isaacs make doc for 1.0
isaacs authored
496 .IP "\(bu" 4
497 Default: Not yet implemented
2881227 isaacs make doc
isaacs authored
498 .
0b249b6 isaacs make doc for 1.0
isaacs authored
499 .IP "\(bu" 4
500 Type: url
501 .
502 .IP "" 0
2881227 isaacs make doc
isaacs authored
503 .
504 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
505 The url to report npat test results\.
2881227 isaacs make doc
isaacs authored
506 .
0b249b6 isaacs make doc for 1.0
isaacs authored
507 .SS "onload\-script"
2881227 isaacs make doc
isaacs authored
508 .
0b249b6 isaacs make doc for 1.0
isaacs authored
509 .IP "\(bu" 4
510 Default: false
511 .
512 .IP "\(bu" 4
513 Type: path
514 .
515 .IP "" 0
2881227 isaacs make doc
isaacs authored
516 .
517 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
518 A node module to \fBrequire()\fR when npm loads\. Useful for programmatic
519 usage\.
2881227 isaacs make doc
isaacs authored
520 .
521 .SS "outfd"
0b249b6 isaacs make doc for 1.0
isaacs authored
522 .
523 .IP "\(bu" 4
524 Default: standard output file descriptor
525 .
526 .IP "\(bu" 4
527 Type: Number or Stream
528 .
529 .IP "" 0
2881227 isaacs make doc
isaacs authored
530 .
531 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
532 Where to write "normal" output\. This has no effect on log output\.
533 .
534 .SS "parseable"
535 .
536 .IP "\(bu" 4
537 Default: false
538 .
539 .IP "\(bu" 4
540 Type: Boolean
541 .
542 .IP "" 0
2881227 isaacs make doc
isaacs authored
543 .
544 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
545 Whether or not to output parseable results from commands that write to
546 standard output\.
2881227 isaacs make doc
isaacs authored
547 .
0b249b6 isaacs make doc for 1.0
isaacs authored
548 .SS "prefix"
549 .
550 .IP "\(bu" 4
551 Default: node\'s process\.installPrefix
552 .
553 .IP "\(bu" 4
554 Type: path
555 .
556 .IP "" 0
2881227 isaacs make doc
isaacs authored
557 .
558 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
559 The location to install global items\. If set on the command line, then
560 it forces non\-global commands to run in the specified folder\.
561 .
562 .SS "proxy"
563 .
564 .IP "\(bu" 4
565 Default: "HTTP\fIPROXY" or "http\fRproxy" environment variable, or null
566 .
567 .IP "\(bu" 4
568 Type: url
569 .
570 .IP "" 0
2881227 isaacs make doc
isaacs authored
571 .
572 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
573 A proxy to use for outgoing http requests\.
574 .
575 .SS "rebuild\-bundle"
2881227 isaacs make doc
isaacs authored
576 .
0b249b6 isaacs make doc for 1.0
isaacs authored
577 .IP "\(bu" 4
578 Default: true
579 .
580 .IP "\(bu" 4
581 Type: Boolean
582 .
583 .IP "" 0
2881227 isaacs make doc
isaacs authored
584 .
585 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
586 Set to some truish value to rebuild bundled dependencies after
587 installation\.
588 .
589 .SS "registry"
590 .
591 .IP "\(bu" 4
592 Default: https://registry\.npmjs\.org/
593 .
594 .IP "\(bu" 4
595 Type: url
596 .
597 .IP "" 0
2881227 isaacs make doc
isaacs authored
598 .
599 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
600 The base URL of the npm package registry\.
2881227 isaacs make doc
isaacs authored
601 .
0b249b6 isaacs make doc for 1.0
isaacs authored
602 .SS "searchopts"
603 .
604 .IP "\(bu" 4
605 Default: ""
606 .
607 .IP "\(bu" 4
608 Type: String
609 .
610 .IP "" 0
2881227 isaacs make doc
isaacs authored
611 .
612 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
613 Space\-separated options that are always passed to search\.
614 .
615 .SS "searchexclude"
616 .
617 .IP "\(bu" 4
618 Default: ""
619 .
620 .IP "\(bu" 4
621 Type: String
622 .
623 .IP "" 0
2881227 isaacs make doc
isaacs authored
624 .
625 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
626 Space\-separated options that limit the results from search\.
2881227 isaacs make doc
isaacs authored
627 .
0b249b6 isaacs make doc for 1.0
isaacs authored
628 .SS "shell"
629 .
630 .IP "\(bu" 4
631 Default: SHELL environment variable, or "bash"
632 .
633 .IP "\(bu" 4
634 Type: path
635 .
636 .IP "" 0
2881227 isaacs make doc
isaacs authored
637 .
638 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
639 The shell to run for the \fBnpm explore\fR command\.
c1791f4 isaacs make doc
isaacs authored
640 .
0b249b6 isaacs make doc for 1.0
isaacs authored
641 .SS "tag"
642 .
643 .IP "\(bu" 4
644 Default: latest
645 .
646 .IP "\(bu" 4
647 Type: String
648 .
649 .IP "" 0
7431b8a isaacs Close GH-537 Add --listexclude config
isaacs authored
650 .
651 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
652 If you ask npm to install a package and don\'t tell it a specific version, then
653 it will install the specified tag\.
7431b8a isaacs Close GH-537 Add --listexclude config
isaacs authored
654 .
655 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
656 Also the tag that is added to the package@version specified by the \fBnpm
657 tag\fR command, if no explicit tag is given\.
7431b8a isaacs Close GH-537 Add --listexclude config
isaacs authored
658 .
0b249b6 isaacs make doc for 1.0
isaacs authored
659 .SS "tar"
c1791f4 isaacs make doc
isaacs authored
660 .
0b249b6 isaacs make doc for 1.0
isaacs authored
661 .IP "\(bu" 4
662 Default: TAR environment variable, or "tar"
663 .
664 .IP "\(bu" 4
665 Type: path
666 .
667 .IP "" 0
c1791f4 isaacs make doc
isaacs authored
668 .
669 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
670 The tar executable
671 .
672 .SS "tmp"
673 .
674 .IP "\(bu" 4
675 Default: TMPDIR environment variable, or "/tmp"
676 .
677 .IP "\(bu" 4
678 Type: path
679 .
680 .IP "" 0
c1791f4 isaacs make doc
isaacs authored
681 .
682 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
683 Where to store temporary files and folders\. All temp files are deleted
684 on success, but left behind on failure for forensic purposes\.
685 .
686 .SS "unsafe\-perm"
687 .
688 .IP "\(bu" 4
689 Default: false if running as root, true otherwise
690 .
691 .IP "\(bu" 4
692 Type: Boolean
693 .
694 .IP "" 0
c1791f4 isaacs make doc
isaacs authored
695 .
696 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
697 Set to true to suppress the UID/GID switching when running package
698 scripts\. If set explicitly to false, then installing as a non\-root user
699 will fail\.
df152ab isaacs Add the 'must-install' config, and use it in bundling
isaacs authored
700 .
0b249b6 isaacs make doc for 1.0
isaacs authored
701 .SS "usage"
702 .
703 .IP "\(bu" 4
704 Default: false
705 .
706 .IP "\(bu" 4
707 Type: Boolean
708 .
709 .IP "" 0
df152ab isaacs Add the 'must-install' config, and use it in bundling
isaacs authored
710 .
711 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
712 Set to show short usage output (like the \-H output)
713 instead of complete help when doing \fBnpm help\fR\|\.
5651cdf isaacs make doc
isaacs authored
714 .
0b249b6 isaacs make doc for 1.0
isaacs authored
715 .SS "user"
716 .
717 .IP "\(bu" 4
718 Default: "nobody"
719 .
720 .IP "\(bu" 4
721 Type: String or Number
722 .
723 .IP "" 0
5651cdf isaacs make doc
isaacs authored
724 .
725 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
726 The UID to set to when running package scripts as root\.
727 .
728 .SS "username"
b6828d5 isaacs Add --node-version config to override engine checking
isaacs authored
729 .
0b249b6 isaacs make doc for 1.0
isaacs authored
730 .IP "\(bu" 4
731 Default: null
732 .
733 .IP "\(bu" 4
734 Type: String
735 .
736 .IP "" 0
b6828d5 isaacs Add --node-version config to override engine checking
isaacs authored
737 .
738 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
739 The username on the npm registry\. Set with \fBnpm adduser\fR
740 .
741 .SS "userconfig"
742 .
743 .IP "\(bu" 4
744 Default: ~/\.npmrc on Posix, or ~/npm\-config on Windows
745 .
746 .IP "\(bu" 4
747 Type: path
748 .
749 .IP "" 0
b6828d5 isaacs Add --node-version config to override engine checking
isaacs authored
750 .
751 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
752 The location of user\-level configuration settings\.
63b5434 isaacs Fix #539 Implement configurable "onload-script"
isaacs authored
753 .
0b249b6 isaacs make doc for 1.0
isaacs authored
754 .SS "version"
755 .
756 .IP "\(bu" 4
63b5434 isaacs Fix #539 Implement configurable "onload-script"
isaacs authored
757 Default: false
758 .
0b249b6 isaacs make doc for 1.0
isaacs authored
759 .IP "\(bu" 4
760 Type: boolean
761 .
762 .IP "" 0
763 .
63b5434 isaacs Fix #539 Implement configurable "onload-script"
isaacs authored
764 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
765 If true, output the npm version and exit successfully\.
766 .
767 .P
768 Only relevant when specified explicitly on the command line\.
769 .
770 .SS "viewer"
771 .
772 .IP "\(bu" 4
773 Default: "man"
774 .
775 .IP "\(bu" 4
776 Type: path
777 .
778 .IP "" 0
63b5434 isaacs Fix #539 Implement configurable "onload-script"
isaacs authored
779 .
780 .P
0b249b6 isaacs make doc for 1.0
isaacs authored
781 The program to use to view help content\.
Something went wrong with that request. Please try again.