Corepack

https://nodejs.org/docs/latest/
Admin
Corepack is a zero-runtime-dependency Node.js script that acts as a bridge between Node.js projects...
Tokens:3,087
Snippets:40
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Corepack Globally using npm (Bash)

Source: https://nodejs.org/docs/latest/api/corepack.html

This command installs Corepack globally on your system using npm. This is an alternative installation method, though using the version bundled with Node.js is generally preferred.

```bash
npm install -g corepack
```

--------------------------------

### Uninstall Global Package Managers (Bash)

Source: https://nodejs.org/docs/latest/api/corepack.html

Before installing Corepack globally using npm, it's recommended to uninstall any existing global Yarn and pnpm installations. This ensures a clean setup. Note that npm itself should not be uninstalled.

```bash
npm uninstall -g yarn pnpm
```

--------------------------------

### Update Corepack using npm (Bash)

Source: https://nodejs.org/docs/latest/api/corepack.html

This command updates Corepack to the latest available version using npm. If Corepack was installed via a Node.js Windows Installer (.msi), you might need to remove it first through Windows app settings.

```bash
npm install -g corepack@latest
```

--------------------------------

### Enable Corepack Package Managers (Bash)

Source: https://nodejs.org/docs/latest/api/corepack.html

This command enables the required Yarn and pnpm binaries to be available on your system's PATH. It's the recommended way to set up Corepack when using Node.js versions from 14.19.0 up to (but not including) 25.0.0.

```bash
corepack enable
```

--------------------------------

### Configure Shell Aliases for Corepack

Source: https://nodejs.org/docs/latest/api/corepack.html

Workaround for read-only file systems by creating shell aliases or functions to point package manager commands to the corepack binary.

```bash
alias yarn="corepack yarn"
alias yarnpkg="corepack yarnpkg"
alias pnpm="corepack pnpm"
alias pnpx="corepack pnpx"
alias npm="corepack npm"
alias npx="corepack npx"
```

```powershell
echo 'function yarn { corepack yarn @args }'    >> $PROFILE
echo 'function yarnpkg { corepack yarnpkg @args }' >> $PROFILE
echo 'function pnpm { corepack pnpm @args }'    >> $PROFILE
echo 'function pnpx { corepack pnpx @args }'    >> $PROFILE
echo 'function npm { corepack npm @args }'      >> $PROFILE
echo 'function npx { corepack npx @args }'      >> $PROFILE
```

--------------------------------

### Configure devEngines.packageManager in package.json

Source: https://nodejs.org/docs/latest/api/corepack.html

Provides validation rules for the package manager used in a project. It allows specifying the name, version, and failure behavior when a mismatch occurs.

```json
{
  "devEngines":{
    "packageManager": {
      "name": "yarn",
      "version": "3.2.3+sha224.953c8233f7a92884eee2de69a1b92d1f2ec1655e66d08071ba9a02fa"
    }
  }
}
```

--------------------------------

### Configure packageManager in package.json

Source: https://nodejs.org/docs/latest/api/corepack.html

Defines the required package manager and version for a project. This ensures consistency across environments by pinning the manager and optionally validating with a SHA hash.

```json
{
  "packageManager": "yarn@3.2.3+sha224.953c8233f7a92884eee2de69a1b92d1f2ec1655e66d08071ba9a02fa"
}
```

```json
{
  "packageManager": "yarn@https://registry.npmjs.org/@yarnpkg/cli-dist/-/cli-dist-3.2.3.tgz#sha224.16a0797d1710d1fb7ec40ab5c3801b68370a612a9b66ba117ad9924b"
}
```
Tokens:
Raw