1NPM-REPO(1)                                                        NPM-REPO(1)
2
3
4

NAME

6       npm-repo - Open package repository page in the browser
7
8   Synopsis
9         npm repo [<pkgname> [<pkgname> ...]]
10
11   Description
12       This  command  tries  to  guess  at  the likely location of a package's
13       repository URL, and then tries to open it using  the  --browser  config
14       param.  If  no  package  name  is  provided, it will search for a pack‐
15       age.json in the current folder and use the repository property.
16
17   Configuration
18       <!-- AUTOGENERATED CONFIG DESCRIPTIONS  START  -->  <!--  automatically
19       generated,  do  not edit manually --> <!-- see lib/utils/config/defini‐
20       tions.js -->
21
22   browser
23       • Default: OS X: "open", Windows: "start", Others: "xdg-open"
24
25       • Type: null, Boolean, or String
26
27
28       The browser that is called by npm commands to open websites.
29
30       Set to false to suppress browser behavior and  instead  print  urls  to
31       terminal.
32
33       Set  to true to use default system URL opener.  <!-- automatically gen‐
34       erated, do not edit  manually  -->  <!--  see  lib/utils/config/defini‐
35       tions.js -->
36
37
38   workspace
39       • Default:
40
41       • Type: String (can be set multiple times)
42
43
44       Enable running a command in the context of the configured workspaces of
45       the current project while filtering by running only the workspaces  de‐
46       fined by this configuration option.
47
48       Valid values for the workspace config are either:
49
50       • Workspace names
51
52       • Path to a workspace directory
53
54       • Path  to  a  parent workspace directory (will result in selecting all
55         workspaces within that folder)
56
57
58       When set for the npm init command, this may be set to the folder  of  a
59       workspace  which does not yet exist, to create the folder and set it up
60       as a brand new workspace within the project.
61
62       This value is not exported to  the  environment  for  child  processes.
63       <!--  automatically  generated,  do  not  edit  manually  -->  <!-- see
64       lib/utils/config/definitions.js -->
65
66
67   workspaces
68       • Default: null
69
70       • Type: null or Boolean
71
72
73       Set to true to run  the  command  in  the  context  of  all  configured
74       workspaces.
75
76       Explicitly  setting  this  to false will cause commands like install to
77       ignore workspaces altogether. When not set explicitly:
78
79       • Commands that operate on  the  node_modules  tree  (install,  update,
80         etc.)   will link workspaces into the node_modules folder. - Commands
81         that do other things (test, exec, publish, etc.) will operate on  the
82         root  project,  unless  one  or  more workspaces are specified in the
83         workspace config.
84
85
86       This value is not exported to  the  environment  for  child  processes.
87       <!--  automatically  generated,  do  not  edit  manually  -->  <!-- see
88       lib/utils/config/definitions.js -->
89
90
91   include-workspace-root
92       • Default: false
93
94       • Type: Boolean
95
96
97       Include the workspace root when workspaces are enabled for a command.
98
99       When false, specifying individual workspaces via the workspace  config,
100       or  all  workspaces  via the workspaces flag, will cause npm to operate
101       only on the specified workspaces, and not on the  root  project.   <!--
102       automatically   generated,   do   not   edit   manually  -->  <!--  see
103       lib/utils/config/definitions.js -->
104
105       <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
106
107
108   See Also
109       • npm help docs
110
111       • npm help config
112
113
114
115
116                                 January 2022                      NPM-REPO(1)