Skip to content

Commit

Permalink
CLI documentation update from CI
Browse files Browse the repository at this point in the history
  • Loading branch information
npm-cli-bot committed Jan 29, 2025
1 parent e0c36d3 commit 540d1cf
Show file tree
Hide file tree
Showing 9 changed files with 188 additions and 57 deletions.
2 changes: 1 addition & 1 deletion cli-cache.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"v8": "aa8fff11cdab94fff1a2160ee5241f5f4632e96b",
"v9": "64763a341e7aa5b456e696f956759bf9b3440dc1",
"v10": "a3041941586b6fb8ed7403fe3c24d81138a96005",
"v11": "6d0f46e67e9673e8a2dc6edb92144a73f853950c"
"v11": "cab74ff7c25149d172cf5d612eb0a651eda531e3"
}
9 changes: 9 additions & 0 deletions content/cli/v11/commands/npm-deprecate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@ This is a one-time password from a two-factor authenticator. It's needed when pu

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.

#### `dry-run`

- Default: false
- Type: Boolean

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`.

Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.

### See Also

- [package spec](/cli/v11/using-npm/package-spec)
Expand Down
4 changes: 2 additions & 2 deletions content/cli/v11/commands/npm-ls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
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:

```bash
npm@11.0.0 /path/to/npm
npm@11.1.0 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down Expand Up @@ -112,7 +112,7 @@ Operates in "global" mode, so that packages are installed into the `prefix` fold

#### `depth`

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

The depth to go when recursing packages for `npm ls`.
Expand Down
81 changes: 81 additions & 0 deletions content/cli/v11/commands/npm-undeprecate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: npm-undeprecate
section: 1
description: Undeprecate a version of a package
github_repo: npm/cli
github_branch: latest
github_path: docs/lib/content/commands/npm-undeprecate.md
redirect_from:
- /cli-commands/npm-undeprecate
- /cli-commands/undeprecate
- /cli-documentation/cli-commands/npm-undeprecate
- /cli-documentation/cli-commands/undeprecate
- /cli-documentation/commands/npm-undeprecate
- /cli-documentation/commands/undeprecate
- /cli-documentation/npm-undeprecate
- /cli-documentation/undeprecate
- /cli-documentation/v11/cli-commands/npm-undeprecate
- /cli-documentation/v11/cli-commands/undeprecate
- /cli-documentation/v11/commands/npm-undeprecate
- /cli-documentation/v11/commands/undeprecate
- /cli-documentation/v11/npm-undeprecate
- /cli-documentation/v11/undeprecate
- /cli/cli-commands/npm-undeprecate
- /cli/cli-commands/undeprecate
- /cli/commands/npm-undeprecate
- /cli/commands/undeprecate
- /cli/npm-undeprecate
- /cli/undeprecate
- /cli/v11/cli-commands/npm-undeprecate
- /cli/v11/cli-commands/undeprecate
- /cli/v11/commands/undeprecate
- /cli/v11/npm-undeprecate
- /cli/v11/undeprecate
- /commands/npm-undeprecate
- /commands/undeprecate
---

### Synopsis

```bash
npm undeprecate <package-spec>
```

Note: This command is unaware of workspaces.

### Description

This command will update the npm registry entry for a package, removing any deprecation warnings that currently exist.

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.

### Configuration

#### `registry`

- Default: "https://registry.npmjs.org/"
- Type: URL

The base URL of the npm registry.

#### `otp`

- Default: null
- Type: null or String

This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with `npm access`.

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.

#### `dry-run`

- Default: false
- Type: Boolean

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`.

Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.

### See Also

- [npm deprecate](/cli/v11/commands/npm-deprecate)
2 changes: 1 addition & 1 deletion content/cli/v11/commands/npm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.

### Version

11.0.0
11.1.0

### Description

Expand Down
Loading

0 comments on commit 540d1cf

Please sign in to comment.