▮ AEGIS
— docs

Installation

Detailed install paths for Arch, Kali, Docker, and from source.

AEGIS itself is a Python package; the TUI is a Node bundle. Pick the path that matches your host.

Pip (any Linux/macOS)

pip install aegis-pentest

This installs aegis on your PATH. The TUI bundle is fetched from npm as a peer (@aegis/tui) or, if you want to build from source:

cd tui && npm install && npm run build

Arch (AUR)

yay -S aegis-pentest
# or paru -S aegis-pentest

Pulls the source tarball from GitHub, builds the wheel via python-build, and drops aegis under /usr/bin. Optdepends cover the full tool surface — nmap, nuclei, subfinder, ffuf, kerbrute, impacket, scoutsuite, kube-bench, and the rest — install only what you need.

From source

git clone https://github.com/glorybnat/aegis-pentest.git
cd aegis-pentest
pip install -e .
cd tui && npm install && npm run build

Editable install (-e) lets you hack on the orchestrator and pick up changes without re-installing.

Docker (fully self-contained)

The Docker image bundles AEGIS, the Node TUI, and the full 80+ tool toolchain — nothing else needed on the host.

# Build (15–30 min on first build; layers are cached)
aegis docker build

# Run an engagement inside the container
aegis docker run engagements/2026-acme

# Or drop into an interactive shell
aegis docker shell

See Dockerfile for the exact toolchain.

Tool prerequisites

AEGIS will use any of these it finds; missing ones are skipped:

  • Network: nmap, masscan, naabu, dnsx, dnstwist, dnsrecon
  • Recon: subfinder, amass, assetfinder, findomain, gau, hakrawler, gospider, katana
  • HTTP: httpx, ffuf, gobuster, feroxbuster, wfuzz, whatweb, wafw00f, sslscan, sslyze
  • Vuln: nuclei, nikto, sqlmap, dalfox, xsstrike, sstimap, crlfuzz, smuggler, h2csmuggler
  • CMS: wpscan, joomscan, droopescan, cmseek
  • Secrets: trufflehog, gitleaks, secretfinder
  • Cloud / containers: trivy, grype, syft, s3scanner, cloudfox, kiterunner
  • Code: semgrep, retire.js
  • Misc: hydra, jwt_tool, graphql-cop, linkfinder, smbmap, theharvester, bbot

Install on Arch / Manjaro with BlackArch enabled:

aegis env install --missing

This walks the catalog and installs everything via pacman, yay, go install, pipx, or npm as appropriate.

Verify your install

aegis --version       # → aegis 0.10.0
aegis env show        # host + tool inventory
aegis env tools       # detailed tool table
aegis docker status   # docker image status (if you built it)

If aegis env show reports fewer than 30 tools, you’re going to leave findings on the table — install more, or use the Docker image.