pnpm Install and Dependencies

Dependency types, package sources, versions, lockfiles, and reproducible installs.

View
StandardDetailedCompact
Export
Copy the compact sheet, download it, or print it.
Download
`D` dense toggle · `C` copy all

Dependency Types

Install dependencies into the right bucket.

Add production dependency

Save package to dependencies.

bashANYpnpmdependencies
bash
pnpm add express
Notes

Save package to dependencies.

Add development dependency

Save package to devDependencies.

bashANYpnpmdevDependencies
bash
pnpm add -D vitest
Notes

Save package to devDependencies.

Add optional dependency

Save package to optionalDependencies.

bashANYpnpmoptionalDependencies
bash
pnpm add -O sharp
Notes

Save package to optionalDependencies.

Add peer dependency entry

Install for local development and declare the peer dependency in package.json.

bashANYpnpmpeerDependencies
bash
pnpm add -D react && pnpm pkg set peerDependencies.react='^18.0.0'
Notes

Install for local development and declare the peer dependency in package.json.

Install package globally

Install a package globally.

bashANYpnpmglobaladd
bash
pnpm add -g npm-check-updates
Notes

Install a package globally.

Versions and Sources

Install from versions, tags, files, tarballs, Git, and local paths.

Install dist-tag

Install a package using a registry dist-tag.

bashANYpnpmaddtags
bash
pnpm add react@next
Notes

Install a package using a registry dist-tag.

Install exact version

Install a specific version.

bashANYpnpmaddversion
bash
pnpm add react@18.3.1
Notes

Install a specific version.

Install version range

Install a version range.

bashANYpnpmaddversion
bash
pnpm add react@^18
Notes

Install a version range.

Install tarball URL

Install a package from a tarball URL.

bashANYpnpmaddtarball
bash
pnpm add https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz
Notes

Install a package from a tarball URL.

Install from Git repo

Install a package directly from a Git-hosted repository.

bashANYpnpmaddgit
bash
pnpm add github:lodash/lodash
Notes

Install a package directly from a Git-hosted repository.

Install local folder

Install from a local directory path.

bashANYpnpmaddlocal
bash
pnpm add ./packages/utils
Notes

Install from a local directory path.

Install workspace package via protocol

Link a workspace package using the workspace protocol.

bashANYpnpmworkspaceprotocol
bash
pnpm add @acme/ui@workspace:*
Notes

Link a workspace package using the workspace protocol.

Lockfiles and Reproducibility

Keep installs deterministic.

Clean install from lockfile

Perform a clean install from an existing lockfile.

bashANYpnpmcilockfile
bash
pnpm ci
Notes

Perform a clean install from an existing lockfile.

Prefer frozen lockfile

Prefer a frozen install but allow lockfile generation when needed.

bashANYpnpmlockfile
bash
pnpm install --prefer-frozen-lockfile
Notes

Prefer a frozen install but allow lockfile generation when needed.

Install without lockfile

Avoid generating or using a lockfile in temporary scenarios.

bashANYpnpmlockfile
bash
pnpm install --no-lockfile
Notes

Avoid generating or using a lockfile in temporary scenarios.

Check lockfile status in Git

Inspect lockfile changes after dependency operations.

bashANYpnpmlockfilegit
bash
git diff -- pnpm-lock.yaml
Notes

Inspect lockfile changes after dependency operations.

Show outdated packages with details

Display richer outdated dependency information.

bashANYpnpmoutdated
bash
pnpm outdated --long
Notes

Display richer outdated dependency information.

Recommended next

No recommendations yet.