— docs

Quickstart

pip install to first finding in 5 minutes.

From a fresh checkout to a real engagement with findings in the report. Five steps. No prose, just the minimum you need to know what to type and what to expect back.

Python

≥ 3.12

Node

≥ 20

LLM

Anthropic key or Claude Code

Auth target

Required

Install

The Python core ships from PyPI. The interactive TUI is a separate Node bundle — build it once.

install core bash

pip install aegis-pentest

build the TUI bash

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

Profile the host

Tell AEGIS what tools your machine has. Result is cached to ~/.config/aegis/env-profile.json. Re-run any time you install new tools.

bash bash

aegis init

→ Profiles CPU, memory, OS, & 80+ pentest tools.

Create an engagement

Scaffolds engagements/<id>-acme/ with a scope.yaml that pins exactly what AEGIS may touch.

bash bash

aegis engagement new \
  --client "Acme Corp" \
  --scope www.acme.com,acme.com,api.acme.com \
  --budget-usd 5.00

Run

The TUI takes over. AEGIS walks the seven PTES phases. Watch the activity feed for tools running; the right pane for what Claude is reasoning about.

bash bash

aegis run engagements/2026-acme

toggle output expansion Ctrl+O

alt for toggle outputs Tab

quit immediately Ctrl+C

send guidance to the agent Enter

wrap up after current phase /stop

prioritise a target /focus <target>

loop past REPORTING /hunt on

exit now /quit

Read the report

Generates report.html + report.md + report.json from verified findings only.

bash bash

aegis report engagements/2026-acme

walkthrough

Your first engagement

Run AEGIS against a deliberately vulnerable target with guidance.

Continue →

reference

CLI reference

Every aegis command, every flag, every behaviour.

Continue →

develop

Architecture

What the orchestrator actually does under the hood.

Continue →