Skip to content

Commit ef9ed48

Browse files
committed
CLI documentation update from CI
1 parent 4ac55b5 commit ef9ed48

File tree

16 files changed

+98
-20
lines changed

16 files changed

+98
-20
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": "f69c403700acb05dbb56d8516bca5130627e597c",
5-
"v11": "804a9646e41d3aaa11ed084aa0c9997b7375882f"
5+
"v11": "946b34a1c1a364acfed36ba5f2eaa3c6e5036e19"
66
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This command tries to guess at the likely location of a package's bug tracker UR
5151
5252
#### `browser`
5353
54-
- Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
54+
- Default: macOS: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
5555
- Type: null, Boolean, or String
5656
5757
The browser that is called by npm commands to open websites.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This command tries to guess at the likely location of a package's documentation
5151
5252
#### `browser`
5353
54-
- Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
54+
- Default: macOS: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
5555
- Type: null, Boolean, or String
5656
5757
The browser that is called by npm commands to open websites.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Not supported by all npm commands.
9696

9797
#### `browser`
9898

99-
- Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
99+
- Default: macOS: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
100100
- Type: null, Boolean, or String
101101

102102
The browser that is called by npm commands to open websites.

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,15 @@ Note that commands explicitly intended to run a particular script, such as `npm
186186

187187
When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v11/commands/npm-audit) for details on what is submitted.
188188

189+
#### `before`
190+
191+
- Default: null
192+
- Type: null or Date
193+
194+
If passed to `npm install`, will rebuild the npm tree such that only versions that were available **on or before** the given date are installed. If there are no versions available for the current set of dependencies, the command will error.
195+
196+
If the requested version is a `dist-tag` and the given tag does not pass the `--before` filter, the most recent version less than or equal to that tag will be used. For example, `foo@latest` might install `[email protected]` even though `latest` is `2.0`.
197+
189198
#### `bin-links`
190199

191200
- Default: true

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,15 @@ Note that commands explicitly intended to run a particular script, such as `npm
465465
466466
When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v11/commands/npm-audit) for details on what is submitted.
467467
468+
#### `before`
469+
470+
- Default: null
471+
- Type: null or Date
472+
473+
If passed to `npm install`, will rebuild the npm tree such that only versions that were available **on or before** the given date are installed. If there are no versions available for the current set of dependencies, the command will error.
474+
475+
If the requested version is a `dist-tag` and the given tag does not pass the `--before` filter, the most recent version less than or equal to that tag will be used. For example, `foo@latest` might install `[email protected]` even though `latest` is `2.0`.
476+
468477
#### `bin-links`
469478
470479
- Default: true

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
5252
Positional arguments are `name@version-range` identifiers, which will limit the results to only the paths to the packages named. Note that nested packages will _also_ show the paths to the specified packages. For example, running `npm ls promzard` in npm's source tree will show:
5353

5454
```bash
55-
npm@11.4.2 /path/to/npm
55+
npm@11.5.0 /path/to/npm
5656
5757
5858
```

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,15 @@ When set for the `npm init` command, this may be set to the folder of a workspac
151151

152152
This value is not exported to the environment for child processes.
153153

154+
#### `before`
155+
156+
- Default: null
157+
- Type: null or Date
158+
159+
If passed to `npm install`, will rebuild the npm tree such that only versions that were available **on or before** the given date are installed. If there are no versions available for the current set of dependencies, the command will error.
160+
161+
If the requested version is a `dist-tag` and the given tag does not pass the `--before` filter, the most recent version less than or equal to that tag will be used. For example, `foo@latest` might install `[email protected]` even though `latest` is `2.0`.
162+
154163
### See Also
155164

156165
- [package spec](/cli/v11/using-npm/package-spec)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ This command tries to guess at the likely location of a package's repository URL
4949
5050
#### `browser`
5151
52-
- Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
52+
- Default: macOS: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
5353
- Type: null, Boolean, or String
5454
5555
The browser that is called by npm commands to open websites.

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,15 @@ Note that commands explicitly intended to run a particular script, such as `npm
271271

272272
When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v11/commands/npm-audit) for details on what is submitted.
273273

274+
#### `before`
275+
276+
- Default: null
277+
- Type: null or Date
278+
279+
If passed to `npm install`, will rebuild the npm tree such that only versions that were available **on or before** the given date are installed. If there are no versions available for the current set of dependencies, the command will error.
280+
281+
If the requested version is a `dist-tag` and the given tag does not pass the `--before` filter, the most recent version less than or equal to that tag will be used. For example, `foo@latest` might install `[email protected]` even though `latest` is `2.0`.
282+
274283
#### `bin-links`
275284

276285
- Default: true

0 commit comments

Comments
 (0)