Documentation
Docs, from the repo itself
One source of truth: this section is generated at build time from the repository Markdown — never a duplicate. Pick a guide or search the whole set.
159 guides · 8 sections · synced at build time
Getting Started (4)
- Deployment
deployment
- Getting Started
getting-started
- Hands-On Tutorial
tutorial
- Troubleshooting
troubleshooting
Core Concepts (6)
- Architecture
architecture
- Database & Mission Persistence
database-mission
- Disposable Execution Sandbox
sandbox
- Outcome Judgment and Evidence Handling
outcome-evidence
- Runtime Flows
runtime-flows
- Safety Model
safety-model
Agent (6)
- AI Prompts — Where They Live & How to Improve Them
prompts
- Building & Improving Runtime Skills
skill-authoring
- Exploit Agent — Prompts (`prompt.py` + `skills.py` + `research_assistant.py` + `reflection.py`)
components/tools/exploit-agent/prompts
- Exploit Agent (Flow A)
exploit-agent
- Runtime Skills
skills
- Swarm Subsystem
swarm
Tooling (5)
- Attack Modules
attack-modules
- Browser-Native Web Agent — Architecture & Integration Design
browser-agent-design
- MCP Tool Layer
mcp-tools
- MCP Wiring
mcp-wiring
- Tool Family: attack-modules
mcp/tool-families/attack-modules
Platform (4)
- BreachPilot WebUI API — v1 Reference
api
- CLI Reference
cli-reference
- Config Reference (`config.yaml`)
config-reference
- WebUI
webui
Extensibility (4)
- Extension Guide
extension-guide
- Model Providers
providers
- Plugin Development Guide
plugin-development
- Provider Development Guide
provider-development
Engineering (7)
- Benchmarks
benchmarks
- Benchmarks (`/benchmarks`, `/benchmarks/new`, `/benchmarks/history`, `/benchmarks/:runId`)
webui/pages/benchmarks
- Benchmarks Endpoints
api/endpoints/benchmarks
- Evaluation & Benchmarking Guide
evaluation
- Glossary
glossary
- Module Guide
module-guide
- Testing Guide
testing-guide
Reference (123)
- Agent Loop
components/flow-b/agent-loop
- API Integration
webui/api-integration
- App
components/root/app
- Attack Modules — Overview
components/tools/attack-modules/overview
- Attack Modules — Registry (`registry.py`)
components/tools/attack-modules/registry
- Auth
api/auth
- Benchmark — Overview (`tools/benchmark/`)
components/tools/benchmark/overview
- BreachPilot — Autonomous Security Testing
readme
- Browser — Overview (`tools/browser/`)
components/tools/browser/overview
- Build System
webui/build
- Campaign — Overview (`tools/campaign/`)
components/tools/campaign/overview
- Campaign Orchestrator
campaign
- Capability Upgrade — Architecture Design (Phase 2 output)
capability-upgrade-design
- Cli
components/root/cli
- CLI Reference (Generated)
reference/cli-generated
- Config — Overview (`tools/config/`)
components/tools/config/overview
- Config Reference (Generated)
configuration/config-reference-generated
- Config Validation
configuration/validation
- Configuration Overview
configuration/overview
- Connections (`/connections`)
webui/pages/connections
- Connections Endpoints
api/endpoints/connections
- Credential Vault
credential-vault
- Db Mission
components/flow-b/db-mission
- Decisions Endpoints
api/endpoints/decisions
- Defensive MCP Server
mcp/servers/defensive
- Docs
README
- Endpoint Matrix
api/endpoint-matrix
- Engine MCP Server
mcp/servers/engine
- Entrypoints
entrypoints
- Environment Variables
configuration/environment
- Event & Decision Brokers
api/event-broker
- Events Endpoints
api/endpoints/events
- Evidence Memory Graph
components/flow-b/evidence-memory-graph
- Executor Router
components/flow-b/executor-router
- Exploit Agent — Context (`context.py`)
components/tools/exploit-agent/context
- Exploit Agent — Loop (`tools/exploit_agent/runner/_impl.py`)
components/tools/exploit-agent/loop
- Exploit Agent — Overview
components/tools/exploit-agent/overview
- Exploit Agent — Policy (`policy.py`)
components/tools/exploit-agent/policy
- Exploit Agent — Runner (`tools/exploit_agent/runner/`)
components/tools/exploit-agent/runner
- Exploit MCP Server
mcp/servers/exploit
- Exploit Policy
exploit-policy
- Graph Components
webui/components/graph
- Graph Endpoints
api/endpoints/graph
- Graph Explorer Endpoints
api/endpoints/graph-explorer
- Graph Pages
webui/pages/graph
- Home Page (`/`)
webui/pages/home
- Intelligence — Overview (`tools/intelligence/`)
components/tools/intelligence/overview
- Kernel — Gates (`tools/kernel/`)
components/tools/kernel/gates
- Kernel — Overview (`tools/kernel/`)
components/tools/kernel/overview
- Killchain — Overview (`tools/killchain/`)
components/tools/killchain/overview
- List Pages
webui/pages/lists
- Main
components/root/main
- MCP Lifecycle
mcp/lifecycle
- MCP Registration
mcp/registration
- MCP Security
mcp/security
- MCP Subsystem Overview
mcp/overview
- MCP Tool Catalog (Generated)
mcp/tool-catalog-generated
- Models
api/models
- New Run Wizard (`/runs/new`)
webui/pages/wizard
- Observer Outcome
components/flow-b/observer-outcome
- Operations (`/ops`)
webui/pages/ops
- Operator Connection — Overview (`tools/operator_connection/`)
components/tools/operator-connection/overview
- Ops Endpoints
api/endpoints/ops
- Other Pages
webui/pages/other
- Persistence
api/persistence
- Planner Queue
components/flow-b/planner-queue
- Providers — Overview (`tools/providers/`)
components/tools/providers/overview
- Realtime events — WebSocket primary, SSE fallback
webui/realtime
- Recon — Overview
components/tools/recon/overview
- Recon — Pipeline (`tools/recon/`)
components/tools/recon/pipeline
- Research Subsystem
research
- Run logs
run-logs
- Run Manager
api/run-manager
- Run Pages
webui/pages/run
- Run Service — Overview (`tools/run_service/`)
components/tools/run-service/overview
- Run Service & API Layer — Architecture
run-service
- Run-Create Components (`components/run-create/*`)
webui/components/run-create
- Runs Endpoints
api/endpoints/runs
- Sandbox — Overview (`tools/sandbox/`)
components/tools/sandbox/overview
- Scope Risk
components/flow-b/scope-risk
- Secrets Management
configuration/secrets
- Settings (`/system`)
webui/pages/settings
- Skill Catalog (Generated)
skills/catalog
- State
webui/state
- Swarm — Agents (all 7)
components/tools/swarm/agents
- Swarm — Internals (`tools/swarm/`)
components/tools/swarm/internals
- Swarm — Overview
components/tools/swarm/overview
- System Endpoints
api/endpoints/system
- System Source Map
reference/source-map
- Tool Family: ad
mcp/tool-families/ad
- Tool Family: agent-modules
mcp/tool-families/agent-modules
- Tool Family: assessment-state
mcp/tool-families/assessment-state
- Tool Family: browser
mcp/tool-families/browser
- Tool Family: cracking
mcp/tool-families/cracking
- Tool Family: credentials
mcp/tool-families/credentials
- Tool Family: domain
mcp/tool-families/domain
- Tool Family: hitl
mcp/tool-families/hitl
- Tool Family: killchain
mcp/tool-families/killchain
- Tool Family: metasploit
mcp/tool-families/metasploit
- Tool Family: mitre
mcp/tool-families/mitre
- Tool Family: operator-connection
mcp/tool-families/operator-connection
- Tool Family: parallel-agents
mcp/tool-families/parallel-agents
- Tool Family: payloads
mcp/tool-families/payloads
- Tool Family: peer-models
mcp/tool-families/peer-models
- Tool Family: poc-verifier
mcp/tool-families/poc-verifier
- Tool Family: recon
mcp/tool-families/recon
- Tool Family: replay-simulator
mcp/tool-families/replay-simulator
- Tool Family: research
mcp/tool-families/research
- Tool Family: retest
mcp/tool-families/retest
- Tool Family: runtime-skills
mcp/tool-families/runtime-skills
- Tool Family: sessions
mcp/tool-families/sessions
- Tool Family: snapshots
mcp/tool-families/snapshots
- Tool Family: terminal
mcp/tool-families/terminal
- Tool Family: verify
mcp/tool-families/verify
- Tool Family: web-scan
mcp/tool-families/web-scan
- Tool Family: workspace
mcp/tool-families/workspace
- Type-checking migration strategy
type-checking
- UI Primitives (`components/ui/*`)
webui/components/primitives
- Users & Annotations Endpoints
api/endpoints/users
- Verification — Overview (`tools/verification/`)
components/tools/verification/overview
- WebSocket & SSE
api/websocket
- WebUI API Overview
api/overview
- WebUI Overview
webui/overview
Authorized testing only
These guides describe attack tooling for systems you own or have explicit written permission to assess — the same scope lock and audit chain as the product itself.