pnpm

https://pnpm.io
Admin
pnpm is a fast, disk-space efficient package manager for JavaScript that offers lightning-fast...
Tokens:769,422
Snippets:8,227
Trust Score:9.9
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install a package using a named-registry prefix

Source: https://pnpm.io/zh-TW/registries

Installs `@corp/lib` at version `^2.0.0` from the registry associated with the `work` prefix. The prefix must be declared in `pnpm-workspace.yaml` as shown in the previous example.

```sh
pnpm add work:@corp/lib@^2.0.0
```

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

### Add a package using a catalog entry

Source: https://pnpm.io/zh-TW/config-dependencies

After installing a config dependency that defines a catalog entry, you can install packages using the `catalog:` protocol. This example installs `is-odd` from the catalog.

```bash
pnpm add is-odd@catalog:
```

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

### Install from a Git repository via full URL

Source: https://pnpm.io/package-sources

Spell out the full Git URL for explicit or alternative Git hosting. Examples show git+ssh and https protocols.

```sh
# git+ssh
pnpm add git+ssh://git@github.com:zkochan/is-negative.git#2.0.1

# https
pnpm add https://github.com/zkochan/is-negative.git#2.0.1
```

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

### Build the @pnpm/wasm distribution

Source: https://pnpm.io/webcontainers

Run from the pnpm repository root after following the WASM runtime guide toolchain setup. Produces target/pnpm-wasm.tgz, which can be copied into a WebContainer and installed with npm install --global ./pnpm-wasm.tgz.

```sh
pnpm build:pnpm:wasm
pnpm pack:pnpm:wasm
```

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

### Install from a Git repository using hosting provider shorthand

Source: https://pnpm.io/package-sources

Use a protocol shorthand [provider]: for GitHub, Bitbucket, or GitLab. If omitted, defaults to github:.

```sh
pnpm add github:zkochan/is-negative
pnpm add bitbucket:pnpmjs/git-resolver
pnpm add gitlab:pnpm/git-resolver
```

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

### pnpm repo usage examples

Source: https://pnpm.io/cli/repo

Examples showing how to open the repository of the current project, a single package from the registry, or multiple packages at once.

```sh
# Open the repo of the current project
pnpm repo

# Open the repo of a package on the registry
pnpm repo lodash

# Open multiple repos at once
pnpm repo react react-dom
```

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

### Install a config dependency with pnpm add --config

Source: https://pnpm.io/zh-TW/config-dependencies

Use this command to install a config dependency. The example installs `@myorg/pnpm-plugin-my-catalogs`.

```bash
pnpm add --config @myorg/pnpm-plugin-my-catalogs
```

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

### Install from a Git repository combining different parameters

Source: https://pnpm.io/package-sources

Combine multiple parameters with & to install from a specific branch (beta) and subdirectory (/packages/simple-react-app).

```sh
pnpm add RexSkz/test-git-subdir-fetch.git#beta\&path:/packages/simple-react-app
```

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

### Install multiple global packages in one command

Source: https://pnpm.io/zh-TW/global-packages

Installs typescript, prettier, and eslint globally. Each space-separated package gets its own isolated installation.

```sh
pnpm add -g typescript prettier eslint
```

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

### Install multiple global packages with pnpm add -g

Source: https://pnpm.io/es/global-packages

Installs several global packages in one command. Each space-separated package gets its own isolated installation.

```sh
pnpm add -g typescript prettier eslint
```

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

### Install a package using the work: prefix

Source: https://pnpm.io/es/registries

Installs @corp/lib@^2.0.0 through the registry declared with the "work" prefix.

```sh
pnpm add work:@corp/lib@^2.0.0
```

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

### Install space-separated global packages as separate isolated installs

Source: https://pnpm.io/es/global-packages

Installing multiple space-separated packages in a single command creates a separate isolated install for each. eslint and prettier each get their own node_modules tree and lockfile and can be removed independently.

```sh
pnpm add -g eslint prettier
```

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

### Install provisioned tools using tool: protocol

Source: https://pnpm.io/package-sources

Downloads tools like Node.js, Bun, Deno, and Yarn from their own releases instead of npm. runtime: is an alias for tool: and lockfiles still record entries with runtime:.

```sh
pnpm add node@tool:24
pnpm add bun@tool:1.3.0
pnx node@tool:22 --version
pnx yarn@tool:4 --version
```

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

### Install from a subdirectory of a Git repository

Source: https://pnpm.io/package-sources

Uses the path: parameter to install only a subdirectory (/packages/simple-react-app) from a Git-hosted monorepo.

```sh
pnpm add RexSkz/test-git-subfolder-fetch#path:/packages/simple-react-app
```

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

### Install from remote tarball URL

Source: https://pnpm.io/package-sources

Use a fetchable URL starting with http:// or https:// to install a package from a remote tarball.

```sh
pnpm add https://github.com/indexzero/forever/tarball/v0.5.6
```

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

### pnpm pkg get examples

Source: https://pnpm.io/cli/pkg

Retrieve values from package.json. With no arguments, prints the full manifest; with keys, prints the requested fields. A single string key prints the raw value unless --json is used.

```sh
pnpm pkg get name
pnpm pkg get name version
pnpm pkg get scripts.test
```

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

### Install Node.js prerelease globally

Source: https://pnpm.io/cli/runtime

Installs a prerelease version of Node.js globally. Examples include nightly, rc, rc/22, and a specific version 22.0.0-rc.4.

```sh
pnpm runtime set node nightly -g
pnpm runtime set node rc -g
pnpm runtime set node rc/22 -g
pnpm runtime set node 22.0.0-rc.4 -g
```

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

### Install specific package versions with pnx --package

Source: https://pnpm.io/cli/pnx

Use --package to install a package before running its command. The second example pins the version to 0.

```sh
pnx --package=@pnpm/meta-updater meta-updater --help
pnx --package=@pnpm/meta-updater@0 meta-updater --help
```

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

### Install from Git repository using semver version range

Source: https://pnpm.io/package-sources

Uses the semver: parameter with a version range (^2.0.0) to install from the Git repository.

```sh
pnpm add kevva/is-positive#semver:^2.0.0
```

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

### pnpm doctor successful output

Source: https://pnpm.io/es/cli/doctor

Example output when all checks pass, showing versions, install method, directories, filesystem link strategies, registry connectivity, and the install smoke test.

```text
✓ Versions: pnpm 11.14.0, Node.js 22.20.0
✓ Install method: pnpm
✓ Global bin directory: /Users/example/Library/pnpm/bin
✓ Cache directory: /Users/example/Library/Caches/pnpm
✓ Store directory: /Users/example/Library/pnpm/store/v10
✓ Filesystem: available: reflink, hardlink, symlink
✓ Registry connectivity: https://registry.npmjs.org/ (128ms)
✓ Install smoke test: offline "file:" install linked its dependency

All checks passed
```

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

### Example output of packages awaiting approval

Source: https://pnpm.io/cli/permissions

Shows the format of packages awaiting approval, listing each package once with all requested capabilities.

```text
drizzle-kit  build, skills
esbuild      build
```
Tokens:
Raw