npm(1) -- a JavaScript package manager

SYNOPSIS

This is just enough info to get you up and running.

Much more info available vianpm help once it's installed.

IMPORTANT

You need node v0.8 or higher to run this program.

To install an oldand unsupported version of npm that works on node 0.3and prior, clone the git repo and dig through the old tags and branches.

npm is configured to use npm, Inc.'s public package registry athttps://registry.npmjs.org by default.

You can configure npm to use any compatible registry youlike, and even run your own registry. Check out thedoc onregistries.

Use of someone else's registry may be governed by terms of use. Theterms of use for the default public registry are available athttps://www.npmjs.com.

Super Easy Install

npm is bundled withnode.

Windows Computers

Get the MSI. npm is in it.

Apple Macintosh Computers

Get the pkg. npm is in it.

Other Sorts of Unices

Runmake install. npm will be installed with node.

If you want a more fancy pants install (a different version, customizedpaths, etc.) then read on.

Fancy Install (Unix)

There's a pretty robust install script athttps://www.npmjs.com/install.sh. You can download that and run it.

Here's an example using curl:

curl -L https://www.npmjs.com/install.sh | sh

Slightly Fancier

You can set any npm configuration params with that script:

npm_config_prefix=/some/path sh install.sh

Or, you can run it in uber-debuggery mode:

npm_debug=1 sh install.sh

Even Fancier

Get the code with git. Usemake to build the docs and do other stuff.If you plan on hacking on npm,make link is your friend.

If you've got the npm source code, you can also semi-permanently setarbitrary config keys using the./configure --key=val ..., and thenrun npm commands by doingnode cli.js <cmd> <args>. (This is helpfulfor testing, or running stuff without actually installing npm itself.)

Windows Install or Upgrade

You can download a zip file fromhttps://github.com/npm/npm/releases, andunpack it in thenode_modules\npm\ folder inside node's installation folder.

To upgrade to npm 2, follow the Windows upgrade instructions inthe npm Troubleshooting Guide:

https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows

If that's not fancy enough for you, then you can fetch the code withgit, and mess with it directly.

Installing on Cygwin

No.

Uninstalling

So sad to see you go.

sudo npm uninstall npm -g

Or, if that fails,

sudo make uninstall

More Severe Uninstalling

Usually, the above instructions are sufficient. That will removenpm, but leave behind anything you've installed.

If you would like to remove all the packages that you have installed,then you can use thenpm ls command to find them, and thennpm rm toremove them.

To remove cruft left behind by npm 0.x, you can use the includedclean-old.sh script file. You can run it conveniently like this:

npm explore npm -g -- sh scripts/clean-old.sh

npm uses two configuration files, one for per-user configs, and anotherfor global (every-user) configs. You can view them by doing:

npm config get userconfig   # defaults to ~/.npmrc 
npm config get globalconfig # defaults to /usr/local/etc/npmrc 

Uninstalling npm does not remove configuration files by default. Youmust remove them yourself manually if you want them gone. Note thatthis means that future npm installs will not remember the settings thatyou have chosen.

More Docs

Check out thedocs,especially thefaq.

You can use thenpm help command to read any of them.

If you're a developer, and you want to use npm to publish your program,you shouldread this

BUGS

When you find issues, please report them:

• web:https://github.com/npm/npm/issues

Be sure to includeall of the output from the npm command that didn't workas expected. Thenpm-debug.log file is also helpful to provide.

You can also look for isaacs in #node.js on irc://irc.freenode.net. Hewill no doubt tell you to put the output in a gist or email.

SEE ALSO

• npm(1)
• npm-faq(7)
• npm-help(1)
• npm-index(7)