npm CLI
CLI Commands
npmnpm accessnpm addusernpm auditnpm binnpm bugsnpm buildnpm bundlenpm cachenpm cinpm completionnpm confignpm dedupenpm deprecatenpm dist-tagnpm docsnpm doctornpm editnpm explorenpm fundnpm helpnpm help-searchnpm hooknpm initnpm installnpm install-ci-testnpm install-testnpm linknpm logoutnpm lsnpm orgnpm outdatednpm ownernpm packnpm pingnpm prefixnpm profilenpm prunenpm publishnpm rebuildnpm reponpm restartnpm rootnpm run-scriptnpm searchnpm shrinkwrapnpm starnpm starsnpm startnpm stopnpm teamnpm testnpm tokennpm uninstallnpm unpublishnpm updatenpm versionnpm viewnpm whoami
npm-help-search
Search npm help documentationVersion 6.14.17 (Legacy Release)
Table of contents
Table of contents
Synopsis
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.