System Requirements
| Item | Minimum |
|---|
| OS | macOS 12+, Ubuntu 20.04+, Windows 10+ |
| Node.js | >= 20.0.0 |
| Disk | 200 MB |
| Memory | 512 MB (1 GB recommended for Guard) |
| Feature | macOS | Linux | Windows |
|---|
| Scan | Full (lsof, socketfilterfw) | Full (ss, ufw/iptables) | Partial (netstat, no firewall) |
| Guard | Poll monitoring (5s) | Poll monitoring (5s) | Poll monitoring (5s) |
| Trap | TCP honeypots | TCP honeypots | TCP honeypots |
| Chat | Telegram / Slack / Email | Telegram / Slack / Email | Telegram / Slack / Email |
| Report | Full (3 frameworks) | Full (3 frameworks) | Full (3 frameworks) |
Windows supports core features, but some OS-level detection capabilities are limited compared to macOS and Linux.
Available Binaries (v0.3.1)
| Platform | Architecture | Install Method |
|---|
| macOS | ARM64 (Apple Silicon) | curl one-liner or npm |
| Linux | x64 | curl one-liner or npm |
| Linux | ARM64 | curl one-liner or npm |
| Windows | x64 | npm (recommended) or PowerShell |
Install Methods
One-command install (recommended)
curl -fsSL https://get.panguard.ai | bash
Intel Mac users: The curl installer downloads the ARM64 binary by default. You have two options:
- Install via npm instead:
npm install -g @panguard-ai/panguard
- Enable Rosetta 2 first:
softwareupdate --install-rosetta
Using npm
npm install -g @panguard-ai/panguard
Using Homebrew (coming soon)
brew install panguard-ai/tap/panguard
One-command install (recommended)
curl -fsSL https://get.panguard.ai | bash
Using npm
npm install -g @panguard-ai/panguard
System package (coming soon)
# Debian / Ubuntu
sudo apt install panguard
# RHEL / Fedora
sudo dnf install panguard
Using npm (recommended)
npm install -g @panguard-ai/panguard
PowerShell one-liner
powershell -ExecutionPolicy Bypass -Command "irm https://get.panguard.ai/windows | iex"
npm is the recommended install method on Windows. The PowerShell installer requires administrator privileges.
Install from Source
For contributors or users who want the latest development build:
git clone https://github.com/panguard-ai/panguard-ai.git
cd panguard-ai
pnpm install
pnpm build
# Run the CLI
./bin/panguard --help
Building from source requires pnpm 10+ and Node.js 20+. Verify Installation
After installing, confirm that the CLI is available:
Expected output:
If the command is not found, ensure the install location is on your system PATH. For npm global installs, verify with:
npm list -g @panguard-ai/panguard
Uninstall
npm
curl install
Source build
npm uninstall -g @panguard-ai/panguard
Simply delete the cloned repository directory.
Next step
Once installed, proceed to Account Setup to create your account and authenticate the CLI.
