npm man page

npm — javascript package manager

TL;DR

npm install -g {{module_name}}

npm install

npm install {{module_name}}@{{version}} --save

npm install {{module_name}}@{{version}} --save-dev

npm uninstall {{module_name}}

npm list

npm init

Synopsis

npm <command> [args]

Version

5.5.1

Description

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.

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.

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++ are 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

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.

Developer Usage

If you're using npm to develop and publish your code, check out the following help topics:

Configuration

npm is extremely configurable.  It reads its configuration options from 5 places.

See npm help 7 npm-config for much much more information.

Contributions

Patches welcome!

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, read the contributing guidelines and check the issues list.

Bugs

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.

Author

Isaac Z. Schlueter http://blog.izs.me/ :: isaacs https://github.com/isaacs/ :: @izs http://twitter.com/izs :: i@izs.me

See Also

Referenced By

npx(1).

October 2017