mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 23:19:09 +00:00
aa0e4eb27f
PR-URL: https://github.com/nodejs/node/pull/38750 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
47 lines
1.1 KiB
Markdown
47 lines
1.1 KiB
Markdown
---
|
|
title: npm-help
|
|
section: 1
|
|
description: Get help on npm
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm help <term> [<terms..>]
|
|
```
|
|
|
|
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 -->
|
|
#### `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.
|
|
|
|
<!-- 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)
|