Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-help-search (1)

Name

npm-help-search - Search npm help documentation

Synopsis

npm help-search <text>

Description

NPM-HELP-SEARCH(1)                                          NPM-HELP-SEARCH(1)



NAME
       npm-help-search - Search npm help documentation

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
       o Type: Boolean

       o 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help npm

       o npm help help





NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018               NPM-HELP-SEARCH(1)