Skip to content

Commit 29a5c51

Browse files
npm-cli-botnpm-cli-bot
committed
CLI documentation update from CI
1 parent 24bef9e commit 29a5c51

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+115
-2536
lines changed

‎cli/releases.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"id": "v8",
1717
"branch": "release/v8",
1818
"spec": "latest",
19-
"resolved": "https://registry.npmjs.org/npm/-/npm-8.19.2.tgz"
19+
"resolved": "https://registry.npmjs.org/npm/-/npm-8.19.3.tgz"
2020
},
2121
{
2222
"id": "v9",

‎content/cli/v8/commands/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: CLI Commands
33
shortName: Commands
44
github_repo: npm/cli
55
github_branch: release/v8
6-
github_path: docs/nav.yml
6+
github_path: docs/lib/content/nav.yml
77
redirect_from:
88
- /cli-commands
99
- /cli-commands/index

‎content/cli/v8/commands/npm-access.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: 1
44
description: Set access level on published packages
55
github_repo: npm/cli
66
github_branch: release/v8
7-
github_path: docs/content/commands/npm-access.md
7+
github_path: docs/lib/content/commands/npm-access.md
88
redirect_from:
99
- /cli-commands/access
1010
- /cli-commands/npm-access
@@ -37,10 +37,6 @@ redirect_from:
3737

3838
### Synopsis
3939

40-
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
41-
<!-- automatically generated, do not edit manually -->
42-
<!-- see lib/commands/access.js -->
43-
4440
```bash
4541
npm access public [<package>]
4642
npm access restricted [<package>]
@@ -53,11 +49,6 @@ npm access ls-collaborators [<package> [<user>]]
5349
npm access edit [<package>]
5450
```
5551
56-
<!-- automatically generated, do not edit manually -->
57-
<!-- see lib/commands/access.js -->
58-
59-
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
60-
6152
### Description
6253
6354
Used to set access controls on private packages.
@@ -119,19 +110,13 @@ Management of teams and team memberships is done with the `npm team` command.
119110
120111
### Configuration
121112
122-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
123-
<!-- automatically generated, do not edit manually -->
124-
<!-- see lib/utils/config/definitions.js -->
125113
#### `registry`
126114
127115
* Default: "https://registry.npmjs.org/"
128116
* Type: URL
129117
130118
The base URL of the npm registry.
131119
132-
<!-- automatically generated, do not edit manually -->
133-
<!-- see lib/utils/config/definitions.js -->
134-
135120
#### `otp`
136121
137122
* Default: null
@@ -143,11 +128,6 @@ when publishing or changing package permissions with `npm access`.
143128
If not set, and a registry response fails with a challenge for a one-time
144129
password, npm will prompt on the command line for one.
145130
146-
<!-- automatically generated, do not edit manually -->
147-
<!-- see lib/utils/config/definitions.js -->
148-
149-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
150-
151131
### See Also
152132
153133
* [`libnpmaccess`](https://npm.im/libnpmaccess)

‎content/cli/v8/commands/npm-adduser.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: 1
44
description: Add a registry user account
55
github_repo: npm/cli
66
github_branch: release/v8
7-
github_path: docs/content/commands/npm-adduser.md
7+
github_path: docs/lib/content/commands/npm-adduser.md
88
redirect_from:
99
- /cli-commands/adduser
1010
- /cli-commands/npm-adduser
@@ -37,21 +37,12 @@ redirect_from:
3737

3838
### Synopsis
3939

40-
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
41-
<!-- automatically generated, do not edit manually -->
42-
<!-- see lib/commands/adduser.js -->
43-
4440
```bash
4541
npm adduser
4642

4743
aliases: login, add-user
4844
```
4945

50-
<!-- automatically generated, do not edit manually -->
51-
<!-- see lib/commands/adduser.js -->
52-
53-
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
54-
5546
Note: This command is unaware of workspaces.
5647

5748
### Description
@@ -75,19 +66,13 @@ your existing record.
7566

7667
### Configuration
7768

78-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
79-
<!-- automatically generated, do not edit manually -->
80-
<!-- see lib/utils/config/definitions.js -->
8169
#### `registry`
8270

8371
* Default: "https://registry.npmjs.org/"
8472
* Type: URL
8573

8674
The base URL of the npm registry.
8775

88-
<!-- automatically generated, do not edit manually -->
89-
<!-- see lib/utils/config/definitions.js -->
90-
9176
#### `scope`
9277

9378
* Default: the scope of the current project, if any, or ""
@@ -118,9 +103,6 @@ npm init --scope=@foo --yes
118103
```
119104

120105

121-
<!-- automatically generated, do not edit manually -->
122-
<!-- see lib/utils/config/definitions.js -->
123-
124106
#### `auth-type`
125107

126108
* Default: "legacy"
@@ -131,11 +113,6 @@ removed in a future version.
131113

132114
What authentication strategy to use with `login`.
133115

134-
<!-- automatically generated, do not edit manually -->
135-
<!-- see lib/utils/config/definitions.js -->
136-
137-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
138-
139116
### See Also
140117

141118
* [npm registry](/cli/v8/using-npm/registry)

‎content/cli/v8/commands/npm-audit.md

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: 1
44
description: Run a security audit
55
github_repo: npm/cli
66
github_branch: release/v8
7-
github_path: docs/content/commands/npm-audit.md
7+
github_path: docs/lib/content/commands/npm-audit.md
88
redirect_from:
99
- /cli-commands/audit
1010
- /cli-commands/npm-audit
@@ -37,19 +37,10 @@ redirect_from:
3737

3838
### Synopsis
3939

40-
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
41-
<!-- automatically generated, do not edit manually -->
42-
<!-- see lib/commands/audit.js -->
43-
4440
```bash
4541
npm audit [fix|signatures]
4642
```
4743

48-
<!-- automatically generated, do not edit manually -->
49-
<!-- see lib/commands/audit.js -->
50-
51-
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
52-
5344
### Description
5445

5546
The audit command submits a description of the dependencies configured in
@@ -278,9 +269,6 @@ $ npm audit --audit-level=moderate
278269

279270
### Configuration
280271

281-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
282-
<!-- automatically generated, do not edit manually -->
283-
<!-- see lib/utils/config/definitions.js -->
284272
#### `audit-level`
285273

286274
* Default: null
@@ -289,9 +277,6 @@ $ npm audit --audit-level=moderate
289277
The minimum level of vulnerability for `npm audit` to exit with a non-zero
290278
exit code.
291279

292-
<!-- automatically generated, do not edit manually -->
293-
<!-- see lib/utils/config/definitions.js -->
294-
295280
#### `dry-run`
296281

297282
* Default: false
@@ -305,9 +290,6 @@ commands that modify your local installation, eg, `install`, `update`,
305290
Note: This is NOT honored by other network related commands, eg `dist-tags`,
306291
`owner`, etc.
307292

308-
<!-- automatically generated, do not edit manually -->
309-
<!-- see lib/utils/config/definitions.js -->
310-
311293
#### `force`
312294

313295
* Default: false
@@ -334,9 +316,6 @@ mistakes, unnecessary performance degradation, and malicious input.
334316
If you don't have a clear idea of what you want to do, it is strongly
335317
recommended that you do not use this option!
336318

337-
<!-- automatically generated, do not edit manually -->
338-
<!-- see lib/utils/config/definitions.js -->
339-
340319
#### `json`
341320

342321
* Default: false
@@ -349,9 +328,6 @@ Whether or not to output JSON data, rather than the normal output.
349328

350329
Not supported by all npm commands.
351330

352-
<!-- automatically generated, do not edit manually -->
353-
<!-- see lib/utils/config/definitions.js -->
354-
355331
#### `package-lock-only`
356332

357333
* Default: false
@@ -366,9 +342,6 @@ instead of checking `node_modules` and downloading dependencies.
366342
For `list` this means the output will be based on the tree described by the
367343
`package-lock.json`, rather than the contents of `node_modules`.
368344

369-
<!-- automatically generated, do not edit manually -->
370-
<!-- see lib/utils/config/definitions.js -->
371-
372345
#### `omit`
373346

374347
* Default: 'dev' if the `NODE_ENV` environment variable is set to
@@ -387,9 +360,6 @@ it will be included.
387360
If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
388361
variable will be set to `'production'` for all lifecycle scripts.
389362

390-
<!-- automatically generated, do not edit manually -->
391-
<!-- see lib/utils/config/definitions.js -->
392-
393363
#### `foreground-scripts`
394364

395365
* Default: false
@@ -402,9 +372,6 @@ input, output, and error with the main npm process.
402372
Note that this will generally make installs run slower, and be much noisier,
403373
but can be useful for debugging.
404374

405-
<!-- automatically generated, do not edit manually -->
406-
<!-- see lib/utils/config/definitions.js -->
407-
408375
#### `ignore-scripts`
409376

410377
* Default: false
@@ -417,9 +384,6 @@ Note that commands explicitly intended to run a particular script, such as
417384
will still run their intended script if `ignore-scripts` is set, but they
418385
will *not* run any pre- or post-scripts.
419386

420-
<!-- automatically generated, do not edit manually -->
421-
<!-- see lib/utils/config/definitions.js -->
422-
423387
#### `workspace`
424388

425389
* Default:
@@ -442,9 +406,6 @@ brand new workspace within the project.
442406

443407
This value is not exported to the environment for child processes.
444408

445-
<!-- automatically generated, do not edit manually -->
446-
<!-- see lib/utils/config/definitions.js -->
447-
448409
#### `workspaces`
449410

450411
* Default: null
@@ -463,9 +424,6 @@ _unless_ one or more workspaces are specified in the `workspace` config.
463424

464425
This value is not exported to the environment for child processes.
465426

466-
<!-- automatically generated, do not edit manually -->
467-
<!-- see lib/utils/config/definitions.js -->
468-
469427
#### `include-workspace-root`
470428

471429
* Default: false
@@ -479,9 +437,6 @@ the specified workspaces, and not on the root project.
479437

480438
This value is not exported to the environment for child processes.
481439

482-
<!-- automatically generated, do not edit manually -->
483-
<!-- see lib/utils/config/definitions.js -->
484-
485440
#### `install-links`
486441

487442
* Default: false
@@ -491,11 +446,6 @@ When set file: protocol dependencies that exist outside of the project root
491446
will be packed and installed as regular dependencies instead of creating a
492447
symlink. This option has no effect on workspaces.
493448

494-
<!-- automatically generated, do not edit manually -->
495-
<!-- see lib/utils/config/definitions.js -->
496-
497-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
498-
499449
### See Also
500450

501451
* [npm install](/cli/v8/commands/npm-install)

‎content/cli/v8/commands/npm-bin.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: 1
44
description: Display npm bin folder
55
github_repo: npm/cli
66
github_branch: release/v8
7-
github_path: docs/content/commands/npm-bin.md
7+
github_path: docs/lib/content/commands/npm-bin.md
88
redirect_from:
99
- /cli-commands/bin
1010
- /cli-commands/npm-bin
@@ -37,19 +37,10 @@ redirect_from:
3737

3838
### Synopsis
3939

40-
<!-- AUTOGENERATED USAGE DESCRIPTIONS START -->
41-
<!-- automatically generated, do not edit manually -->
42-
<!-- see lib/commands/bin.js -->
43-
4440
```bash
4541
npm bin
4642
```
4743

48-
<!-- automatically generated, do not edit manually -->
49-
<!-- see lib/commands/bin.js -->
50-
51-
<!-- AUTOGENERATED USAGE DESCRIPTIONS END -->
52-
5344
Note: This command is unaware of workspaces.
5445

5546
### Description
@@ -58,9 +49,6 @@ Print the folder where npm will install executables.
5849

5950
### Configuration
6051

61-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
62-
<!-- automatically generated, do not edit manually -->
63-
<!-- see lib/utils/config/definitions.js -->
6452
#### `global`
6553

6654
* Default: false
@@ -75,11 +63,6 @@ folder instead of the current working directory. See
7563
* bin files are linked to `{prefix}/bin`
7664
* man pages are linked to `{prefix}/share/man`
7765

78-
<!-- automatically generated, do not edit manually -->
79-
<!-- see lib/utils/config/definitions.js -->
80-
81-
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
82-
8366
### See Also
8467

8568
* [npm prefix](/cli/v8/commands/npm-prefix)

0 commit comments

Comments
 (0)