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

NAME

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