LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

npm-help

displays documentation for npm commands

TLDR

Get help on a command
$ npm help [install]
copy
Search help topics by keyword
$ npm help-search [dependency]
copy
Open help in the browser
$ npm help [command] --viewer browser
copy
Read the npm overview
$ npm help npm
copy
Open the help index
$ npm help help
copy

SYNOPSIS

npm help [topic]

DESCRIPTION

npm help displays the npm manual page for a topic. By default it shells out to man(1) on Unix, but with --viewer browser it opens the rendered HTML on docs.npmjs.com.If no exact match exists, npm help falls back to npm help-search, which performs a keyword search across all npm man pages and prints relevance-ranked excerpts.

PARAMETERS

TOPIC

npm command name or general topic. Multiple words form a phrase passed to man's search if no exact page is found.
--viewer TYPE
Help viewer to use: man (default on Unix), browser, or woman (Emacs). On Windows the default is browser.
--help
Display help for the help command itself.

CAVEATS

The man viewer requires a working man installation. The default viewer can be changed permanently with npm config set viewer browser.

HISTORY

npm help provides access to npm's documentation system from the command line.

SEE ALSO

npm(1), npm-docs(1)

Copied to clipboard
Kai