npm-help

Get help on npm

Synopsis

npm help <term> [<terms..>]

Description

If supplied a topic, then show the appropriate documentation page.

If the topic does not exist, or if multiple terms are provided, then run the help-search command to find a match. Note that, if help-search finds a single subject, then it will run help on that topic, so unique matches are equivalent to specifying a topic name.

Configuration

viewer

Default: "man" on Posix, "browser" on Windows
Type: path

The program to use to view help content.

Set to "browser" to view html help content in the default web browser.

See Also

Last modified January 08, 2016 Found a typo? Send a pull request!

Getting Started

How npm works

Private Modules

Organizations

Using npm

coding-style npm's "funny" coding style
config More than you probably want to know about npm configuration
developers Developer Guide
disputes Handling Module Name Disputes
orgs Working with Teams & Orgs
registry The JavaScript Package Registry
removing-npm Cleaning the Slate
scope Scoped packages
scripts How npm handles the "scripts" field
semver The semantic versioner for npm

npm On-Site

CLI Commands

access Set access level on published packages
adduser Add a registry user account
bin Display npm bin folder
bugs Bugs for a package in a web browser maybe
build Build a package
bundle REMOVED
cache Manipulates packages cache
completion Tab Completion for npm
config Manage the npm configuration files
dedupe Reduce duplication
deprecate Deprecate a version of a package
dist-tag Modify package distribution tags
docs Docs for a package in a web browser maybe
edit Edit an installed package
explore Browse an installed package
help Get help on npm
help-search Search npm help documentation
init Interactively create a package.json file
install Install a package
install-test
link Symlink a package folder
logout Log out of the registry
ls List installed packages
npm javascript package manager
outdated Check for outdated packages
owner Manage package owners
pack Create a tarball from a package
ping Ping npm registry
prefix Display prefix
prune Remove extraneous packages
publish Publish a package
rebuild Rebuild a package
repo Open package repository page in the browser
restart Restart a package
root Display npm root
run-script Run arbitrary package scripts
search Search for packages
shrinkwrap Lock down dependency versions
star Mark your favorite packages
stars View packages marked as favorites
start Start a package
stop Stop a package
tag Tag a published version
team Manage organization teams and team memberships
test Test a package
uninstall Remove a package
unpublish Remove a package from the registry
update Update a package
version Bump a package version
view View registry info
whoami Display npm username

Configuring npm

folders Folder Structures Used by npm
npmrc The npm config files
package.json Specifics of npm's package.json handling

npm policy documents

View All On One Page