mirror of
https://github.com/pnpm/pnpm.git
synced 2026-06-28 01:45:30 -04:00
f06ab5e201
Reduce the cost of a pnpr install-accelerator install against a remote
server, where latency — not bandwidth — dominates.
The cold path was three sequential round trips: a GET /-/pnpr handshake,
a POST /v1/install that returned the lockfile + missing-file digests as
NDJSON, and a POST /v1/files that fetched the file contents. At 100ms RTT
most of an install is spent waiting on trips, not transferring data.
- A new `inlineFiles` request flag makes POST /v1/install return a single
gzipped body: a length-prefixed JSON header (lockfile, stats,
store-index entries, or verification violations) followed by the
missing files' contents as the same binary frames /v1/files serves.
The pacquet client drops the handshake, sends the flag, and writes the
inlined files straight to its CAFS — no follow-up fetch. The legacy
NDJSON + /v1/files path is unchanged for clients that don't set it.
- File-bearing responses now compress at gzip level 6 (was level 1),
~16% smaller payload at negligible CPU.
Measured at 50ms one-way latency (warm server, 5-run average): a
single-round-trip install drops from ~381ms to ~135ms (≈2.8x).
Two further experiments from the issue were evaluated and not adopted:
server-side fetch/transfer streaming (the public npm registry is
CDN-backed and latency-bound, not bandwidth-throttled, so there is
nothing to overlap — it measured slower under an artificial bandwidth
cap) and bloom-filter integrity uploads (real but niche, and false
positives would require a correctness-critical re-fetch fallback).
Closes #12165
简体中文 | 日本語 | 한국어 | Italiano | Português Brasileiro
Fast, disk space efficient package manager:
- Fast. Up to 2x faster than the alternatives (see benchmark).
- Efficient. Files inside
node_modulesare 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.
Platinum Sponsors
|
Gold Sponsors
|
|
|
|
|
|
|
|
Silver Sponsors
|
|
|
|
|
|
|
⏱️ Time.now |
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:
- 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 updatewill only add 1 new file to the storage. - 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, except the pnpr/ directory, which is source-available under the PolyForm Shield License 1.0.0.