other versions
- jessie 1.4.21+ds-2
- testing 5.8.0+ds6-3
- stretch-backports 5.8.0+ds6-2~bpo9+1
- unstable 5.8.0+ds6-4
other sections
NPM(1) | NPM(1) |
NAME¶
npm - node package managerSYNOPSIS¶
npm <command> [args]
VERSION¶
1.4.21DESCRIPTION¶
npm is the package manager for the Node JavaScript platform. It puts modules in place so that node can find them, and manages dependency conflicts intelligently. 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.INTRODUCTION¶
You probably got npm because you want to install stuff. npm help Use npm install blerg to install the latest version of "blerg". Check out 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.DEPENDENCIES¶
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.DIRECTORIES¶
npm help See npm-folders to learn about where npm puts stuff. In particular, npm has two modes of operation:- global mode:
-
- local mode:
-
DEVELOPER USAGE¶
If you´re using npm to develop and publish your code, check out the following help topics:- json
- npm help Make a package.json file. See package.json.
- 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.
- 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
- adduser
- Create an account or log in. Credentials are stored in the user config file.
- publish
- Use the npm publish command to upload your code to the registry.
CONFIGURATION¶
npm is extremely configurable. It reads its configuration options from 5 places.- Command line switches:
-
- Environment Variables:
-
- User Configs:
-
- Global Configs:
-
- Defaults:
-
CONTRIBUTIONS¶
Patches welcome!- code
- npm help Read through npm-coding-style if you plan to submit code. You don´t have to agree with it, but you do have to follow it.
- 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.)
- •
- npm-@googlegroups.com
BUGS¶
When you find issues, please report them:- npm-@googlegroups.com
AUTHOR¶
Isaac Z. Schlueter http://blog.izs.me/ :: isaacs https://github.com/isaacs/ :: @izs http://twitter.com/izs :: i@izs.meSEE ALSO¶
- •
- npm help help
- •
- npm help faq
- •
- README
- •
- npm help package.json
- •
- npm help install
- •
- npm help config
- •
- npm help config
- •
- npm help npmrc
- •
- npm help index
- •
- npm apihelp npm
August 2014 |