Install pnpm with standalone script
Install pnpm via the official standalone script.
bashANYpnpminstallbootstrap
bash
curl -fsSL https://get.pnpm.io/install.sh | sh -Notes
Install pnpm via the official standalone script.
pnpm Cheat Sheet
Comprehensive pnpm CLI reference for installs, dependency management, scripts, filtering, and inspection.
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all
Getting Started
Install pnpm, initialize projects, and get quick help.
Set up pnpm on your machine
Creates the pnpm home directory and updates shell configuration as needed.
bashANYpnpmsetupbootstrap
bash
pnpm setupNotes
Creates the pnpm home directory and updates shell configuration as needed.
bash
pnpm initNotes
Create a package.json interactively.
bash
pnpm helpNotes
Display top-level CLI help.
bash
pnpm help addNotes
Display help for a specific subcommand.
bash
pnpm --versionNotes
Print the installed pnpm version.
Show Node.js version used by pnpm
Check the Node runtime in the current environment.
bashANYpnpmnodeenv
bash
pnpm exec node --versionNotes
Check the Node runtime in the current environment.
Install, Add, Remove, Update
Core package management commands.
Install all dependencies
Install dependencies from package.json and lockfile.
bashANYpnpminstalldeps
bash
pnpm installNotes
Install dependencies from package.json and lockfile.
Install with frozen lockfile
Fail if the lockfile would need changes; common in CI.
bashANYpnpminstalllockfileci
bash
pnpm install --frozen-lockfileNotes
Fail if the lockfile would need changes; common in CI.
Install in offline mode
Install using only already-fetched packages from the store.
bashANYpnpminstallofflinestore
bash
pnpm install --offlineNotes
Install using only already-fetched packages from the store.
bash
pnpm add lodashNotes
Add a package to dependencies.
bash
pnpm add -D typescriptNotes
Add a package to devDependencies.
bash
pnpm add -O fseventsNotes
Add a package to optionalDependencies.
bash
pnpm add react@18.3.1 --save-exactNotes
Save an exact version instead of a range.
bash
pnpm remove lodashNotes
Remove a package from dependencies.
bash
pnpm updateNotes
Update dependencies according to the allowed ranges.
bash
pnpm update react --latestNotes
Update a package to the latest available version.
bash
pnpm dedupeNotes
Reduce duplicates in the lockfile when possible.
Import lockfile from npm or Yarn
Generate pnpm-lock.yaml from package-lock.json, npm-shrinkwrap.json, or yarn.lock.
bashANYpnpmimportmigration
bash
pnpm importNotes
Generate pnpm-lock.yaml from package-lock.json, npm-shrinkwrap.json, or yarn.lock.
Run, Exec, and Inspect
Run scripts, binaries, and inspect dependency state.
bash
pnpm run buildNotes
Run a script from package.json.
Run script via shorthand
Run a script without typing run when there is no command ambiguity.
bashANYpnpmrunscripts
bash
pnpm testNotes
Run a script without typing run when there is no command ambiguity.
Execute binary in project context
Run a locally installed binary without adding it to PATH manually.
bashANYpnpmexecbinaries
bash
pnpm exec eslint .Notes
Run a locally installed binary without adding it to PATH manually.
Run one-off package
Download and run a package without permanently installing it.
bashANYpnpmdlxscaffold
bash
pnpm dlx create-vite@latest my-appNotes
Download and run a package without permanently installing it.
bash
pnpm listNotes
Show installed packages in a tree structure.
bash
pnpm list --depth 0Notes
Show only top-level dependencies.
Explain why a package is present
Show why a package is installed in the dependency graph.
bashANYpnpmwhyinspect
bash
pnpm why reactNotes
Show why a package is installed in the dependency graph.
Show outdated dependencies
List dependencies with newer versions available.
bashANYpnpmoutdatedinspect
bash
pnpm outdatedNotes
List dependencies with newer versions available.
bash
pnpm auditNotes
Scan dependencies for known vulnerabilities.
Attempt audit fixes
Try to apply non-breaking security updates automatically.
bashANYpnpmauditsecurityfix
bash
pnpm audit --fixNotes
Try to apply non-breaking security updates automatically.
bash
pnpm store pathNotes
Show the location of the content-addressable store.
Filtering and Recursive Execution
Target specific workspace packages and run recursively.
Install across workspace
Run install recursively across workspace packages.
bashANYpnpmworkspacerecursive
bash
pnpm -r installNotes
Run install recursively across workspace packages.
Run build in all workspace packages
Run a script recursively in all packages.
bashANYpnpmworkspacerecursivescripts
bash
pnpm -r run buildNotes
Run a script recursively in all packages.
Operate on one workspace package
Limit a command to a selected workspace package.
bashANYpnpmworkspacefilter
bash
pnpm --filter @acme/web testNotes
Limit a command to a selected workspace package.
Filter package and dependents
Target a package and packages that depend on it.
bashANYpnpmworkspacefilterdependents
bash
pnpm --filter @acme/ui... buildNotes
Target a package and packages that depend on it.
Filter package and its deps
Target a package and its dependency chain.
bashANYpnpmworkspacefilterdependencies
bash
pnpm --filter ...@acme/api testNotes
Target a package and its dependency chain.
bash
pnpm --filter ./packages/web... lintNotes
Target packages by path selector.
bash
pnpm -r --parallel run devNotes
Run a script in parallel across packages.
bash
pnpm -r --stream testNotes
Stream real-time output from recursive runs.
More in pnpm
pnpm CI, Env, and Patching
CI installs, fetch, production pruning, Node runtime management, patching, and troubleshooting.
pnpm Publish and Registry
Pack, publish, dist-tags, registries, auth, and package metadata queries.
pnpm Config and Store
Configuration, .npmrc, store/cache operations, and installation model settings.
pnpm Workspaces
Workspace setup, filtering, recursive execution, deploy flows, and catalogs.
pnpm Install and Dependencies
Dependency types, package sources, versions, lockfiles, and reproducible installs.