Skip to content
πŸ“¦πŸš€ Fast, disk space efficient package manager
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: add CODEOWNERS file Jul 7, 2017
docs docs: reference docs from pnpm.js.org website Apr 7, 2018
packages fix(deps): update @zkochan/npm-lifecycle to v3.1.2 Jul 17, 2019
privatePackages chore(npmrc): use-beta-cli=true Jul 16, 2019
tools chore(deps): update dependency husky to v3 Jul 6, 2019
typings test: replace pnpm-registry-mock with @pnpm/registry-mock Jun 2, 2019
utils chore(deps): install ts-node, tslint, typescript as root deps Jun 11, 2019
.editorconfig feat: initial commit Mar 18, 2018
.gitattributes feat: initial commit Mar 18, 2018
.gitignore fix(outdated): pnpm outdated when only a dev dep is out-of-date Oct 30, 2018
.npmrc chore(npmrc): use-beta-cli=true Jul 16, 2019
.travis.yml chore: use package.yaml in root of the workspace May 6, 2019
CODE_OF_CONDUCT.md docs: add CODE_OF_CONDUCT.md Jun 24, 2017
CONTRIBUTING.md docs: update CONTRIBUTING.md Jun 23, 2019
LICENSE docs(license): update years Dec 31, 2018
README.md feat: rename configs from shrinkwrap to lockfile Mar 4, 2019
appveyor.yml revert: "ci(appveyor): test on Node.js 10 only" May 7, 2019
lint-commits.sh chore: move commitlint to tools/ May 12, 2018
package.yaml fix(deps): update p-queue, stacktracey Jul 11, 2019
pnpm-lock.yaml fix(deps): update @zkochan/npm-lifecycle to v3.1.2 Jul 17, 2019
pnpm-workspace.yaml fix(deps): update find-up to v4.1.0 Jun 20, 2019
pnpmfile.js chore(deps): update @types/semver Jun 22, 2019
renovate.json test: replace pnpm-registry-mock with @pnpm/registry-mock Jun 2, 2019

README.md

pnpm

Fast, disk space efficient package manager

npm version Status Windows build status Join the chat at https://gitter.im/pnpm/pnpm OpenCollective OpenCollective Twitter Follow

Features:

  • Fast. As fast as npm and Yarn.
  • Efficient. One version of a package is saved only ever once on a disk.
  • Great for multi-package repositories (a.k.a. monorepos). See the recursive commands.
  • Strict. A package can access only dependencies that are specified in its package.json.
  • Deterministic. Has a lockfile called pnpm-lock.yaml.
  • Works everywhere. Works on Windows, Linux and OS X.
  • Aliases. Install different versions of the same package or import it using a different name.

Like this project? Let people know with a tweet.

Table of Contents

Background

pnpm uses hard links and symlinks to save one version of a module only ever once on a disk. When using npm or Yarn for example, if you have 100 projects using the same version of lodash, you will have 100 copies of lodash on disk. With pnpm, lodash will be saved in a single place on the disk and a hard link will put it into the node_modules where it should be installed.

As a result, you save gigabytes of space on your disk and you have a lot faster installations! If you'd like more details about the unique node_modules structure that pnpm creates and why it works fine with the Node.js ecosystem, read this small article: Flat node_modules is not the only way.

Install

Using a standalone script:

curl -L https://unpkg.com/@pnpm/self-installer | node

Via npm:

npm install -g pnpm

Once you first installed pnpm, you can upgrade it using pnpm:

pnpm install -g pnpm

Do you wanna use pnpm on CI servers? See: Continuous Integration.

Usage

pnpm CLI

Just use pnpm in place of npm. For instance, to install run:

pnpm install lodash

For more advanced usage, read pnpm CLI on our website.

For using the programmatic API, use pnpm's engine: supi.

pnpx CLI

npm has a great package runner called npx. pnpm offers the same tool via the pnpx command. The only difference is that pnpx uses pnpm for installing packages.

The following command installs a temporary create-react-app and calls it, without polluting global installs or requiring more than one step!

pnpx create-react-app my-cool-new-app

Benchmark

pnpm is as fast as npm and Yarn. See all benchmarks here.

Benchmarks on a React app:

Support

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

MIT

You can’t perform that action at this time.