Back to Pnpm

README

README.md

11.0.610.9 KB
Original Source

简体中文 | 日本語 | 한국어 | Italiano | Português Brasileiro

<picture> <source media="(prefers-color-scheme: light)" srcset="https://i.imgur.com/qlW1eEG.png"> <source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/qlW1eEG.png"> </picture>

Fast, disk space efficient package manager:

  • Fast. Up to 2x faster than the alternatives (see benchmark).
  • Efficient. Files inside node_modules are linked from a single content-addressable storage.
  • 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 as a Node.js version manager. See pnpm runtime.
  • Works everywhere. Supports Windows, Linux, and macOS.
  • Battle-tested. Used in production by teams of all sizes since 2016.
  • See the full feature comparison with npm and Yarn.

To quote the Rush team:

Microsoft uses pnpm in Rush repos with hundreds of projects and hundreds of PRs per day, and we’ve found it to be very fast and reliable.

<!-- sponsors -->

Platinum Sponsors

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://bit.cloud/?utm_source=pnpm&utm_medium=readme" target="_blank"></a> </td> </tr> </tbody> </table>

Gold Sponsors

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://sanity.io/?utm_source=pnpm&utm_medium=readme" target="_blank"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/sanity.svg" /> <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/sanity_light.svg" />
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://discord.com/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/discord.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/discord_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://vite.dev/?utm_source=pnpm&utm_medium=readme" target="_blank"></a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://serpapi.com/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/serpapi_dark.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/serpapi_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://coderabbit.ai/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/coderabbit.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/coderabbit_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://stackblitz.com/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/stackblitz.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/stackblitz_light.svg" />
        
      </picture>
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://workleap.com/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/workleap.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/workleap_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://nx.dev/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/nx.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/nx_light.svg" />
        
      </picture>
    </a>
  </td>
</tr>
</tbody> </table>

Silver Sponsors

<table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://replit.com/?utm_source=pnpm&utm_medium=readme" target="_blank"> <picture> <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/replit.png" /> <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/replit_light.png" />
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://cybozu.co.jp/?utm_source=pnpm&utm_medium=readme" target="_blank"></a>
  </td>
  <td align="center" valign="middle">
    <a href="https://devowl.io/?utm_source=pnpm&utm_medium=readme" target="_blank"></a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://uscreen.de/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/uscreen.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/uscreen_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://www.leniolabs.com/?utm_source=pnpm&utm_medium=readme" target="_blank"></a>
  </td>
  <td align="center" valign="middle">
    <a href="https://depot.dev/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/depot.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/depot_light.svg" />
        
      </picture>
    </a>
  </td>
</tr>
<tr>
  <td align="center" valign="middle">
    <a href="https://cerbos.dev/?utm_source=pnpm&utm_medium=readme" target="_blank">
      <picture>
        <source media="(prefers-color-scheme: light)" srcset="https://pnpm.io/img/users/cerbos.svg" />
        <source media="(prefers-color-scheme: dark)" srcset="https://pnpm.io/img/users/cerbos_light.svg" />
        
      </picture>
    </a>
  </td>
  <td align="center" valign="middle">
    <a href="https://time.now/?utm_source=pnpm&utm_medium=readme" target="_blank">⏱️ Time.now</a>
  </td>
</tr>
</tbody> </table> <!-- sponsors end -->

Support this project by becoming a sponsor.

Background

pnpm uses a content-addressable filesystem to store all files from all module directories on a disk. When using npm, if you have 100 projects using lodash, you will have 100 copies of lodash on disk. With pnpm, lodash will be stored in a content-addressable storage, so:

  1. If you depend on different versions of lodash, only the files that differ are added to the store. If lodash has 100 files, and a new version has a change only in one of those files, pnpm update will only add 1 new file to the storage.
  2. All the files are saved in a single place on the disk. When packages are installed, their files are linked from that single place consuming no additional disk space. Linking is performed using either hard-links or reflinks (copy-on-write).

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.

💖 Like this project? Let people know with a tweet

Getting Started

Benchmark

pnpm is up to 2x faster than npm and Yarn classic. See all benchmarks here.

Benchmarks on an app with lots of dependencies:

License

MIT