Skip to content

docs: add tip about excluding pnpm in Microsoft Defender #684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add tip about excluding pnpm in Microsoft Defender #684

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e30654
docs: add tip about excluding pnpm in Microsoft Defender
cyyynthia Jun 30, 2025
bd3be09
docs: move msft defender note
cyyynthia Jul 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Using PowerShell:
Invoke-WebRequest https://get.pnpm.io/install.ps1 -UseBasicParsing | Invoke-Expression
```

::: tip

On Windows, Microsoft Defender can significantly slow down installation of packages. After installing pnpm, you can
[add the pnpm store to Microsoft Defender's list of excluded folders](#windows-performance) to get a significant speedup.

:::

### On POSIX systems

```sh
Expand Down Expand Up @@ -207,6 +214,15 @@ $ which 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.

### Windows performance

On Windows, Microsoft Defender can significantly slow down installation of packages. You can add pnpm to Microsoft Defender's list
of excluded folders in a PowerShell window with administrator rights by executing:

```powershell
Add-MpPreference -ExclusionPath $(pnpm store path)
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just put this to the windows section as regular paragraph.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough. I was unsure, since excluding pnpm from Microsoft Defender concerns all install methods and the Windows section is specific to installation via a pwsh command but I guess it's also quite visible as it's the first thing people see.


## Using a shorter alias

`pnpm` might be hard to type, so you may use a shorter alias like `pn` instead.
Expand Down