Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Latest commit

 

History

History
121 lines (89 loc) · 3.72 KB

npm.md

File metadata and controls

121 lines (89 loc) · 3.72 KB
Raw

npm(1) -- node package manager

SYNOPSIS

npm <command> [args]

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 install for more info. It can do a lot of stuff.

Use the npm ls command to show everything that's available. Use npm ls installed to show everything you've installed. npm help ls will tell you more.

DEVELOPER USAGE

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

  • json: Make a package.json file. See npm help 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. Creditials are stored (encrypted) 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:
    Set a config with --key val. All keys take a value, even if they are booleans (the config parser doesn't know what the options are at the time of parsing.) If no value is provided, then the option is set to boolean true.
  • Environment Variables:
    Set any config by prefixing the name in an environment variable with npm_config_. For example, export npm_config_key=val.
  • User Configs:
    The file at $HOME/.npmrc is an ini-formatted list of configs. If present, it is parsed. If the userconfig option is set in the cli or env, then that will be used instead.
  • Global Configs:
    The file found at ../etc/npmrc (from the node executable, by default this resolves to /usr/local/etc/npmrc) will be parsed if it is found. If the globalconfig option is set in the cli, env, or user config, then that file is parsed instead.
  • Defaults:
    npm's default configuration options are defined in lib/utils/default-config.js. These should not be changed.

See npm help config for more information.

CONTRIBUTIONS

Patches welcome!

  • code: Read through npm help 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.)

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.

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.

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.

HISTORY

See npm-changelog(1)

AUTHOR

Isaac Z. Schlueter :: isaacs :: @izs :: i@izs.me