HunterX Development Bible

August 11, 2026 · View on GitHub

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

  1. New contributors: read 01 - Vision.md, 02 - Architecture.md, 04 - Coding Standards.md, and 24 - Quality Assurance.md first.
  2. Building a tool integration: follow 22 - Tool Integration Standard.md (which references 06, 07, and 15).
  3. Writing a plugin: follow 05 - Plugin SDK Specification.md.
  4. Changing behavior: update the affected docs in the same PR (23 - Development Workflow.md, 24 - Quality Assurance.md).
  5. Growing the platform: 25 - Future Expansion.md guarantees the Core stays stable while tools, plugins, missions, and deployments expand.

Document Index

#DocumentSummary
01VisionMission, goals, scope, non-goals, supported assessment types, philosophy
02ArchitectureFull system design, subsystem contracts, C4 diagrams, ADRs
03Folder StructureComplete repository hierarchy with dependency rules
04Coding StandardsPython standards: typing, naming, DI, SOLID, async, thread safety
05Plugin SDK SpecificationPlugin lifecycle, manifest, permissions, versioning, security
06Tool Adapter SDKAdapter contracts: Base, Scanner, Crawler, Enumerator, Analyzer, Reporter, Validation
07Tool Knowledge Base SpecificationPer-tool knowledge file contract
08Unified Security SchemaCanonical entities, events, severity/confidence models
09Database DesignTIDB, Knowledge Graph, ER, indexes, history, retention, caching
10Workflow EngineDAG execution, dependencies, retries, checkpoints, recovery
11AI StandardsAI role, prompts, validation, confidence/risk, learning, safety
12Mission ProfilesAll 12 mission types: workflow, tools, outputs, risk models
13Security StandardsSandbox, permissions, secrets, isolation, supply chain, audit
14Performance StandardsMemory, CPU, scaling, caching, large-target support
15Testing StandardsUnit→acceptance pyramid, golden sets, coverage, CI
16Documentation StandardsMarkdown, diagrams (Mermaid), API docs, versioning
17Error Handling StandardsTaxonomy, retries, rollback, degradation, recovery
18Logging StandardsJSON logging, metrics, tracing, audit, performance logs
19CLI StandardsCommands, flags, profiles, formatting, errors, autocomplete
20REST API StandardsAuth, schemas, pagination, errors, versioning, security
21Reporting StandardsViews, exports (JSON/MD/HTML/PDF/SARIF), evidence packages
22Tool Integration StandardFull checklist for every integrated tool
23Development WorkflowGit flow, branches, code review, CI/CD, release, SemVer
24Quality AssuranceAcceptance criteria, review checklists, change processes
25Future ExpansionUnlimited 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

VersionDateChange
1.0.02026-08-05Initial ratification of the complete 25-document corpus

  • 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.