deps/npm/man/man3/npm-config.3

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-CONFIG" "3" "November 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-config\fR \-\- Manage the npm configuration files
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm\.commands\.config(args, callback)
  13 var val = npm\.config\.get(key)
  14 npm\.config\.set(key, val)
  15 .
  16 .fi
  17 .
  18 .SH "DESCRIPTION"
  19 This function acts much the same way as the command\-line version\.  The first
  20 element in the array tells config what to do\. Possible values are:
  21 .
  22 .IP "\(bu" 4
  23 \fBset\fR
  24 .
  25 .IP
  26 Sets a config parameter\.  The second element in \fBargs\fR is interpreted as the
  27 key, and the third element is interpreted as the value\.
  28 .
  29 .IP "\(bu" 4
  30 \fBget\fR
  31 .
  32 .IP
  33 Gets the value of a config parameter\. The second element in \fBargs\fR is the
  34 key to get the value of\.
  35 .
  36 .IP "\(bu" 4
  37 \fBdelete\fR (\fBrm\fR or \fBdel\fR)
  38 .
  39 .IP
  40 Deletes a parameter from the config\. The second element in \fBargs\fR is the
  41 key to delete\.
  42 .
  43 .IP "\(bu" 4
  44 \fBlist\fR (\fBls\fR)
  45 .
  46 .IP
  47 Show all configs that aren\'t secret\. No parameters necessary\.
  48 .
  49 .IP "\(bu" 4
  50 \fBedit\fR:
  51 .
  52 .IP
  53 Opens the config file in the default editor\. This command isn\'t very useful
  54 programmatically, but it is made available\.
  55 .
  56 .IP "" 0
  57 .
  58 .P
  59 To programmatically access npm configuration settings, or set them for
  60 the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR
  61 functions instead\.
  62 .
  63 .SH "SEE ALSO"
  64 .
  65 .IP "\(bu" 4
  66 npm apihelp npm
  67 .
  68 .IP "" 0
  69