deps/npm/man/man1/npm.1

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM" "1" "December 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm\fR \-\- node package manager
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm <command> [args]
  13 .
  14 .fi
  15 .
  16 .SH "VERSION"
  17 1.3.17
  18 .
  19 .SH "DESCRIPTION"
  20 npm is the package manager for the Node JavaScript platform\.  It puts
  21 modules in place so that node can find them, and manages dependency
  22 conflicts intelligently\.
  23 .
  24 .P
  25 It is extremely configurable to support a wide variety of use cases\.
  26 Most commonly, it is used to publish, discover, install, and develop node
  27 programs\.
  28 .
  29 .P
  30 Run \fBnpm help\fR to get a list of available commands\.
  31 .
  32 .SH "INTRODUCTION"
  33 You probably got npm because you want to install stuff\.
  34 .
  35 .P
  36 npm help Use \fBnpm install blerg\fR to install the latest version of "blerg"\.  Check out \fBnpm\-install\fR for more info\.  It can do a lot of stuff\.
  37 .
  38 .P
  39 Use the \fBnpm search\fR command to show everything that\'s available\.
  40 Use \fBnpm ls\fR to show everything you\'ve installed\.
  41 .
  42 .SH "DIRECTORIES"
  43 npm help  See \fBnpm\-folders\fR to learn about where npm puts stuff\.
  44 .
  45 .P
  46 In particular, npm has two modes of operation:
  47 .
  48 .IP "\(bu" 4
  49 global mode:
  50 .
  51 .br
  52 npm installs packages into the install prefix at \fBprefix/lib/node_modules\fR and bins are installed in \fBprefix/bin\fR\|\.
  53 .
  54 .IP "\(bu" 4
  55 local mode:
  56 .
  57 .br
  58 npm installs packages into the current project directory, which
  59 defaults to the current working directory\.  Packages are installed to \fB\|\./node_modules\fR, and bins are installed to \fB\|\./node_modules/\.bin\fR\|\.
  60 .
  61 .IP "" 0
  62 .
  63 .P
  64 Local mode is the default\.  Use \fB\-\-global\fR or \fB\-g\fR on any command to
  65 operate in global mode instead\.
  66 .
  67 .SH "DEVELOPER USAGE"
  68 If you\'re using npm to develop and publish your code, check out the
  69 following help topics:
  70 .
  71 .IP "\(bu" 4
  72 json:
  73 npm help  Make a package\.json file\.  See \fBpackage\.json\fR\|\.
  74 .
  75 .IP "\(bu" 4
  76 link:
  77 For linking your current working code into Node\'s path, so that you
  78 don\'t have to reinstall every time you make a change\.  Use \fBnpm link\fR to do this\.
  79 .
  80 .IP "\(bu" 4
  81 install:
  82 It\'s a good idea to install things if you don\'t need the symbolic link\.
  83 Especially, installing other peoples code from the registry is done via \fBnpm install\fR
  84 .
  85 .IP "\(bu" 4
  86 adduser:
  87 Create an account or log in\.  Credentials are stored in the
  88 user config file\.
  89 .
  90 .IP "\(bu" 4
  91 publish:
  92 Use the \fBnpm publish\fR command to upload your code to the registry\.
  93 .
  94 .IP "" 0
  95 .
  96 .SH "CONFIGURATION"
  97 npm is extremely configurable\.  It reads its configuration options from
  98 5 places\.
  99 .
 100 .IP "\(bu" 4
 101 Command line switches:
 102 .
 103 .br
 104 Set a config with \fB\-\-key val\fR\|\.  All keys take a value, even if they
 105 are booleans (the config parser doesn\'t know what the options are at
 106 the time of parsing\.)  If no value is provided, then the option is set
 107 to boolean \fBtrue\fR\|\.
 108 .
 109 .IP "\(bu" 4
 110 Environment Variables:
 111 .
 112 .br
 113 Set any config by prefixing the name in an environment variable with \fBnpm_config_\fR\|\.  For example, \fBexport npm_config_key=val\fR\|\.
 114 .
 115 .IP "\(bu" 4
 116 User Configs:
 117 .
 118 .br
 119 The file at $HOME/\.npmrc is an ini\-formatted list of configs\.  If
 120 present, it is parsed\.  If the \fBuserconfig\fR option is set in the cli
 121 or env, then that will be used instead\.
 122 .
 123 .IP "\(bu" 4
 124 Global Configs:
 125 .
 126 .br
 127 The file found at \.\./etc/npmrc (from the node executable, by default
 128 this resolves to /usr/local/etc/npmrc) will be parsed if it is found\.
 129 If the \fBglobalconfig\fR option is set in the cli, env, or user config,
 130 then that file is parsed instead\.
 131 .
 132 .IP "\(bu" 4
 133 Defaults:
 134 .
 135 .br
 136 npm\'s default configuration options are defined in
 137 lib/utils/config\-defs\.js\.  These must not be changed\.
 138 .
 139 .IP "" 0
 140 .
 141 .P
 142 npm help  See \fBnpm\-config\fR for much much more information\.
 143 .
 144 .SH "CONTRIBUTIONS"
 145 Patches welcome!
 146 .
 147 .IP "\(bu" 4
 148 code:
 149 npm help  Read through \fBnpm\-coding\-style\fR if you plan to submit code\.
 150 You don\'t have to agree with it, but you do have to follow it\.
 151 .
 152 .IP "\(bu" 4
 153 docs:
 154 If you find an error in the documentation, edit the appropriate markdown
 155 file in the "doc" folder\.  (Don\'t worry about generating the man page\.)
 156 .
 157 .IP "" 0
 158 .
 159 .P
 160 Contributors are listed in npm\'s \fBpackage\.json\fR file\.  You can view them
 161 easily by doing \fBnpm view npm contributors\fR\|\.
 162 .
 163 .P
 164 If you would like to contribute, but don\'t know what to work on, check
 165 the issues list or ask on the mailing list\.
 166 .
 167 .IP "\(bu" 4
 168 \fIhttp://github\.com/isaacs/npm/issues\fR
 169 .
 170 .IP "\(bu" 4
 171 \fInpm\-@googlegroups\.com\fR
 172 .
 173 .IP "" 0
 174 .
 175 .SH "BUGS"
 176 When you find issues, please report them:
 177 .
 178 .IP "\(bu" 4
 179 web: \fIhttp://github\.com/isaacs/npm/issues\fR
 180 .
 181 .IP "\(bu" 4
 182 email: \fInpm\-@googlegroups\.com\fR
 183 .
 184 .IP "" 0
 185 .
 186 .P
 187 Be sure to include \fIall\fR of the output from the npm command that didn\'t work
 188 as expected\.  The \fBnpm\-debug\.log\fR file is also helpful to provide\.
 189 .
 190 .P
 191 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\.  He
 192 will no doubt tell you to put the output in a gist or email\.
 193 .
 194 .SH "AUTHOR"
 195 Isaac Z\. Schlueter \fIhttp://blog\.izs\.me/\fR :: isaacs \fIhttps://github\.com/isaacs/\fR :: @izs \fIhttp://twitter\.com/izs\fR :: \fIi@izs\.me\fR
 196 .
 197 .SH "SEE ALSO"
 198 .
 199 .IP "\(bu" 4
 200 npm help help
 201 .
 202 .IP "\(bu" 4
 203 npm help  faq
 204 .
 205 .IP "\(bu" 4
 206 README
 207 .
 208 .IP "\(bu" 4
 209 npm help  package\.json
 210 .
 211 .IP "\(bu" 4
 212 npm help install
 213 .
 214 .IP "\(bu" 4
 215 npm help config
 216 .
 217 .IP "\(bu" 4
 218 npm help  config
 219 .
 220 .IP "\(bu" 4
 221 npm help  npmrc
 222 .
 223 .IP "\(bu" 4
 224 npm help  index
 225 .
 226 .IP "\(bu" 4
 227 npm apihelp npm
 228 .
 229 .IP "" 0
 230