mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 08:56:32 +00:00
1b8300b238
PR-URL: https://github.com/nodejs/node/pull/42122 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Danielle Adams <adamzdanielle@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
62 lines
1.5 KiB
Markdown
62 lines
1.5 KiB
Markdown
---
|
|
title: npm-help
|
|
section: 1
|
|
description: Get help on npm
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/commands/help.js -->
|
|
|
|
```bash
|
|
npm help <term> [<terms..>]
|
|
|
|
alias: hlep
|
|
```
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/commands/help.js -->
|
|
|
|
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
|
|
|
Note: This command is unaware of workspaces.
|
|
|
|
### Description
|
|
|
|
If supplied a topic, then show the appropriate documentation page.
|
|
|
|
If the topic does not exist, or if multiple terms are provided, then npm
|
|
will 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
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
#### `viewer`
|
|
|
|
* Default: "man" on Posix, "browser" on Windows
|
|
* Type: String
|
|
|
|
The program to use to view help content.
|
|
|
|
Set to `"browser"` to view html help content in the default web browser.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
|
|
|
### See Also
|
|
|
|
* [npm](/commands/npm)
|
|
* [npm folders](/configuring-npm/folders)
|
|
* [npm config](/commands/npm-config)
|
|
* [npmrc](/configuring-npm/npmrc)
|
|
* [package.json](/configuring-npm/package-json)
|
|
* [npm help-search](/commands/npm-help-search)
|