Skip to content

Commit 12b0c65

Browse files
committed
CLI documentation update from CI
1 parent fde0473 commit 12b0c65

35 files changed

+162
-72
lines changed

cli-cache.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"v8": "aa8fff11cdab94fff1a2160ee5241f5f4632e96b",
33
"v9": "64763a341e7aa5b456e696f956759bf9b3440dc1",
44
"v10": "e510f14bf6a20d67e7b37c3f25ff271d9f7a0da5",
5-
"v11": "b5173d13c182efa5434ef4ca413e62ce1437f47a"
5+
"v11": "3d90a4936ec3324ff5b1642b20588c6d57ab04a5"
66
}

content/cli/v11/commands/npm-adduser.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Note: This command is unaware of workspaces.
4949

5050
Create a new user in the specified registry, and save the credentials to the `.npmrc` file. If no registry is specified, the default registry will be used (see [`registry`](/cli/v11/using-npm/registry)).
5151

52+
When you run `npm adduser`, the CLI automatically generates a legacy token of `publish` type. For more information, see [About legacy tokens](/about-access-tokens#about-legacy-tokens).
53+
5254
When using `legacy` for your `auth-type`, the username, password, and email are read in from prompts.
5355

5456
### Configuration

content/cli/v11/commands/npm-audit.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ Note that this will generally make installs run slower, and be much noisier, but
323323

324324
If true, npm does not run scripts specified in package.json files.
325325

326-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
326+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
327327

328328
#### `workspace`
329329

content/cli/v11/commands/npm-ci.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Note that this will generally make installs run slower, and be much noisier, but
163163

164164
If true, npm does not run scripts specified in package.json files.
165165

166-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
166+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
167167

168168
#### `audit`
169169

content/cli/v11/commands/npm-dedupe.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Dependency types specified in `--include` will not be omitted, regardless of the
166166
167167
If true, npm does not run scripts specified in package.json files.
168168
169-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
169+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
170170
171171
#### `audit`
172172

content/cli/v11/commands/npm-exec.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ Run scripts in the context of all configured workspaces for the current project.
293293

294294
### See Also
295295

296-
- [npm run-script](/cli/v11/commands/npm-run-script)
296+
- [npm run](/cli/v11/commands/npm-run)
297297
- [npm scripts](/cli/v11/using-npm/scripts)
298298
- [npm test](/cli/v11/commands/npm-test)
299299
- [npm start](/cli/v11/commands/npm-start)

content/cli/v11/commands/npm-find-dupes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Dependency types specified in `--include` will not be omitted, regardless of the
119119

120120
If true, npm does not run scripts specified in package.json files.
121121

122-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
122+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
123123

124124
#### `audit`
125125

content/cli/v11/commands/npm-init.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ Generate it without having it ask any questions:
103103
$ npm init -y
104104
```
105105

106+
Set the private flag to `true` in package.json:
107+
108+
```bash
109+
$ npm init --init-private -y
110+
```
111+
106112
### Workspaces support
107113

108114
It's possible to create a new workspace within your project by using the `workspace` config option. When using `npm init -w <dir>` the cli will create the folders and boilerplate expected while also adding a reference to your project `package.json` `"workspaces": []` property in order to make sure that new generated **workspace** is properly set up as such.
@@ -194,6 +200,13 @@ The value that `npm init` should use by default for the package.json type field.
194200

195201
The value that `npm init` should use by default for the package version number, if not already set in package.json.
196202

203+
#### `init-private`
204+
205+
- Default: false
206+
- Type: Boolean
207+
208+
The value `npm init` should use by default for the package's private flag.
209+
197210
#### `yes`
198211

199212
- Default: null

content/cli/v11/commands/npm-install-ci-test.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Note that this will generally make installs run slower, and be much noisier, but
123123

124124
If true, npm does not run scripts specified in package.json files.
125125

126-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
126+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
127127

128128
#### `audit`
129129

content/cli/v11/commands/npm-install-test.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Note that this will generally make installs run slower, and be much noisier, but
177177

178178
If true, npm does not run scripts specified in package.json files.
179179

180-
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
180+
Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
181181

182182
#### `audit`
183183

0 commit comments

Comments
 (0)