Skip to content
πŸ“¦πŸš€ Fast, disk space efficient package manager
TypeScript Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: add funding config file Jan 28, 2020
docs docs: reference docs from pnpm.js.org website Apr 7, 2018
fixtures feat(outdated): don't fail when no lockfile & no deps Feb 12, 2020
packages chore(release): 4.11.0 Feb 29, 2020
privatePackages chore(deps): update Feb 29, 2020
tools fix(deps): update Feb 13, 2020
typings fix: replace tabtab with @pnpm/tabtab Jan 29, 2020
utils style: add missing trailing commas and fix the linting rule Jan 1, 2020
.editorconfig feat: initial commit Mar 18, 2018
.gitattributes feat: initial commit Mar 18, 2018
.gitignore revert: "test: update @pnpm/registry-mock" Nov 21, 2019
.npmrc chore: set hoist to false Sep 9, 2019
.travis.yml ci: only test changed pkgs on non-master Dec 18, 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 Jan 1, 2020
README.md docs(README): remove README duplication Feb 27, 2020
appveyor.yml ci: only test changed pkgs on non-master Dec 18, 2019
lint-commits.sh chore: move commitlint to tools/ May 12, 2018
package.json chore(deps): update dependency verdaccio to v4.4.4 Feb 28, 2020
pnpm-lock.yaml chore(release): 4.11.0 Feb 29, 2020
pnpm-workspace.yaml refactor: create @pnpm/plugin-commands-rebuild Dec 22, 2019
pnpmfile.js feat: pnpm list --json Aug 2, 2019
renovate.json chore(renovate): only allow v6.0.1 of ssri Feb 21, 2020
tslint.json style: start the linting process only once during testing Jan 1, 2020
verdaccio.yaml feat: audit Nov 14, 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 monorepos.
  • 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.

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

On Windows (PowerShell):

(Invoke-WebRequest 'https://unpkg.com/@pnpm/self-installer').Content | node

Via npm:

npm add -g pnpm

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

pnpm add -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

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.