Skip to content

Commit cbdc1c9

Browse files
committed
CLI documentation update from CI
1 parent caa3cf4 commit cbdc1c9

27 files changed

+107
-63
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": "6755ca2d5301b079f9e2581fc72ba2a612171364",
5-
"v11": "5b4a7fc594e23dbdd5acab8df7bd195992383d5f"
5+
"v11": "072253549d774893a3689341dbc660cb845ebcfe"
66
}

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

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,25 +55,15 @@ Used to set access controls on private packages.
5555
5656
For all of the subcommands, `npm access` will perform actions on the packages in the current working directory if no package name is passed to the subcommand.
5757
58-
- public / restricted (deprecated): Set a package to be either publicly accessible or restricted.
59-
60-
- grant / revoke (deprecated): Add or remove the ability of users and teams to have read-only or read-write access to a package.
61-
62-
- 2fa-required / 2fa-not-required (deprecated): Configure whether a package requires that anyone publishing it have two-factor authentication enabled on their account.
63-
64-
- ls-packages (deprecated): Show all of the packages a user or a team is able to access, along with the access level, except for read-only public packages (it won't print the whole registry listing)
65-
66-
- ls-collaborators (deprecated): Show all of the access privileges for a package. Will only show permissions for packages to which you have at least read access. If `<user>` is passed in, the list is filtered only to teams _that_ user happens to belong to.
67-
68-
- edit (not implemented)
58+
- grant / revoke: Add or remove the ability of users and teams to have read-only or read-write access to a package.
6959
7060
### Details
7161
7262
`npm access` always operates directly on the current registry, configurable from the command line using `--registry=<registry url>`.
7363
7464
Unscoped packages are _always public_.
7565
76-
Scoped packages _default to restricted_, but you can either publish them as public using `npm publish --access=public`, or set their access as public using `npm access public` after the initial publish.
66+
Scoped packages _default to restricted_, but you can either publish them as public using `npm publish --access=public`, or set their access as public using `npm access set status=public` after the initial publish.
7767
7868
You must have privileges to set the access of a package:
7969

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The `sig` is generated using the following template: `${package.name}@${package.
102102
Keys response:
103103

104104
- `expires`: null or a simplified extended [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601): `YYYY-MM-DDTHH:mm:ss.sssZ`
105-
- `keydid`: sha256 fingerprint of the public key
105+
- `keyid`: sha256 fingerprint of the public key
106106
- `keytype`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
107107
- `scheme`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
108108
- `key`: base64 encoded public key
@@ -285,7 +285,7 @@ If set to false, then ignore `package-lock.json` files when installing. This wil
285285

286286
#### `omit`
287287

288-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
288+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
289289
- Type: "dev", "optional", or "peer" (can be set multiple times)
290290

291291
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Only install direct dependencies in the top level `node_modules`, but hoist on d
114114

115115
#### `omit`
116116

117-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
117+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
118118
- Type: "dev", "optional", or "peer" (can be set multiple times)
119119

120120
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ If set to false, then ignore `package-lock.json` files when installing. This wil
137137
138138
#### `omit`
139139
140-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
140+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
141141
- Type: "dev", "optional", or "peer" (can be set multiple times)
142142
143143
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ If set to false, then ignore `package-lock.json` files when installing. This wil
9090

9191
#### `omit`
9292

93-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
93+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
9494
- Type: "dev", "optional", or "peer" (can be set multiple times)
9595

9696
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Only install direct dependencies in the top level `node_modules`, but hoist on d
7474

7575
#### `omit`
7676

77-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
77+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
7878
- Type: "dev", "optional", or "peer" (can be set multiple times)
7979

8080
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Only install direct dependencies in the top level `node_modules`, but hoist on d
103103

104104
#### `omit`
105105

106-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
106+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
107107
- Type: "dev", "optional", or "peer" (can be set multiple times)
108108

109109
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ Only install direct dependencies in the top level `node_modules`, but hoist on d
382382
383383
#### `omit`
384384
385-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
385+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
386386
- Type: "dev", "optional", or "peer" (can be set multiple times)
387387
388388
Dependency types to omit from the installation tree on disk.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ If set to false, then ignore `package-lock.json` files when installing. This wil
182182

183183
#### `omit`
184184

185-
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
185+
- Default: 'dev' if the `NODE_ENV` environment variable is set to 'production'; otherwise, empty.
186186
- Type: "dev", "optional", or "peer" (can be set multiple times)
187187

188188
Dependency types to omit from the installation tree on disk.

0 commit comments

Comments
 (0)