CLI documentation update from CI
CI User committed
May 10, 2022 at 02:40 UTC
53eb7f97eeeb7217457fe9eb1ec61e04032c4143
5 files changed
+89
-2
cli/v8
+1
-1
@@ -1 +1 @@
1
-Subproject commit 48d2db6037487fd782f67bbcd2cf12e009ece17b
1
+Subproject commit f985dbbd9ad3910c65e023f55beac9ec691c5e2c
content/cli/v8/commands/npm-bugs.md
+63
-1
@@ -21,7 +21,7 @@ github_path: docs/content/commands/npm-bugs.md
21
<!-- see lib/commands/bugs.js -->
22
23
```bash
24
-npm bugs [<pkgname>]
24
+npm bugs [<pkgname> [<pkgname> ...]]
25
26
alias: issues
27
```
@@ -68,6 +68,68 @@ The base URL of the npm registry.
68
<!-- automatically generated, do not edit manually -->
69
<!-- see lib/utils/config/definitions.js -->
70
71
+#### `workspace`
72
+
73
+* Default:
74
+* Type: String (can be set multiple times)
75
+
76
+Enable running a command in the context of the configured workspaces of the
77
+current project while filtering by running only the workspaces defined by
78
+this configuration option.
79
+
80
+Valid values for the `workspace` config are either:
81
+
82
+* Workspace names
83
+* Path to a workspace directory
84
+* Path to a parent workspace directory (will result in selecting all
85
+ workspaces within that folder)
86
+
87
+When set for the `npm init` command, this may be set to the folder of a
88
+workspace which does not yet exist, to create the folder and set it up as a
89
+brand new workspace within the project.
90
+
91
+This value is not exported to the environment for child processes.
92
+
93
+<!-- automatically generated, do not edit manually -->
94
+<!-- see lib/utils/config/definitions.js -->
95
+
96
+#### `workspaces`
97
+
98
+* Default: null
99
+* Type: null or Boolean
100
+
101
+Set to true to run the command in the context of **all** configured
102
+workspaces.
103
+
104
+Explicitly setting this to false will cause commands like `install` to
105
+ignore workspaces altogether. When not set explicitly:
106
+
107
+- Commands that operate on the `node_modules` tree (install, update, etc.)
108
+will link workspaces into the `node_modules` folder. - Commands that do
109
+other things (test, exec, publish, etc.) will operate on the root project,
110
+_unless_ one or more workspaces are specified in the `workspace` config.
111
+
112
+This value is not exported to the environment for child processes.
113
+
114
+<!-- automatically generated, do not edit manually -->
115
+<!-- see lib/utils/config/definitions.js -->
116
+
117
+#### `include-workspace-root`
118
+
119
+* Default: false
120
+* Type: Boolean
121
+
122
+Include the workspace root when workspaces are enabled for a command.
123
+
124
+When false, specifying individual workspaces via the `workspace` config, or
125
+all workspaces via the `workspaces` flag, will cause npm to operate only on
126
+the specified workspaces, and not on the root project.
127
+
128
+This value is not exported to the environment for child processes.
129
+
130
+<!-- automatically generated, do not edit manually -->
131
+<!-- see lib/utils/config/definitions.js -->
132
+
133
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
134
135
### See Also
content/cli/v8/commands/npm-repo.md
+10
@@ -56,6 +56,16 @@ Set to `true` to use default system URL opener.
56
<!-- automatically generated, do not edit manually -->
57
<!-- see lib/utils/config/definitions.js -->
58
59
+#### `registry`
60
+
61
+* Default: "https://registry.npmjs.org/"
62
+* Type: URL
63
+
64
+The base URL of the npm registry.
65
+
66
+<!-- automatically generated, do not edit manually -->
67
+<!-- see lib/utils/config/definitions.js -->
68
+
69
#### `workspace`
70
71
* Default:
content/cli/v8/commands/npm-star.md
+14
@@ -79,6 +79,20 @@ false, it uses ascii characters instead of unicode glyphs.
79
<!-- automatically generated, do not edit manually -->
80
<!-- see lib/utils/config/definitions.js -->
81
82
+#### `otp`
83
+
84
+* Default: null
85
+* Type: null or String
86
+
87
+This is a one-time password from a two-factor authenticator. It's needed
88
+when publishing or changing package permissions with `npm access`.
89
+
90
+If not set, and a registry response fails with a challenge for a one-time
91
+password, npm will prompt on the command line for one.
92
+
93
+<!-- automatically generated, do not edit manually -->
94
+<!-- see lib/utils/config/definitions.js -->
95
+
96
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
97
98
### See Also
content/cli/v8/using-npm/config.md
+1
@@ -76,6 +76,7 @@ The following shorthands are parsed on the command-line:
76
* `--desc`: `--description`
77
* `-f`: `--force`
78
* `-g`: `--global`
79
+* `--iwr`: `--include-workspace-root`
80
* `-L`: `--location`
81
* `-d`: `--loglevel info`
82
* `-s`: `--loglevel silent`