Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

npm-help (1)

Name

npm-help - Get help on npm Synopsis npm help <term> [<terms..>] alias: hlep Note: This command is unaware of workspaces. Description If supplied a topic, then show the appropriate documentation page. If the topic does not exist, or if multiple terms are provided, then npm will run the help-search command to find a match. Note that, if help-search finds a single subject, then it will run help on that topic, so unique matches are equivalent to specifying a topic name. Configuration viewer o Default: "man" on Posix, "browser" on Windows o Type: String The program to use to view help content. Set to "browser" to view html help content in the default web browser. See Also o npm help npm o npm help folders o npm help config o npm help npmrc o npm help package.json o npm help help-search

Synopsis

Please see following description for synopsis

Description

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



NAME
       npm-help - Get help on npm

   Synopsis
         npm help <term> [<terms..>]

         alias: hlep

       Note: This command is unaware of workspaces.

   Description
       If supplied a topic, then show the appropriate documentation page.

       If  the  topic  does not exist, or if multiple terms are provided, then
       npm will run the help-search command to find a match.   Note  that,  if
       help-search  finds  a  single  subject,  then  it will run help on that
       topic, so unique matches are equivalent to specifying a topic name.

   Configuration
   viewer
       o Default: "man" on Posix, "browser" on Windows

       o Type: String


       The program to use to view help content.

       Set to "browser" to view html help content in the default web browser.

   See Also
       o npm help npm

       o npm help folders

       o npm help config

       o npm help npmrc

       o npm help package.json

       o npm help help-search




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


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | runtime/nodejs/nodejs-18 |
       +---------------+--------------------------+
       |Stability      | Pass-thru volatile       |
       +---------------+--------------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       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/v18.1.0.zip.

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



                                  April 2022                       NPM-HELP(1)