External/pmg
1
0
Fork 0
mirror of https://github.com/safedep/pmg.git synced 2026-08-03 07:24:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README

Browse Source
This commit is contained in:
abhisek
2025-05-15 15:00:14 +05:30
parent e723f4fb29
commit 7eb4fac99f
1 changed files with 24 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24 -13
View File
@@ -1,10 +1,15 @@
# PMG (Package Manager Guard) # Package Manager Guard (PMG)
PMG is a wrapper for package managers to protect developers from installing malicious packages. 🤖 PMG protects developers from getting compromised by malicious packages.
See [example](https://safedep.io/malicious-npm-package-express-cookie-parser/)
- Wraps your favorite package manager (eg. `npm`)
- Blocks malicious packages at install time
- No configuration required, just install and use
## TL;DR ## TL;DR
Set up `pmg` to protect you development environment: Set up `pmg` to protect you development environment from malicious packages:
``` ```
echo "alias npm='pmg npm'" >> ~/.zshrc echo "alias npm='pmg npm'" >> ~/.zshrc
@@ -20,11 +25,11 @@ pnpm add <package-name>
``` ```
## 📑 Table of Contents ## 📑 Table of Contents
- [PMG (Package Manager Guard)](#pmg-package-manager-guard) - [Package Manager Guard (PMG)](#package-manager-guard-pmg)
- [TL;DR](#tldr) - [TL;DR](#tldr)
- [📑 Table of Contents](#-table-of-contents) - [📑 Table of Contents](#-table-of-contents)
- [Features](#features) - [Features](#features)
- [Supported Ecosystems](#supported-ecosystems) - [Supported Package Managers](#supported-package-managers)
- [Installation](#installation) - [Installation](#installation)
- [Binaries](#binaries) - [Binaries](#binaries)
- [Build from Source](#build-from-source) - [Build from Source](#build-from-source)
@@ -45,16 +50,18 @@ pnpm add <package-name>
- ⚡ Fast and efficient package verification - ⚡ Fast and efficient package verification
- 🔄 Seamless integration with existing package managers - 🔄 Seamless integration with existing package managers
## Supported Ecosystems ## Supported Package Managers
PMG supports the following package ecosystems: PMG supports the following package managers:
| Ecosystem | Status | Command | | Package Manager | Status | Command |
| --------- | --------- | --------------------------- | | --------------- | --------- | --------------------------- |
| NPM | ✅ Active | `pmg npm install <package>` | | `npm` | ✅ Active | `pmg npm install <package>` |
| PNPM | ✅ Active | `pmg pnpm add <package>` | | `pnpm` | ✅ Active | `pmg pnpm add <package>` |
| PyPI | 🚧 Planned | | | `yarn` | 🚧 Planned | |
| Go | 🚧 Planned | | | `pip` | 🚧 Planned | |
| `poetry` | 🚧 Planned | |
| `uv` | 🚧 Planned | |
> Want us to support your favorite package manager? [Open an issue](https://github.com/safedep/pmg/issues) and let us know! > Want us to support your favorite package manager? [Open an issue](https://github.com/safedep/pmg/issues) and let us know!
@@ -122,7 +129,11 @@ Use the `--debug` flag to enable debug mode:
pmg --debug npm install <package-name> pmg --debug npm install <package-name>
``` ```
Store the debug logs in a file:
```bash
pmg --debug --log /tmp/debug.json npm install <package-name>
```
### PMG in Action ### PMG in Action