Installation
#
Using a standalone script#
Node.js is not preinstalledOn POSIX systems, you may install pnpm even if you don't have Node.js installed, using the following script:
curl -fsSL https://get.pnpm.io/install.sh | sh -
If you don't have curl installed, you would like to use wget:
wget -qO- https://get.pnpm.io/install.sh | sh -
You may use the pnpm env command then to install Node.js.
#
Node.js is preinstalledOn Linux or macOS:
curl -f https://get.pnpm.io/v6.14.js | node - add --global pnpm
On Windows (PowerShell):
(Invoke-WebRequest 'https://get.pnpm.io/v6.14.js' -UseBasicParsing).Content | node - add --global pnpm
The standalone script is signed. Here's how to verify it.
#
Using npmnpm install -g pnpm
#
Via npx resolutionnpx pnpm add -g pnpm
#
UpgradingOnce you have installed pnpm, there is no need to use other package managers to update it. You can upgrade pnpm using itself, like so:
pnpm add -g pnpm
tip
Do you wanna use pnpm on CI servers? See: Continuous Integration.
#
CompatibilityHere is a list of past pnpm versions with respective Node.js version support.
Node.js | pnpm 1 | pnpm 2 | pnpm 3 | pnpm 4 | pnpm 5 | pnpm 6 |
---|---|---|---|---|---|---|
Node.js 4 | ✔️ | ❌ | ❌ | ❌ | ❌ | ❌ |
Node.js 6 | ✔️ | ✔️ | ❌ | ❌ | ❌ | ❌ |
Node.js 8 | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ❌ |
Node.js 10 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
Node.js 12 | ❌ | ❌ | ✔️ | ✔️ | ✔️ | ✔️ |
Node.js 14 | ❌ | ❌ | ✔️ | ✔️ | ✔️ | ✔️ |
Node.js 16 | ? | ? | ?️ | ?️ | ?️ | ✔️ |
#
TroubleshootingIf pnpm is broken and you cannot fix it by reinstalling, you might need to remove it manually from the PATH.
Let's assume you have the following error when running pnpm install
:
C:\src>pnpm installinternal/modules/cjs/loader.js:883 throw err; ^
Error: Cannot find module 'C:\Users\Bence\AppData\Roaming\npm\pnpm-global\4\node_modules\pnpm\bin\pnpm.js'←[90m at Function.Module._resolveFilename (internal/modules/cjs/loader.js:880:15)←[39m←[90m at Function.Module._load (internal/modules/cjs/loader.js:725:27)←[39m←[90m at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)←[39m←[90m at internal/main/run_main_module.js:17:47←[39m { code: ←[32m'MODULE_NOT_FOUND'←[39m, requireStack: []}
First, try to find the location of pnpm by running: which pnpm
. If you're on Windows, run this command in Git Bash.
You'll get the location of the pnpm command, for instance:
$ which pnpm/c/Program Files/nodejs/pnpm
Now that you know where the pnpm CLI is, open that directory and remove any pnpm-related files (pnpm.cmd
, pnpx.cmd
, pnpm
, etc).
Once done, install pnpm again and it should work as expected.
#
Uninstalling pnpmIf you need to remove the pnpm CLI from your system and any files it have written to your disk, see Uninstalling pnpm.