mirror of
https://github.com/nodejs/node.git
synced 2025-05-15 11:36:57 +00:00
4b97c3addb
PR-URL: https://github.com/nodejs/node/pull/30271 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
44 lines
906 B
Markdown
Executable File
44 lines
906 B
Markdown
Executable File
---
|
|
section: cli-commands
|
|
title: npm-help-search
|
|
description: Search npm help documentation
|
|
---
|
|
|
|
# npm-help-search
|
|
|
|
## Search npm help documentation
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm help-search <text>
|
|
```
|
|
|
|
### 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
|
|
|
|
#### long
|
|
|
|
* Type: Boolean
|
|
* Default: false
|
|
|
|
If true, the "long" flag will cause help-search to output context around
|
|
where the terms were found in the documentation.
|
|
|
|
If false, then help-search will just list out the help topics found.
|
|
|
|
### See Also
|
|
|
|
* [npm](/cli-commands/npm)
|
|
* [npm help](/cli-commands/npm-help)
|