Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

npm-repo (1)

Name

npm-repo - Open package repository page in the browser Synopsis npm repo [<pkgname> [<pkgname> ...]] Description This command tries to guess at the likely location of a package's repository URL, and then tries to open it using the --browser config param. If no package name is provided, it will search for a pack- age.json in the current folder and use the repository property. Configuration browser o Default: OS X: "open", Windows: "start", Others: "xdg-open" o Type: null, Boolean, or String The browser that is called by npm commands to open websites. Set to false to suppress browser behavior and instead print urls to terminal. Set to true to use default system URL opener. workspace o Default: o Type: String (can be set multiple times) Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option. Valid values for the workspace config are either: o Workspace names o Path to a workspace directory o Path to a parent workspace directory (will result in selecting all workspaces within that folder) When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project. This value is not exported to the environment for child processes. workspaces o Default: null o Type: null or Boolean Set to true to run the command in the context of all configured workspaces. Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly: o Commands that operate on the node_modules tree (install, update, etc.) will link workspaces into the node_modules folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace config. This value is not exported to the environment for child processes. include-workspace-root o Default: false o Type: Boolean Include the workspace root when workspaces are enabled for a command. When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project. This value is not exported to the environment for child processes. See Also o npm help docs o npm help config

Synopsis

Please see following description for synopsis

Description

NPM-REPO(1)                                                        NPM-REPO(1)



NAME
       npm-repo - Open package repository page in the browser

   Synopsis
         npm repo [<pkgname> [<pkgname> ...]]

   Description
       This  command  tries  to  guess  at  the likely location of a package's
       repository URL, and then tries to open it using  the  --browser  config
       param.  If  no  package  name  is  provided, it will search for a pack-
       age.json in the current folder and use the repository property.

   Configuration
   browser
       o Default: OS X: "open", Windows: "start", Others: "xdg-open"

       o Type: null, Boolean, or String


       The browser that is called by npm commands to open websites.

       Set to false to suppress browser behavior and  instead  print  urls  to
       terminal.

       Set to true to use default system URL opener.

   workspace
       o Default:

       o Type: String (can be set multiple times)


       Enable running a command in the context of the configured workspaces of
       the current project while filtering  by  running  only  the  workspaces
       defined by this configuration option.

       Valid values for the workspace config are either:

       o Workspace names

       o Path to a workspace directory

       o Path  to  a  parent workspace directory (will result in selecting all
         workspaces within that folder)


       When set for the npm init command, this may be set to the folder  of  a
       workspace  which does not yet exist, to create the folder and set it up
       as a brand new workspace within the project.

       This value is not exported to the environment for child processes.

   workspaces
       o Default: null

       o Type: null or Boolean


       Set to true to run  the  command  in  the  context  of  all  configured
       workspaces.

       Explicitly  setting  this  to false will cause commands like install to
       ignore workspaces altogether. When not set explicitly:

       o Commands that operate on  the  node_modules  tree  (install,  update,
         etc.)   will link workspaces into the node_modules folder. - Commands
         that do other things (test, exec, publish, etc.) will operate on  the
         root  project,  unless  one  or  more workspaces are specified in the
         workspace config.


       This value is not exported to the environment for child processes.

   include-workspace-root
       o Default: false

       o Type: Boolean


       Include the workspace root when workspaces are enabled for a command.

       When false, specifying individual workspaces via the workspace  config,
       or  all  workspaces  via the workspaces flag, will cause npm to operate
       only on the specified workspaces, and not on the root project.

       This value is not exported to the environment for child processes.

   See Also
       o npm help docs

       o npm help config




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-REPO(1)