Files
pmg/publish/npm/README.md
T

67 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2026-04-23 18:35:03 +05:30
<div align="center">
<img src="https://raw.githubusercontent.com/safedep/pmg/main/docs/assets/pmg-banner.png" alt="PMG banner">
</div>
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
# Package Manager Guard (PMG)
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
PMG intercepts package installs and checks them for malware before code executes. Install it once, and your usual package manager workflows can stay the same.
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
This package is the npm distribution of PMG. The main project README at [`github.com/safedep/pmg`](https://github.com/safedep/pmg) is the source of truth for full documentation.
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
## Why PMG?
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
- Protects developers and AI coding agents from malicious packages
- Wraps tools like `npm`, `pnpm`, `yarn`, `pip`, `poetry`, and `uv`
- Adds sandboxing and install-time security checks with minimal workflow changes
## Install
2025-07-04 12:42:37 +05:30
```bash
npm install -g @safedep/pmg
```
2026-04-23 18:35:03 +05:30
You can also install PMG with Homebrew:
2025-07-04 12:42:37 +05:30
```bash
brew install safedep/tap/pmg
```
2026-04-23 18:35:03 +05:30
## Quick Start
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
Set up PMG so your normal package manager commands are protected automatically:
2025-07-04 12:42:37 +05:30
```bash
pmg setup install
```
2026-04-23 18:35:03 +05:30
After setup, restart your terminal and keep using your tools as usual:
2025-07-04 12:42:37 +05:30
```bash
npm install express
pnpm add react
pip install requests
```
2026-04-23 18:35:03 +05:30
If you prefer, you can also run package manager commands through PMG directly:
2025-07-04 12:42:37 +05:30
```bash
pmg npm install express
pmg pnpm add react
pmg pip install requests
```
## Platform Support
2026-04-23 18:35:03 +05:30
- macOS
- Linux
- Windows
2025-07-04 12:42:37 +05:30
Requires Node.js 14 or higher.
2026-04-23 18:35:03 +05:30
## Learn More
2025-07-04 12:42:37 +05:30
2026-04-23 18:35:03 +05:30
For complete documentation, installation options, troubleshooting, and project updates, see:
- [Main README](https://github.com/safedep/pmg)
- [Quickstart Docs](https://docs.safedep.io/pmg/quickstart)