Use this file to discover all available pages before exploring further.
Pentest Swarm AI ships as a single statically-linked binary with no runtime dependencies of its own. The optional security tools it drives (nmap, subfinder, nuclei, and others) are separate installs — pentestswarm doctor reports which ones are present and which are missing with install hints, so you know exactly what to add before your first scan. Pick the install method that fits your workflow, then jump to the prerequisites section to wire up the tool chain.
The Homebrew tap is the recommended install path on macOS. It handles Intel vs. Apple Silicon selection automatically and keeps the binary up to date with brew upgrade.
brew install Armur-Ai/tap/pentestswarm
Verify:
pentestswarm --version
The Docker image bundles pentestswarm together with all 15 security tools pre-installed, making it the fastest path to a fully-equipped environment on any operating system.
To run a full local stack with Postgres, Redis, and Ollama side-by-side, use the provided Docker Compose file:
git clone https://github.com/Armur-Ai/Pentest-Swarm-AI.gitcd Pentest-Swarm-AI# Set your API key in the environment or in deploy/docker-compose.ymlexport PENTESTSWARM_ORCHESTRATOR_API_KEY=sk-ant-your-key-heredocker compose -f deploy/docker-compose.yml up
The Compose file brings up:
Service
Image
Port
pentestswarm
local build
8080
postgres (pgvector)
pgvector/pgvector:pg16
5432
redis
redis:7-alpine
6379
ollama
ollama/ollama:latest
11434
Installs the latest commit directly from main. Requires Go 1.24 or later.
go install github.com/Armur-Ai/Pentest-Swarm-AI/cmd/pentestswarm@latest
go install places the binary in $(go env GOPATH)/bin (typically ~/go/bin). Make sure that directory is on your PATH:
export PATH="$PATH:$(go env GOPATH)/bin"
Add that line to your ~/.bashrc, ~/.zshrc, or equivalent shell profile to make it permanent.
Verify:
pentestswarm --version
Building from source is the recommended path for contributors or anyone who wants to modify the tool.Prerequisites: Go 1.24+, Docker (for the dev services), Git.
git clone https://github.com/Armur-Ai/Pentest-Swarm-AI.gitcd Pentest-Swarm-AI# Install Go dev tools, start Postgres/Redis/Ollama, build the binary./scripts/setup.sh# Or just build the binary without starting services:make build
The compiled binary is written to ./bin/pentestswarm. Common make targets:
Target
Description
make build
Compile binary to ./bin/pentestswarm
make test
Run unit tests with race detector
make dev
Build binary then start the full local development stack (Postgres, Redis, Ollama via Docker Compose)
make lint
Run golangci-lint
make snapshot
GoReleaser dry-run — builds for all platforms locally
pentestswarm orchestrates a suite of best-in-class open-source security tools. None are strictly required to start — the tool degrades gracefully when one is absent — but having the full suite installed gives the swarm its full attack surface coverage.
Tool
Purpose
Install
nmap
Network port and service scanning
brew install nmap / apt install nmap
subfinder
Passive subdomain discovery
go install github.com/projectdiscovery/subfinder/v2/cmd/subfinder@latest
httpx
Fast HTTP probing and fingerprinting
go install github.com/projectdiscovery/httpx/cmd/httpx@latest
nuclei
Template-based vulnerability scanning
go install github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
naabu
Fast port scanner
go install github.com/projectdiscovery/naabu/v2/cmd/naabu@latest
katana
JavaScript-aware web crawler
go install github.com/projectdiscovery/katana/cmd/katana@latest
dnsx
Fast DNS resolver and brute-forcer
go install github.com/projectdiscovery/dnsx/cmd/dnsx@latest
gau
Fetch known URLs from AlienVault OTX, Wayback, and Common Crawl
go install github.com/lc/gau/v2/cmd/gau@latest
Run pentestswarm doctor after install for an 8-point health check. It reports which tools are present with a ✓ and which are missing with an install hint, so you know exactly what needs to be added before your first scan.
Now that pentestswarm is installed, run pentestswarm init to store your API key and write a starter config, then follow the Quickstart to launch your first scan.
Quickstart
Install, configure, and run your first autonomous pentest scan in under five minutes.
