Skip to main content

​
Installation

The PromptGuard CLI is distributed as a single static binary with zero runtime dependencies. 
curl -fsSL https://raw.githubusercontent.com/acebot712/promptguard-cli/main/install.sh | sh
The install script will:
  • Auto-detect your OS and architecture
  • Download the appropriate binary from GitHub releases
  • Verify SHA256 checksum
  • Install to /usr/local/bin/promptguard
  • Test the installation
The installer requires curl and may prompt for sudo permission to install to /usr/local/bin.

​
Manual Installation

​
1. Download Binary

Visit the GitHub Releases page and download the binary for your platform:
PlatformBinarySize
macOS Apple Silicon (M1/M2/M3)promptguard-macos-arm645.3MB
macOS Intelpromptguard-macos-x86_645.3MB
Linux 64-bitpromptguard-linux-x86_645.3MB
Linux ARM64promptguard-linux-arm645.3MB
# Download checksum file
curl -fsSL https://github.com/acebot712/promptguard-cli/releases/latest/download/promptguard-macos-arm64.sha256 -o promptguard.sha256

# Verify (macOS)
shasum -a 256 -c promptguard.sha256

# Verify (Linux)
sha256sum -c promptguard.sha256

​
3. Install

# Make executable
chmod +x promptguard-*

# Move to PATH
sudo mv promptguard-* /usr/local/bin/promptguard

# Verify installation
promptguard --version

​
Package Managers (Coming Soon)

​
Homebrew (macOS)

brew install promptguard/tap/promptguard
Homebrew formula coming in Week 2 after initial release.

​
Cargo (Rust)

cargo install promptguard-cli
Cargo package coming in Week 2 after initial release.

​
npm (JavaScript Ecosystem)

npm install -g promptguard
npm wrapper coming in Week 3 after initial release.

​
Verify Installation

After installation, verify everything works: 
# Check version
promptguard --version
# Output: promptguard 2.0.0

# View help
promptguard --help

# Test in a project
cd /path/to/your/project
promptguard scan

​
System Requirements

  • Operating System: macOS 10.15+ or Linux (glibc 2.27+)
  • Architecture: x86_64 (64-bit) or ARM64
  • Disk Space: 10MB (binary + config files)
  • Network: Internet connection for initial download and API calls

​
Supported Platforms

  • macOS 10.15 (Catalina) or later
  • ARM64 (M1/M2/M3) - Native Apple Silicon support
  • x86_64 (Intel) - Full support
  • glibc 2.27+ (Ubuntu 18.04+, Debian 10+, CentOS 8+)
  • x86_64 (64-bit Intel/AMD)
  • ARM64 (aarch64)
  • Tested on: Ubuntu 20.04/22.04, Debian 11/12, CentOS 8/9, Fedora 36+
Windows is not currently supported. Consider using WSL2 (Windows Subsystem for Linux) if you’re on Windows.

​
Update

To update to the latest version: 
# Re-run install script
curl -fsSL https://raw.githubusercontent.com/acebot712/promptguard-cli/main/install.sh | sh

# Or check for updates
promptguard update

​
Uninstall

To remove the CLI: 
# Remove binary
sudo rm /usr/local/bin/promptguard

# Remove config files in your projects (optional)
cd /path/to/project
promptguard revert -y  # This restores original files

​
Troubleshooting

The installer needs sudo to write to /usr/local/bin. Either:
  • Run with sudo: curl ... | sudo sh
  • Or install to user directory: mkdir -p ~/bin && mv promptguard ~/bin/
/usr/local/bin might not be in your PATH. Add it:
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
You downloaded the wrong architecture. Check your system:
uname -sm
# macOS arm64 -> Use promptguard-macos-arm64
# macOS x86_64 -> Use promptguard-macos-x86_64
# Linux x86_64 -> Use promptguard-linux-x86_64
# Linux aarch64 -> Use promptguard-linux-arm64
Install CA certificates:
# Ubuntu/Debian
sudo apt-get install ca-certificates

# CentOS/Fedora
sudo yum install ca-certificates

​
Next Steps

Quick Start

Initialize PromptGuard in 60 seconds

Commands

Learn all available commands