2019-11-05 14:55:08 -05:00
|
|
|
---
|
|
|
|
|
title: npm-help-search
|
2020-11-01 07:54:36 +01:00
|
|
|
section: 1
|
2019-11-05 14:55:08 -05:00
|
|
|
description: Search npm help documentation
|
|
|
|
|
---
|
2011-11-21 09:48:45 -08:00
|
|
|
|
2019-11-05 14:55:08 -05:00
|
|
|
### Synopsis
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm help-search <text>
|
|
|
|
|
```
|
|
|
|
|
|
2021-03-23 14:58:11 -04:00
|
|
|
Note: This command is unaware of workspaces.
|
|
|
|
|
|
2019-11-05 14:55:08 -05:00
|
|
|
### Description
|
2011-11-21 09:48:45 -08:00
|
|
|
|
2020-11-01 07:54:36 +01:00
|
|
|
This command will search the npm markdown documentation files for the terms
|
|
|
|
|
provided, and then list the results, sorted by relevance.
|
2011-11-21 09:48:45 -08:00
|
|
|
|
|
|
|
|
If only one result is found, then it will show that help topic.
|
|
|
|
|
|
2020-11-01 07:54:36 +01:00
|
|
|
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.
|
2011-11-21 09:48:45 -08:00
|
|
|
|
2019-11-05 14:55:08 -05:00
|
|
|
### Configuration
|
2011-11-21 09:48:45 -08:00
|
|
|
|
2019-11-05 14:55:08 -05:00
|
|
|
#### long
|
2011-11-21 09:48:45 -08:00
|
|
|
|
|
|
|
|
* Type: Boolean
|
2016-03-29 23:30:51 -07:00
|
|
|
* Default: false
|
2011-11-21 09:48:45 -08:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2019-11-05 14:55:08 -05:00
|
|
|
### See Also
|
2011-11-21 09:48:45 -08:00
|
|
|
|
2020-11-01 07:54:36 +01:00
|
|
|
* [npm](/commands/npm)
|
|
|
|
|
* [npm help](/commands/npm-help)
|
