mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 10:54:13 +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>
56 lines
1.3 KiB
Markdown
56 lines
1.3 KiB
Markdown
---
|
|
title: npm-help-search
|
|
section: 1
|
|
description: Search npm help documentation
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/commands/help-search.js -->
|
|
|
|
```bash
|
|
npm help-search <text>
|
|
```
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/commands/help-search.js -->
|
|
|
|
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
|
|
|
|
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)
|