npm javascript package manager

SYNOPSIS

npm <command> [args]

VERSION

@[email protected]

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.

IMPORTANT

npm is configured to use npm, Inc.’s public registry at https://registry.npmjs.org by default. Use of the npm public registry is subject to terms of use available at https://www.npmjs.com/policies/terms.

You can configure npm to use any compatible registry you like, and even run your own registry. Use of someone else’s registry may be governed by their terms of use.

INTRODUCTION

You probably got npm because you want to install stuff.

Use npm install blerg to install the latest version of “blerg”. Check out <a href="/cli/install">npm-install</a> 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 for that task. For a Unix system, 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. For more information visit the node-gyp repository and the node-gyp Wiki.

DIRECTORIES

See <a href="/files/folders">npm-folders</a> 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 <a href="/misc/config">npm-config</a> for much much more information.

CONTRIBUTIONS

Patches welcome!

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 follow the template and bug reporting guidelines. You can also ask for help in the support forum if you’re unsure if it’s actually a bug or are having trouble coming up with a detailed reproduction to report.

AUTHOR

Isaac Z. Schlueter :: isaacs :: @izs :: [email protected]

SEE ALSO