HunterX Development Bible
Status: Ratified corpus Version: 1.0.0 Owner: HunterX Architecture Council
The HunterX Development Bible is the official engineering foundation and single source of truth for every HunterX sprint. All implementation MUST comply with these documents. No placeholders, no TODOs, no implementation code — this is the specification of record.
How to Use This Bible
- New contributors: read
01 - Vision.md,02 - Architecture.md,04 - Coding Standards.md, and24 - Quality Assurance.mdfirst. - Building a tool integration: follow
22 - Tool Integration Standard.md(which references06,07, and15). - Writing a plugin: follow
05 - Plugin SDK Specification.md. - Changing behavior: update the affected docs in the same PR
(
23 - Development Workflow.md,24 - Quality Assurance.md). - Growing the platform:
25 - Future Expansion.mdguarantees the Core stays stable while tools, plugins, missions, and deployments expand.
Document Index
| # | Document | Summary |
|---|---|---|
| 01 | Vision | Mission, goals, scope, non-goals, supported assessment types, philosophy |
| 02 | Architecture | Full system design, subsystem contracts, C4 diagrams, ADRs |
| 03 | Folder Structure | Complete repository hierarchy with dependency rules |
| 04 | Coding Standards | Python standards: typing, naming, DI, SOLID, async, thread safety |
| 05 | Plugin SDK Specification | Plugin lifecycle, manifest, permissions, versioning, security |
| 06 | Tool Adapter SDK | Adapter contracts: Base, Scanner, Crawler, Enumerator, Analyzer, Reporter, Validation |
| 07 | Tool Knowledge Base Specification | Per-tool knowledge file contract |
| 08 | Unified Security Schema | Canonical entities, events, severity/confidence models |
| 09 | Database Design | TIDB, Knowledge Graph, ER, indexes, history, retention, caching |
| 10 | Workflow Engine | DAG execution, dependencies, retries, checkpoints, recovery |
| 11 | AI Standards | AI role, prompts, validation, confidence/risk, learning, safety |
| 12 | Mission Profiles | All 12 mission types: workflow, tools, outputs, risk models |
| 13 | Security Standards | Sandbox, permissions, secrets, isolation, supply chain, audit |
| 14 | Performance Standards | Memory, CPU, scaling, caching, large-target support |
| 15 | Testing Standards | Unit→acceptance pyramid, golden sets, coverage, CI |
| 16 | Documentation Standards | Markdown, diagrams (Mermaid), API docs, versioning |
| 17 | Error Handling Standards | Taxonomy, retries, rollback, degradation, recovery |
| 18 | Logging Standards | JSON logging, metrics, tracing, audit, performance logs |
| 19 | CLI Standards | Commands, flags, profiles, formatting, errors, autocomplete |
| 20 | REST API Standards | Auth, schemas, pagination, errors, versioning, security |
| 21 | Reporting Standards | Views, exports (JSON/MD/HTML/PDF/SARIF), evidence packages |
| 22 | Tool Integration Standard | Full checklist for every integrated tool |
| 23 | Development Workflow | Git flow, branches, code review, CI/CD, release, SemVer |
| 24 | Quality Assurance | Acceptance criteria, review checklists, change processes |
| 25 | Future Expansion | Unlimited tools/plugins, distributed execution, multi-agent AI |
Binding Status
- Ratified — must be followed; changes via the ADR / Schema Change process
(
24 - Quality Assurance.md§6–§7). - A conflict between docs is resolved in this order:
01(philosophy) →02(architecture) → the specific domain doc → implementation decisions recorded as an ADR.
Version & Changelog
| Version | Date | Change |
|---|---|---|
| 1.0.0 | 2026-08-05 | Initial ratification of the complete 25-document corpus |
Related Project Documentation
docs/ARCHITECTURE.md,docs/AGENTS.md— current implementation notes (superseded by this Bible where they conflict; migration tracked as engineering work).README.md,CONTRIBUTING.md,SECURITY.md,CHANGELOG.md— project-level docs.