Skip to content
This repository
tag: v0.2.7-2
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 548 lines (546 sloc) 9.328 kb
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
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm\fR \-\- node package manager
.
.SH "SYNOPSIS"
.
.nf
npm <command> [args]
.
.fi
.
.SH "DESCRIPTION"
npm is a package manager for the Node javascript library\.
.
.P
Run \fBnpm help\fR to get a list of commands\.
.
.SH "STATUS: Useful Beta"
The core functionality is there\. It works\.
.
.P
Please use this software\. It will cut you occasionally\. Let me know when
you find a rough edge, and I\'ll sand it down for you\.
.
.P
I appreciate your sense of adventure\.
.
.SH "INTRO"
You probably got npm because you want to install stuff\.
.
.P
Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm help install\fR for more info\. It can do a lot of stuff\.
.
.P
Use the \fBnpm ls\fR command to show everything that\'s available\. Looking for
express\-related modules? \fBnpm ls express\fR\|\. Looking for the latest express? \fBnpm ls express latest\fR\|\. (The arguments are just simple greps\.) And of course, \fBnpm help ls\fR will tell you more\.
.
.P
Use \fBnpm ls installed\fR to show everything you\'ve installed\.
.
.SH "CONFIGS"
Use the \fBnpm config\fR command to manage how npm does stuff and where it puts things\.
It stores your configs in the \fB~/\.npmrc\fR file\. Check \fBnpm help config\fR for more
info on that, if you care\.
.
.P
You can override any config for just a single command by doing \fB\-\-configname value\fR
on the command line\.
.
.SH "DEVELOPERS"
If you\'re using npm to develop and publish your code, check out the following topics:
.
.IP "\(bu" 4
json:
Make a package\.json file\. The "json" help doc will tell you what to put in it\.
.
.IP "\(bu" 4
link:
For linking your current working code into Node\'s path, so that you don\'t have to
reinstall every time you make a change\. Use "npm link" to do this\.
.
.IP "\(bu" 4
install:
It\'s a good idea to install things if you don\'t need the symbolic link\. Especially,
installing other peoples code from the registry is done via "npm install"\.
.
.IP "\(bu" 4
adduser:
Use the \fBnpm adduser\fR command to add a user account for the npm registry, or to
authorize yourself on a new machine\. If you forget your password, send an email
to \fInpm\-@googlegroups\.com\fR and we\'ll delete your account so you can recreate it\.
.
.IP "\(bu" 4
publish:
Use the \fBnpm publish\fR command to upload your code to the registry, so that other
people can install it easily\.
.
.IP "" 0
.
.SH "CONTRIBUTIONS"
Patches welcome!
.
.IP "\(bu" 4
code:
Read through \fBnpm help coding\-style\fR if you plan to submit code\. You don\'t have to
agree with it, but you do have to follow it\.
.
.IP "\(bu" 4
docs:
If you find an error in the documentation, edit the appropriate markdown file in the
"doc" folder\. (Don\'t worry about generating the man page\.)
.
.IP "" 0
.
.P
Contributors are listed in npm\'s \fBpackage\.json\fR file\.
.
.SH "PRINCIPLES"
Put the files where they need to be so that node can find them using the
methods it already uses\.
.
.P
Be lazy, not clever\.
.
.P
The file system is the database\.
.
.P
Sync with habits that are already in use\.
.
.P
Packages should be maintained by their authors, not by the package manager
author\.
.
.P
Steer clear of dependency hell\.
.
.SH "BUGS"
Plenty\. Luckily, npm is actively maintained as of this writing\.
.
.P
When you find issues, please report them:
.
.IP "\(bu" 4
web: \fIhttp://github\.com/isaacs/npm/issues\fR
.
.IP "\(bu" 4
email: \fInpm\-@googlegroups\.com\fR
.
.IP "" 0
.
.P
Be sure to include \fIall\fR of the output from the npm command that didn\'t work
as expected\.
.
.P
You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\.
.
.SH "HISTORY"
.
.IP "\(bu" 4
0\.0\.1:
Lots of sketches and false starts\. Abandoned a few times\.
.
.IP "\(bu" 4
0\.0\.2:
Install worked mostly\. Still promise\-based\.
.
.IP "\(bu" 4
0\.0\.3:
Converted to callbacks\.
.
.br
Mikeal Rogers wrote a registry for it\.
.
.IP "\(bu" 4
0\.0\.4:
version dependencies
.
.br
link packages
.
.br
activation
.
.br
lifecycle scripts
.
.br
bin linking
.
.br
uninstallation
.
.IP "\(bu" 4
0\.0\.5:
fix a few bugs in uninstall wrt dependent packages
.
.br
fix relative require()for nodejs modules installed with the "bin" field\.
.
.br
(issue #2)
.
.br
update to work with node 0\.1\.33 (aka net2)
.
.br
added publish and tag commands
.
.IP "\(bu" 4
0\.0\.6:
set up a public registry
.
.br
send content\-length with registry PUTs
.
.br
adduser command (Mikeal Rogers)
.
.br
ini file stuff (Mikeal Rogers)
.
.br
env\-specific package\.json
.
.br
added more info to npm\'s the package\.json (bugs, contributors, etc\.)
.
.IP "\(bu" 4
0\.0\.7:
fixed a few bugs in semver
.
.br
refactor documentation
.
.br
add "help" command
.
.br
add install from registry
.
.br
everything else core
.
.br
push to beta
.
.IP "\(bu" 4
0\.1\.0 \- 0\.1\.2:
push to beta, and announce
.
.br
clean up some bugs around lifecycle scripts
.
.br
reduce reliance on makefile
.
.br
documentation updates
.
.br
Fixed DOA bugs
.
.br
Removed dependence on ronn
.
.IP "\(bu" 4
0\.1\.3:
Changed a few details with configs (fix #5)
.
.br
Update adduser and publish to put author info in the data
.
.br
Use buffer api for file writes, hopefully fix #4
.
.IP "\(bu" 4
0\.1\.4 \- 0\.1\.5:
Fixes for a few more bugs and fix some documentation\.
.
.IP "\(bu" 4
0\.1\.6 \- 0\.1\.7:
Add cache functionality
.
.br
Use couchdb attachments to host tarballs
.
.br
Handle odd require\.paths more appropriately
.
.br
Don\'t break on install if the man path is missing
.
.br
Support publishing or installing a folder or local tarball
.
.IP "\(bu" 4
0\.1\.8:
Bugfixes
.
.br
Add start, stop, restart, and test commands
.
.IP "\(bu" 4
0\.1\.9:
npm list enhancements
.
.br
fix the install bug
.
.IP "\(bu" 4
0\.1\.10:
More errors found by Ryan Dahl and Kris Zyp
.
.br
Better uninstall and list behavior
.
.br
Docs for new developers\.
.
.br
Better tracking of ownership on the registry\.
.
.IP "\(bu" 4
0\.1\.11:
Martyn Smith found a whole lot of bugs\.
.
.br
Make publish not die when the tarball is big\.
.
.br
"make uninstall" support
.
.IP "\(bu" 4
0\.1\.12 \- 0\.1\.13:
Fix the downloading bug that was breaking the tarballs
.
.br
Update some docs
.
.IP "\(bu" 4
0\.1\.14 \- 0\.1\.16:
Fix to stay in sync with node changes
.
.br
Put a special tag on link installs
.
.br
Modify semver comparison slightly
.
.br
add unpublish command
.
.br
Use the "drain" event properly for uploads
.
.br
Handle thrown errors
.
.br
Handle \.npmignore
.
.IP "\(bu" 4
0\.1\.17:
Stabilization\.
.
.IP "\(bu" 4
0\.1\.18:
Change a few default configurations
.
.br
Add test harness
.
.br
Default publish, install, and link to "\." if no arguments given
.
.IP "\(bu" 4
0\.1\.19 \- 0\.1\.20:
Create a bunch of bugs
.
.br
Fix a bunch of bugs
.
.br
Some minor speed improvements
.
.IP "\(bu" 4
0\.1\.21 \- 0\.1\.22:
Relative paths
.
.br
Support comments in package\.json
.
.br
Add owner name to ls output
.
.br
Add "owner" command to manage package owners
.
.br
Support hook scripts in \fB{root}/\.npm/\.hooks/\fR
.
.br
Initial support for config file relative to node executable
.
.br
Support for http proxies
.
.br
Documentation updates
.
.IP "\(bu" 4
0\.1\.23:
update command \- This is huge\.
.
.br
Rollback for failed installations
.
.br
Install dependencies for link packages
.
.br
Silently read passwords for adduser
.
.br
Cascading configs: cli, env, user, global
.
.br
First pass at \fBnpm view\fR command
.
.IP "\(bu" 4
0\.1\.24, 0\.1\.25:
Fix a bunch of things
.
.br
Cleanup, etc\.
.
.br
help via \-\-help, \-h, or \-?
.
.IP "\(bu" 4
0\.1\.26:
"modules" hash in package\.json (Alex K\. Wolfe)
.
.br
Better "restart" command (Alex K Wolfe)
.
.br
Work on Cygwin
.
.br
Remove link packages properly
.
.br
Make several commands more parallel
.
.IP "\(bu" 4
0\.1\.27:
Man pages handled with the "man" entry, or a "man" directory
.
.br
Install man pages in the "manroot" config dir
.
.br
Control log output with the "loglevel" config
.
.br
Support a "bin" directory of executables that get auto\-linked
.
.br
Un\-deprecate the "lib" directory\.
.
.br
Bug killing
.
.br
Split up the tar usage so it works on Solaris
.
.br
bundle command
.
.br
rebuild command
.
.IP "\(bu" 4
0\.2\.0:
Lots more bug killing
.
.br
Various fixes found during the Node Knockout extravaganza
.
.br
Change all "name\-version" things to be "name@version"
.
.br
First allegedly "stable" release\.
.
.IP "\(bu" 4
0\.2\.1:
Minor updates and bugfixes
.
.IP "\(bu" 4
0\.2\.2:
Update "help" to work on Solaris
.
.br
Remove updated packages that don\'t have dependencies\.
.
.br
Allow implied suffixes on \.js bins
.
.br
Fix an "adduser" bug
.
.IP "\(bu" 4
0\.2\.3:
Lots of documentation tweaks and cleanup
.
.br
Support || in version ranges
.
.IP "\(bu" 4
0\.2\.4:
Contribution party!
.
.br
Better list whitespace
.
.br
Lots of config happiness
.
.br
Ignore all major SCM folders by default
.
.br
Handle proxies and hostnames with ports
.
.br
Better Bundling
.
.br
Add \'outdated\' command
.
.br
Better handling of "engines" field
.
.IP "\(bu" 4
0\.2\.5:
Make npm OK to use programmatically (Charlie Robbins)
.
.IP "\(bu" 4
0\.2\.6:
More programmatic updates
.
.br
recursive package removal
.
.br
tab completion
.
.IP "" 0

Something went wrong with that request. Please try again.