- Download and install a module globally:npm install -g [module_name]- Download all dependencies referenced in package.json:npm install- Download a given dependency required for the application to run, and add it to the package.json:npm install [module_name]@[version] --save- Download a given dependency for development purposes, and add it to the package.json:npm install [module_name]@[version] --save-dev- Uninstall a module:npm uninstall [module_name]- List a tree of installed modules referenced in package.json:npm list- List top-level globally installed modules:npm list -g --depth=- Interactively create a package.json file:npm init
npm <command> [args]
It is extremely configurable to support a wide variety of use cases. Most commonly, it is used to publish, discover, install, and develop node programs.
Run npm help to get a list of available commands.
You probably got npm because you want to install stuff.
Use npm install blerg to install the latest version of "blerg". Check out npm help npm-install for more info. It can do a lot of stuff.
Use the npm search command to show everything that's available. Use npm ls to show everything you've installed.
If a package references to another package with a git URL, npm depends on a preinstalled git.
If one of the packages npm tries to install is a native node module and requires compiling of C++ Code, npm will use node-gyp https://github.com/TooTallNate/node-gyp for that task. For a Unix system, node-gyp https://github.com/TooTallNate/node-gyp needs Python, make and a buildchain like GCC. On Windows, Python and Microsoft Visual Studio C++ is needed. Python 3 is not supported by node-gyp https://github.com/TooTallNate/node-gyp. For more information visit the node-gyp repository https://github.com/TooTallNate/node-gyp and the node-gyp Wiki https://github.com/TooTallNate/node-gyp/wiki.
See npm help 5 npm-folders to learn about where npm puts stuff.
In particular, npm has two modes of operation:
Local mode is the default. Use -g or --global on any command to operate in global mode instead.
If you're using npm to develop and publish your code, check out the following help topics:
npm is extremely configurable. It reads its configuration options from 5 places.
See npm help 7 npm-config for much much more information.
Contributors are listed in npm's package.json file. You can view them easily by doing npm view npm contributors.
If you would like to contribute, but don't know what to work on, check the issues list or ask on the mailing list.
When you find issues, please report them:
Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.
You can also look for isaacs in #node.js on irc://irc.freenode.net. He will no doubt tell you to put the output in a gist or email.
Isaac Z. Schlueter http://blog.izs.me/ :: isaacs https://github.com/isaacs/ :: @izs http://twitter.com/izs :: email@example.com