47 lines
1.0 KiB
Markdown
47 lines
1.0 KiB
Markdown
|
---
|
||
|
|
title: npm-help-search
|
||
|
|
section: 1
|
||
|
|
description: Search npm help documentation
|
||
|
|
---
|
||
|
|
|
||
|
|
### Synopsis
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm help-search <text>
|
||
|
|
```
|
||
|
|
|
||
|
|
Note: This command is unaware of workspaces.
|
||
|
|
|
||
|
|
### Description
|
||
|
|
|
||
|
|
This command will search the npm markdown documentation files for the terms
|
||
|
|
provided, and then list the results, sorted by relevance.
|
||
|
|
|
||
|
|
If only one result is found, then it will show that help topic.
|
||
|
|
|
||
|
|
If the argument to `npm help` is not a known help topic, then it will call
|
||
|
|
`help-search`. It is rarely if ever necessary to call this command
|
||
|
|
directly.
|
||
|
|
|
||
|
|
### Configuration
|
||
|
|
|
||
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
||
|
|
<!-- automatically generated, do not edit manually -->
|
||
|
|
<!-- see lib/utils/config/definitions.js -->
|
||
|
|
#### `long`
|
||
|
|
|
||
|
|
* Default: false
|
||
|
|
* Type: Boolean
|
||
|
|
|
||
|
|
Show extended information in `ls`, `search`, and `help-search`.
|
||
|
|
|
||
|
|
<!-- automatically generated, do not edit manually -->
|
||
|
|
<!-- see lib/utils/config/definitions.js -->
|
||
|
|
|
||
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
||
|
|
|
||
|
|
### See Also
|
||
|
|
|
||
|
|
* [npm](/commands/npm)
|
||
|
|
* [npm help](/commands/npm-help)
|