Skip to content

Commit 540d1cf

Browse files
committed
CLI documentation update from CI
1 parent e0c36d3 commit 540d1cf

File tree

9 files changed

+188
-57
lines changed

9 files changed

+188
-57
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": "a3041941586b6fb8ed7403fe3c24d81138a96005",
5-
"v11": "6d0f46e67e9673e8a2dc6edb92144a73f853950c"
5+
"v11": "cab74ff7c25149d172cf5d612eb0a651eda531e3"
66
}

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,15 @@ This is a one-time password from a two-factor authenticator. It's needed when pu
8383

8484
If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.
8585

86+
#### `dry-run`
87+
88+
- Default: false
89+
- Type: Boolean
90+
91+
Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
92+
93+
Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
94+
8695
### See Also
8796

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

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

Lines changed: 2 additions & 2 deletions
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.0.0 /path/to/npm
55+
npm@11.1.0 /path/to/npm
5656
5757
5858
```
@@ -112,7 +112,7 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold
112112

113113
#### `depth`
114114

115-
- Default: `Infinity` if `--all` is set, otherwise `1`
115+
- Default: `Infinity` if `--all` is set, otherwise `0`
116116
- Type: null or Number
117117

118118
The depth to go when recursing packages for `npm ls`.
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: npm-undeprecate
3+
section: 1
4+
description: Undeprecate a version of a package
5+
github_repo: npm/cli
6+
github_branch: latest
7+
github_path: docs/lib/content/commands/npm-undeprecate.md
8+
redirect_from:
9+
- /cli-commands/npm-undeprecate
10+
- /cli-commands/undeprecate
11+
- /cli-documentation/cli-commands/npm-undeprecate
12+
- /cli-documentation/cli-commands/undeprecate
13+
- /cli-documentation/commands/npm-undeprecate
14+
- /cli-documentation/commands/undeprecate
15+
- /cli-documentation/npm-undeprecate
16+
- /cli-documentation/undeprecate
17+
- /cli-documentation/v11/cli-commands/npm-undeprecate
18+
- /cli-documentation/v11/cli-commands/undeprecate
19+
- /cli-documentation/v11/commands/npm-undeprecate
20+
- /cli-documentation/v11/commands/undeprecate
21+
- /cli-documentation/v11/npm-undeprecate
22+
- /cli-documentation/v11/undeprecate
23+
- /cli/cli-commands/npm-undeprecate
24+
- /cli/cli-commands/undeprecate
25+
- /cli/commands/npm-undeprecate
26+
- /cli/commands/undeprecate
27+
- /cli/npm-undeprecate
28+
- /cli/undeprecate
29+
- /cli/v11/cli-commands/npm-undeprecate
30+
- /cli/v11/cli-commands/undeprecate
31+
- /cli/v11/commands/undeprecate
32+
- /cli/v11/npm-undeprecate
33+
- /cli/v11/undeprecate
34+
- /commands/npm-undeprecate
35+
- /commands/undeprecate
36+
---
37+
38+
### Synopsis
39+
40+
```bash
41+
npm undeprecate <package-spec>
42+
```
43+
44+
Note: This command is unaware of workspaces.
45+
46+
### Description
47+
48+
This command will update the npm registry entry for a package, removing any deprecation warnings that currently exist.
49+
50+
It works in the same way as [npm deprecate](/cli/v11/commands/npm-deprecate), except that this command removes deprecation warnings instead of adding them.
51+
52+
### Configuration
53+
54+
#### `registry`
55+
56+
- Default: "https://registry.npmjs.org/"
57+
- Type: URL
58+
59+
The base URL of the npm registry.
60+
61+
#### `otp`
62+
63+
- Default: null
64+
- Type: null or String
65+
66+
This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with `npm access`.
67+
68+
If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.
69+
70+
#### `dry-run`
71+
72+
- Default: false
73+
- Type: Boolean
74+
75+
Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
76+
77+
Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
78+
79+
### See Also
80+
81+
- [npm deprecate](/cli/v11/commands/npm-deprecate)

content/cli/v11/commands/npm.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.
3131

3232
### Version
3333

34-
11.0.0
34+
11.1.0
3535

3636
### Description
3737

0 commit comments

Comments
 (0)