1NPM-REPO(1) NPM-REPO(1)
2
3
4
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 browser
19 • Default: OS X: "open", Windows: "start", Others: "xdg-open"
20
21 • Type: null, Boolean, or String
22
23
24 The browser that is called by npm commands to open websites.
25
26 Set to false to suppress browser behavior and instead print urls to
27 terminal.
28
29 Set to true to use default system URL opener.
30
31 registry
32 • Default: "https://registry.npmjs.org/"
33
34 • Type: URL
35
36
37 The base URL of the npm registry.
38
39 workspace
40 • Default:
41
42 • Type: String (can be set multiple times)
43
44
45 Enable running a command in the context of the configured workspaces of
46 the current project while filtering by running only the workspaces de‐
47 fined by this configuration option.
48
49 Valid values for the workspace config are either:
50
51 • Workspace names
52
53 • Path to a workspace directory
54
55 • Path to a parent workspace directory (will result in selecting all
56 workspaces within that folder)
57
58
59 When set for the npm init command, this may be set to the folder of a
60 workspace which does not yet exist, to create the folder and set it up
61 as a brand new workspace within the project.
62
63 This value is not exported to the environment for child processes.
64
65 workspaces
66 • Default: null
67
68 • Type: null or Boolean
69
70
71 Set to true to run the command in the context of all configured
72 workspaces.
73
74 Explicitly setting this to false will cause commands like install to
75 ignore workspaces altogether. When not set explicitly:
76
77 • Commands that operate on the node_modules tree (install, update,
78 etc.) will link workspaces into the node_modules folder. - Commands
79 that do other things (test, exec, publish, etc.) will operate on the
80 root project, unless one or more workspaces are specified in the
81 workspace config.
82
83
84 This value is not exported to the environment for child processes.
85
86 include-workspace-root
87 • Default: false
88
89 • Type: Boolean
90
91
92 Include the workspace root when workspaces are enabled for a command.
93
94 When false, specifying individual workspaces via the workspace config,
95 or all workspaces via the workspaces flag, will cause npm to operate
96 only on the specified workspaces, and not on the root project.
97
98 This value is not exported to the environment for child processes.
99
100 See Also
101 • npm help docs
102
103 • npm help config
104
105
106
107
108 September 2022 NPM-REPO(1)