CheatPress

pnpm Fast Node package manager

Version 10.21.0 · source

pnpm, Postcard, light preview Light · Postcard 102 × 152 mm · PDF pnpm, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF pnpm, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
pnpm, A5, light preview Light · A5 148 × 210 mm · PDF pnpm, A5, dark preview Dark · A5 148 × 210 mm · PDF pnpm, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
pnpm, A4, light preview Light · A4 210 × 297 mm · PDF pnpm, A4, dark preview Dark · A4 210 × 297 mm · PDF pnpm, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
pnpm, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF pnpm, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF pnpm, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
pnpm, A3, light preview Light · A3 297 × 420 mm · PDF pnpm, A3, dark preview Dark · A3 297 × 420 mm · PDF pnpm, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
pnpm, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF pnpm, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF pnpm, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
pnpm, Letter, light preview Light · Letter 8.5 × 11 in · PDF pnpm, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF pnpm, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
pnpm, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF pnpm, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF pnpm, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

pnpm install
Install all dependencies
pnpm add <pkg>
Add a dependency
pnpm remove <pkg>
Remove a dependency
pnpm run <script>
Run a package script
pnpm dlx <pkg>
Run a package once
pnpm update
Update within ranges
pnpm --filter <pkg> <cmd>
Target one workspace package
pnpm install --frozen-lockfile
Clean install for CI

Concepts

  1. Registry npm packages
  2. Global store shared files
  3. node_modules/.pnpm virtual store
  4. node_modules direct deps only

Install and add

pnpm install
Install all dependencies
pnpm add <pkg>
Add a dependency
pnpm add -D <pkg>
Add a dev dependency
pnpm add <pkg>@<version>
Add a specific version or tag
pnpm add -g <pkg>
Install a global package
pnpm add -E <pkg>
Save the exact version
pnpm install --frozen-lockfile
Fail if lockfile needs changes
This is already the default in CI environments; use --no-frozen-lockfile to override.
pnpm install --prod
Skip devDependencies
pnpm install --ignore-scripts
Do not run lifecycle scripts

Remove and update

pnpm remove <pkg>
Remove a dependency
pnpm update
Update within package.json ranges
pnpm update <pkg>
Update one package
pnpm update --latest
Ignore ranges, go to latest
pnpm update -i
Pick updates interactively
pnpm update -i --latest
Pick latest versions interactively
pnpm outdated
List outdated packages
pnpm dedupe
Merge duplicate versions in lockfile

Run scripts

pnpm run <script>
Run a package script
pnpm <script>
Shorthand for pnpm run
Works unless the name clashes with a built-in pnpm command.
pnpm test
Run the test script
pnpm start
Run the start script
pnpm run <script> -- <args>
Pass arguments to a script
pnpm exec <cmd>
Run a binary from node_modules/.bin
pnpm dlx <pkg> [args]
Fetch and run without installing
pnpm create <starter>
Scaffold from a create-* starter
pnpm init
Create a package.json

Inspect

pnpm list
Show installed packages as a tree
pnpm ls --depth <n>
Limit tree depth
pnpm ls <pkg>
Find where a package is used
pnpm why <pkg>
Show what depends on a package
pnpm audit
Check for known vulnerabilities

Workspaces

pnpm -r <cmd>
Run a command in every package
pnpm --filter <pkg> <cmd>
Run in one package
pnpm --filter <pkg>... <cmd>
Package and its dependencies
pnpm --filter ...<pkg> <cmd>
Package and its dependents
pnpm --filter "...[origin/main]" <cmd>
Packages changed since a ref
pnpm -w add -D <pkg>
Add to the workspace root
pnpm add <pkg> --workspace
Link a local workspace package
pnpm -r --parallel run <script>
Run everywhere at once, no ordering
pnpm -r run <script>
Run in dependency order
pnpm-workspace.yaml
packages:  - 'packages/*'  - '!**/test/**'

Catalogs and settings

Shared versions in pnpm-workspace.yaml
catalog:  react: ^19.0.0catalogs:  legacy:    react: ^17.0.2
Use them in package.json
"react": "catalog:""react": "catalog:legacy"
pnpm add <pkg> --save-catalog
Add and record it in the default catalog
pnpm config get <key>
Read a setting
pnpm config set <key> <value>
Write a setting
pnpm approve-builds
Allow dependency build scripts
Recent pnpm versions block dependency install scripts until approved.

Store and patching

pnpm store path
Show the store location
pnpm store prune
Delete unreferenced packages from the store
pnpm link <dir>
Link a local package into this project
pnpm patch <pkg>@<version>
Extract a package to edit
pnpm patch-commit <dir>
Save the edits as a patch
pnpm publish
Publish to the registry

Recipes

Start a project
pnpm initpnpm add expresspnpm add -D typescript vitestpnpm test
CI install and test
pnpm install --frozen-lockfilepnpm -r run buildpnpm -r run test
Build one app and what it needs
pnpm --filter <app>... run build# only changed packages and dependentspnpm --filter "...[origin/main]" run test
Patch a dependency
pnpm patch <pkg>@<version># edit the printed folderpnpm patch-commit <dir>