Skip to content

docs: add deprecated commands to README #685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add deprecated commands to README #685

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,19 @@ range specified in `devEngines.packageManager.version`, or fallback to the
same major line. Should you need to upgrade to a new major, use an explicit
`corepack use {name}@latest` call (or simply `corepack use {name}`).

## Utility Commands (deprecated)

The utility commands `corepack hydrate` and `corepack prepare` were deprecated with [[email protected]](https://github.com/nodejs/corepack/releases/tag/v0.20.0).
It is recommended to use the replacement commands as shown in the following table:

| Deprecated command | Replacement command |
| ------------------------------------------------- | ------------------------------------------------------ |
| `corepack hydrate path/to/archive.tgz` | `corepack install -g --cache-only path/to/archive.tgz` |
| `corepack hydrate path/to/archive.tgz --activate` | `corepack install -g path/to/archive.tgz` |
| `corepack prepare [email protected]` | `corepack install -g --cache-only [email protected]` |
| `corepack prepare [email protected] --activate` | `corepack install -g [email protected]` |
| `corepack prepare -o ...` | `corepack pack -o ...` |

## Environment Variables

- `COREPACK_DEFAULT_TO_LATEST` can be set to `0` in order to instruct Corepack
Expand Down