@accelerationguy/accel 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +19 -0
- package/LICENSE +33 -0
- package/README.md +275 -0
- package/bin/install.js +661 -0
- package/docs/getting-started.md +164 -0
- package/docs/module-guide.md +139 -0
- package/modules/drive/LICENSE +21 -0
- package/modules/drive/PAUL-VS-GSD.md +171 -0
- package/modules/drive/README.md +555 -0
- package/modules/drive/assets/terminal.svg +67 -0
- package/modules/drive/bin/install.js +210 -0
- package/modules/drive/integration.js +76 -0
- package/modules/drive/package.json +38 -0
- package/modules/drive/src/commands/add-phase.md +36 -0
- package/modules/drive/src/commands/apply.md +83 -0
- package/modules/drive/src/commands/assumptions.md +37 -0
- package/modules/drive/src/commands/audit.md +57 -0
- package/modules/drive/src/commands/complete-milestone.md +36 -0
- package/modules/drive/src/commands/config.md +175 -0
- package/modules/drive/src/commands/consider-issues.md +41 -0
- package/modules/drive/src/commands/discover.md +48 -0
- package/modules/drive/src/commands/discuss-milestone.md +33 -0
- package/modules/drive/src/commands/discuss.md +34 -0
- package/modules/drive/src/commands/flows.md +73 -0
- package/modules/drive/src/commands/handoff.md +201 -0
- package/modules/drive/src/commands/help.md +525 -0
- package/modules/drive/src/commands/init.md +54 -0
- package/modules/drive/src/commands/map-codebase.md +34 -0
- package/modules/drive/src/commands/milestone.md +34 -0
- package/modules/drive/src/commands/pause.md +44 -0
- package/modules/drive/src/commands/plan-fix.md +216 -0
- package/modules/drive/src/commands/plan.md +36 -0
- package/modules/drive/src/commands/progress.md +138 -0
- package/modules/drive/src/commands/register.md +29 -0
- package/modules/drive/src/commands/remove-phase.md +37 -0
- package/modules/drive/src/commands/research-phase.md +209 -0
- package/modules/drive/src/commands/research.md +47 -0
- package/modules/drive/src/commands/resume.md +49 -0
- package/modules/drive/src/commands/status.md +78 -0
- package/modules/drive/src/commands/unify.md +87 -0
- package/modules/drive/src/commands/verify.md +60 -0
- package/modules/drive/src/references/checkpoints.md +234 -0
- package/modules/drive/src/references/context-management.md +219 -0
- package/modules/drive/src/references/git-strategy.md +206 -0
- package/modules/drive/src/references/loop-phases.md +254 -0
- package/modules/drive/src/references/plan-format.md +263 -0
- package/modules/drive/src/references/quality-principles.md +152 -0
- package/modules/drive/src/references/research-quality-control.md +247 -0
- package/modules/drive/src/references/sonarqube-integration.md +244 -0
- package/modules/drive/src/references/specialized-workflow-integration.md +186 -0
- package/modules/drive/src/references/subagent-criteria.md +179 -0
- package/modules/drive/src/references/tdd.md +219 -0
- package/modules/drive/src/references/work-units.md +161 -0
- package/modules/drive/src/rules/commands.md +108 -0
- package/modules/drive/src/rules/references.md +107 -0
- package/modules/drive/src/rules/style.md +123 -0
- package/modules/drive/src/rules/templates.md +51 -0
- package/modules/drive/src/rules/workflows.md +133 -0
- package/modules/drive/src/templates/CONTEXT.md +88 -0
- package/modules/drive/src/templates/DEBUG.md +164 -0
- package/modules/drive/src/templates/DISCOVERY.md +148 -0
- package/modules/drive/src/templates/HANDOFF.md +77 -0
- package/modules/drive/src/templates/ISSUES.md +93 -0
- package/modules/drive/src/templates/MILESTONES.md +167 -0
- package/modules/drive/src/templates/PLAN.md +328 -0
- package/modules/drive/src/templates/PROJECT.md +219 -0
- package/modules/drive/src/templates/RESEARCH.md +130 -0
- package/modules/drive/src/templates/ROADMAP.md +328 -0
- package/modules/drive/src/templates/SPECIAL-FLOWS.md +70 -0
- package/modules/drive/src/templates/STATE.md +210 -0
- package/modules/drive/src/templates/SUMMARY.md +221 -0
- package/modules/drive/src/templates/UAT-ISSUES.md +139 -0
- package/modules/drive/src/templates/codebase/architecture.md +259 -0
- package/modules/drive/src/templates/codebase/concerns.md +329 -0
- package/modules/drive/src/templates/codebase/conventions.md +311 -0
- package/modules/drive/src/templates/codebase/integrations.md +284 -0
- package/modules/drive/src/templates/codebase/stack.md +190 -0
- package/modules/drive/src/templates/codebase/structure.md +287 -0
- package/modules/drive/src/templates/codebase/testing.md +484 -0
- package/modules/drive/src/templates/config.md +181 -0
- package/modules/drive/src/templates/milestone-archive.md +236 -0
- package/modules/drive/src/templates/milestone-context.md +190 -0
- package/modules/drive/src/templates/paul-json.md +147 -0
- package/modules/drive/src/vector-config/PAUL +26 -0
- package/modules/drive/src/vector-config/PAUL.manifest +11 -0
- package/modules/drive/src/workflows/apply-phase.md +393 -0
- package/modules/drive/src/workflows/audit-plan.md +344 -0
- package/modules/drive/src/workflows/complete-milestone.md +479 -0
- package/modules/drive/src/workflows/configure-special-flows.md +283 -0
- package/modules/drive/src/workflows/consider-issues.md +172 -0
- package/modules/drive/src/workflows/create-milestone.md +268 -0
- package/modules/drive/src/workflows/debug.md +292 -0
- package/modules/drive/src/workflows/discovery.md +187 -0
- package/modules/drive/src/workflows/discuss-milestone.md +245 -0
- package/modules/drive/src/workflows/discuss-phase.md +231 -0
- package/modules/drive/src/workflows/init-project.md +698 -0
- package/modules/drive/src/workflows/map-codebase.md +459 -0
- package/modules/drive/src/workflows/pause-work.md +259 -0
- package/modules/drive/src/workflows/phase-assumptions.md +181 -0
- package/modules/drive/src/workflows/plan-phase.md +385 -0
- package/modules/drive/src/workflows/quality-gate.md +263 -0
- package/modules/drive/src/workflows/register-manifest.md +107 -0
- package/modules/drive/src/workflows/research.md +241 -0
- package/modules/drive/src/workflows/resume-project.md +200 -0
- package/modules/drive/src/workflows/roadmap-management.md +334 -0
- package/modules/drive/src/workflows/transition-phase.md +368 -0
- package/modules/drive/src/workflows/unify-phase.md +290 -0
- package/modules/drive/src/workflows/verify-work.md +241 -0
- package/modules/forge/README.md +281 -0
- package/modules/forge/bin/install.js +200 -0
- package/modules/forge/package.json +32 -0
- package/modules/forge/skillsmith/rules/checklists-rules.md +42 -0
- package/modules/forge/skillsmith/rules/context-rules.md +43 -0
- package/modules/forge/skillsmith/rules/entry-point-rules.md +44 -0
- package/modules/forge/skillsmith/rules/frameworks-rules.md +43 -0
- package/modules/forge/skillsmith/rules/tasks-rules.md +52 -0
- package/modules/forge/skillsmith/rules/templates-rules.md +43 -0
- package/modules/forge/skillsmith/skillsmith.md +82 -0
- package/modules/forge/skillsmith/tasks/audit.md +277 -0
- package/modules/forge/skillsmith/tasks/discover.md +145 -0
- package/modules/forge/skillsmith/tasks/distill.md +276 -0
- package/modules/forge/skillsmith/tasks/scaffold.md +349 -0
- package/modules/forge/specs/checklists.md +193 -0
- package/modules/forge/specs/context.md +223 -0
- package/modules/forge/specs/entry-point.md +320 -0
- package/modules/forge/specs/frameworks.md +228 -0
- package/modules/forge/specs/rules.md +245 -0
- package/modules/forge/specs/tasks.md +344 -0
- package/modules/forge/specs/templates.md +335 -0
- package/modules/forge/terminal.svg +70 -0
- package/modules/ignition/README.md +245 -0
- package/modules/ignition/bin/install.js +184 -0
- package/modules/ignition/checklists/planning-quality.md +55 -0
- package/modules/ignition/data/application/config.md +21 -0
- package/modules/ignition/data/application/guide.md +51 -0
- package/modules/ignition/data/application/skill-loadout.md +11 -0
- package/modules/ignition/data/campaign/config.md +18 -0
- package/modules/ignition/data/campaign/guide.md +36 -0
- package/modules/ignition/data/campaign/skill-loadout.md +10 -0
- package/modules/ignition/data/client/config.md +18 -0
- package/modules/ignition/data/client/guide.md +36 -0
- package/modules/ignition/data/client/skill-loadout.md +11 -0
- package/modules/ignition/data/utility/config.md +18 -0
- package/modules/ignition/data/utility/guide.md +31 -0
- package/modules/ignition/data/utility/skill-loadout.md +8 -0
- package/modules/ignition/data/workflow/config.md +19 -0
- package/modules/ignition/data/workflow/guide.md +41 -0
- package/modules/ignition/data/workflow/skill-loadout.md +10 -0
- package/modules/ignition/integration.js +54 -0
- package/modules/ignition/package.json +35 -0
- package/modules/ignition/seed.md +81 -0
- package/modules/ignition/tasks/add-type.md +164 -0
- package/modules/ignition/tasks/graduate.md +182 -0
- package/modules/ignition/tasks/ideate.md +221 -0
- package/modules/ignition/tasks/launch.md +137 -0
- package/modules/ignition/tasks/status.md +71 -0
- package/modules/ignition/templates/planning-application.md +193 -0
- package/modules/ignition/templates/planning-campaign.md +138 -0
- package/modules/ignition/templates/planning-client.md +149 -0
- package/modules/ignition/templates/planning-utility.md +112 -0
- package/modules/ignition/templates/planning-workflow.md +125 -0
- package/modules/ignition/terminal.svg +74 -0
- package/modules/mission-control/CONTEXT-CONTINUITY-SPEC.md +293 -0
- package/modules/mission-control/CONTEXT-ENGINEERING-GUIDE.md +282 -0
- package/modules/mission-control/README.md +91 -0
- package/modules/mission-control/assets/terminal.svg +80 -0
- package/modules/mission-control/examples/entities.example.json +133 -0
- package/modules/mission-control/examples/projects.example.json +318 -0
- package/modules/mission-control/examples/state.example.json +183 -0
- package/modules/mission-control/examples/vector.example.json +245 -0
- package/modules/mission-control/mission-control/checklists/install-verification.md +46 -0
- package/modules/mission-control/mission-control/frameworks/framework-registry.md +83 -0
- package/modules/mission-control/mission-control/mission-control.md +83 -0
- package/modules/mission-control/mission-control/tasks/insights.md +73 -0
- package/modules/mission-control/mission-control/tasks/install.md +194 -0
- package/modules/mission-control/mission-control/tasks/status.md +125 -0
- package/modules/mission-control/schemas/entities.schema.json +89 -0
- package/modules/mission-control/schemas/projects.schema.json +221 -0
- package/modules/mission-control/schemas/state.schema.json +108 -0
- package/modules/mission-control/schemas/vector.schema.json +200 -0
- package/modules/momentum/README.md +678 -0
- package/modules/momentum/bin/install.js +563 -0
- package/modules/momentum/integration.js +131 -0
- package/modules/momentum/package.json +42 -0
- package/modules/momentum/schemas/entities.schema.json +89 -0
- package/modules/momentum/schemas/projects.schema.json +221 -0
- package/modules/momentum/schemas/state.schema.json +108 -0
- package/modules/momentum/src/commands/audit-claude-md.md +31 -0
- package/modules/momentum/src/commands/audit.md +33 -0
- package/modules/momentum/src/commands/groom.md +35 -0
- package/modules/momentum/src/commands/history.md +27 -0
- package/modules/momentum/src/commands/pulse.md +33 -0
- package/modules/momentum/src/commands/scaffold.md +33 -0
- package/modules/momentum/src/commands/status.md +28 -0
- package/modules/momentum/src/commands/surface-convert.md +35 -0
- package/modules/momentum/src/commands/surface-create.md +34 -0
- package/modules/momentum/src/commands/surface-list.md +27 -0
- package/modules/momentum/src/commands/vector-hygiene.md +33 -0
- package/modules/momentum/src/framework/context/momentum-principles.md +71 -0
- package/modules/momentum/src/framework/frameworks/audit-strategies.md +53 -0
- package/modules/momentum/src/framework/frameworks/satellite-registration.md +44 -0
- package/modules/momentum/src/framework/tasks/audit-claude-md.md +68 -0
- package/modules/momentum/src/framework/tasks/audit.md +64 -0
- package/modules/momentum/src/framework/tasks/groom.md +164 -0
- package/modules/momentum/src/framework/tasks/history.md +34 -0
- package/modules/momentum/src/framework/tasks/pulse.md +83 -0
- package/modules/momentum/src/framework/tasks/scaffold.md +202 -0
- package/modules/momentum/src/framework/tasks/status.md +35 -0
- package/modules/momentum/src/framework/tasks/surface-convert.md +143 -0
- package/modules/momentum/src/framework/tasks/surface-create.md +184 -0
- package/modules/momentum/src/framework/tasks/surface-list.md +42 -0
- package/modules/momentum/src/framework/tasks/vector-hygiene.md +160 -0
- package/modules/momentum/src/framework/templates/workspace-json.md +96 -0
- package/modules/momentum/src/hooks/_template.py +129 -0
- package/modules/momentum/src/hooks/active-hook.py +178 -0
- package/modules/momentum/src/hooks/backlog-hook.py +115 -0
- package/modules/momentum/src/hooks/mission-control-insights.py +169 -0
- package/modules/momentum/src/hooks/momentum-pulse-check.py +351 -0
- package/modules/momentum/src/hooks/operator.py +53 -0
- package/modules/momentum/src/hooks/psmm-injector.py +67 -0
- package/modules/momentum/src/hooks/satellite-detection.py +248 -0
- package/modules/momentum/src/packages/momentum-mcp/index.js +119 -0
- package/modules/momentum/src/packages/momentum-mcp/package.json +10 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/entities.js +226 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/operator.js +106 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/projects.js +322 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/psmm.js +206 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/state.js +199 -0
- package/modules/momentum/src/packages/momentum-mcp/tools/surfaces.js +404 -0
- package/modules/momentum/src/skill/momentum.md +111 -0
- package/modules/momentum/src/tasks/groom.md +164 -0
- package/modules/momentum/src/templates/operator.json +66 -0
- package/modules/momentum/src/templates/workspace.json +111 -0
- package/modules/momentum/terminal.svg +77 -0
- package/modules/radar/README.md +1552 -0
- package/modules/radar/commands/audit.md +233 -0
- package/modules/radar/commands/guardrails.md +194 -0
- package/modules/radar/commands/init.md +207 -0
- package/modules/radar/commands/playbook.md +176 -0
- package/modules/radar/commands/remediate.md +156 -0
- package/modules/radar/commands/report.md +172 -0
- package/modules/radar/commands/resume.md +176 -0
- package/modules/radar/commands/status.md +148 -0
- package/modules/radar/commands/transform.md +205 -0
- package/modules/radar/commands/validate.md +177 -0
- package/modules/radar/docs/ARCHITECTURE.md +336 -0
- package/modules/radar/docs/GETTING-STARTED.md +287 -0
- package/modules/radar/docs/standards/agents.md +197 -0
- package/modules/radar/docs/standards/commands.md +250 -0
- package/modules/radar/docs/standards/domains.md +191 -0
- package/modules/radar/docs/standards/personas.md +211 -0
- package/modules/radar/docs/standards/rules.md +218 -0
- package/modules/radar/docs/standards/runtime.md +445 -0
- package/modules/radar/docs/standards/schemas.md +269 -0
- package/modules/radar/docs/standards/tools.md +273 -0
- package/modules/radar/docs/standards/workflows.md +254 -0
- package/modules/radar/docs/terminal.svg +72 -0
- package/modules/radar/docs/validation/convention-compliance-report.md +183 -0
- package/modules/radar/docs/validation/cross-reference-report.md +195 -0
- package/modules/radar/docs/validation/validation-summary.md +118 -0
- package/modules/radar/docs/validation/version-manifest.yaml +363 -0
- package/modules/radar/install.sh +711 -0
- package/modules/radar/integration.js +53 -0
- package/modules/radar/src/core/agents/architect.md +25 -0
- package/modules/radar/src/core/agents/compliance-officer.md +25 -0
- package/modules/radar/src/core/agents/data-engineer.md +25 -0
- package/modules/radar/src/core/agents/devils-advocate.md +22 -0
- package/modules/radar/src/core/agents/performance-engineer.md +25 -0
- package/modules/radar/src/core/agents/principal-engineer.md +23 -0
- package/modules/radar/src/core/agents/reality-gap-analyst.md +22 -0
- package/modules/radar/src/core/agents/security-engineer.md +25 -0
- package/modules/radar/src/core/agents/senior-app-engineer.md +25 -0
- package/modules/radar/src/core/agents/sre.md +25 -0
- package/modules/radar/src/core/agents/staff-engineer.md +23 -0
- package/modules/radar/src/core/agents/test-engineer.md +25 -0
- package/modules/radar/src/core/personas/architect.md +111 -0
- package/modules/radar/src/core/personas/compliance-officer.md +104 -0
- package/modules/radar/src/core/personas/data-engineer.md +113 -0
- package/modules/radar/src/core/personas/devils-advocate.md +105 -0
- package/modules/radar/src/core/personas/performance-engineer.md +119 -0
- package/modules/radar/src/core/personas/principal-engineer.md +119 -0
- package/modules/radar/src/core/personas/reality-gap-analyst.md +111 -0
- package/modules/radar/src/core/personas/security-engineer.md +108 -0
- package/modules/radar/src/core/personas/senior-app-engineer.md +111 -0
- package/modules/radar/src/core/personas/sre.md +117 -0
- package/modules/radar/src/core/personas/staff-engineer.md +109 -0
- package/modules/radar/src/core/personas/test-engineer.md +109 -0
- package/modules/radar/src/core/workflows/disagreement-resolution.md +183 -0
- package/modules/radar/src/core/workflows/phase-0-context.md +148 -0
- package/modules/radar/src/core/workflows/phase-1-reconnaissance.md +169 -0
- package/modules/radar/src/core/workflows/phase-2-domain-audits.md +190 -0
- package/modules/radar/src/core/workflows/phase-3-cross-domain.md +177 -0
- package/modules/radar/src/core/workflows/phase-4-adversarial-review.md +165 -0
- package/modules/radar/src/core/workflows/phase-5-report.md +189 -0
- package/modules/radar/src/core/workflows/phase-checkpoint.md +222 -0
- package/modules/radar/src/core/workflows/session-handoff.md +152 -0
- package/modules/radar/src/domains/00-context.md +201 -0
- package/modules/radar/src/domains/01-architecture.md +248 -0
- package/modules/radar/src/domains/02-data.md +224 -0
- package/modules/radar/src/domains/03-correctness.md +230 -0
- package/modules/radar/src/domains/04-security.md +274 -0
- package/modules/radar/src/domains/05-compliance.md +228 -0
- package/modules/radar/src/domains/06-testing.md +228 -0
- package/modules/radar/src/domains/07-reliability.md +246 -0
- package/modules/radar/src/domains/08-performance.md +247 -0
- package/modules/radar/src/domains/09-maintainability.md +271 -0
- package/modules/radar/src/domains/10-operability.md +250 -0
- package/modules/radar/src/domains/11-change-risk.md +246 -0
- package/modules/radar/src/domains/12-team-risk.md +221 -0
- package/modules/radar/src/domains/13-risk-synthesis.md +202 -0
- package/modules/radar/src/rules/agent-boundaries.md +78 -0
- package/modules/radar/src/rules/disagreement-protocol.md +76 -0
- package/modules/radar/src/rules/epistemic-hygiene.md +78 -0
- package/modules/radar/src/schemas/confidence.md +185 -0
- package/modules/radar/src/schemas/disagreement.md +238 -0
- package/modules/radar/src/schemas/finding.md +287 -0
- package/modules/radar/src/schemas/report-section.md +150 -0
- package/modules/radar/src/schemas/signal.md +108 -0
- package/modules/radar/src/tools/checkov.md +463 -0
- package/modules/radar/src/tools/git-history.md +581 -0
- package/modules/radar/src/tools/gitleaks.md +447 -0
- package/modules/radar/src/tools/grype.md +611 -0
- package/modules/radar/src/tools/semgrep.md +378 -0
- package/modules/radar/src/tools/sonarqube.md +550 -0
- package/modules/radar/src/tools/syft.md +539 -0
- package/modules/radar/src/tools/trivy.md +439 -0
- package/modules/radar/src/transform/agents/change-risk-modeler.md +24 -0
- package/modules/radar/src/transform/agents/execution-validator.md +24 -0
- package/modules/radar/src/transform/agents/guardrail-generator.md +24 -0
- package/modules/radar/src/transform/agents/pedagogy-agent.md +24 -0
- package/modules/radar/src/transform/agents/remediation-architect.md +24 -0
- package/modules/radar/src/transform/personas/change-risk-modeler.md +95 -0
- package/modules/radar/src/transform/personas/execution-validator.md +95 -0
- package/modules/radar/src/transform/personas/guardrail-generator.md +103 -0
- package/modules/radar/src/transform/personas/pedagogy-agent.md +105 -0
- package/modules/radar/src/transform/personas/remediation-architect.md +95 -0
- package/modules/radar/src/transform/rules/change-risk-rules.md +87 -0
- package/modules/radar/src/transform/rules/safety-governance.md +87 -0
- package/modules/radar/src/transform/schemas/change-risk.md +139 -0
- package/modules/radar/src/transform/schemas/intervention-level.md +207 -0
- package/modules/radar/src/transform/schemas/playbook.md +205 -0
- package/modules/radar/src/transform/schemas/verification-plan.md +134 -0
- package/modules/radar/src/transform/workflows/phase-6-remediation.md +148 -0
- package/modules/radar/src/transform/workflows/phase-7-risk-validation.md +161 -0
- package/modules/radar/src/transform/workflows/phase-8-execution-planning.md +159 -0
- package/modules/radar/src/transform/workflows/transform-safety.md +158 -0
- package/modules/vector/.vector-template/sessions/.gitkeep +0 -0
- package/modules/vector/.vector-template/vector.json +72 -0
- package/modules/vector/AUDIT-CLAUDEMD.md +154 -0
- package/modules/vector/INSTALL.md +185 -0
- package/modules/vector/LICENSE +21 -0
- package/modules/vector/README.md +409 -0
- package/modules/vector/VECTOR-BLOCK.md +57 -0
- package/modules/vector/assets/terminal.svg +68 -0
- package/modules/vector/bin/install.js +455 -0
- package/modules/vector/bin/migrate-v1-to-v2.sh +492 -0
- package/modules/vector/commands/help.md +46 -0
- package/modules/vector/hooks/vector-hook.py +775 -0
- package/modules/vector/mcp/index.js +118 -0
- package/modules/vector/mcp/package.json +10 -0
- package/modules/vector/mcp/tools/decisions.js +269 -0
- package/modules/vector/mcp/tools/domains.js +361 -0
- package/modules/vector/mcp/tools/staging.js +252 -0
- package/modules/vector/mcp/tools/vector-json.js +647 -0
- package/modules/vector/package.json +38 -0
- package/modules/vector/schemas/vector.schema.json +237 -0
- package/package.json +39 -0
- package/shared/branding/branding.js +70 -0
- package/shared/config/defaults.json +59 -0
- package/shared/events/README.md +175 -0
- package/shared/events/event-bus.js +134 -0
- package/shared/events/event_bus.py +255 -0
- package/shared/events/integrations.js +161 -0
- package/shared/events/schemas/audit-complete.schema.json +21 -0
- package/shared/events/schemas/phase-progress.schema.json +23 -0
- package/shared/events/schemas/plan-created.schema.json +21 -0
|
@@ -0,0 +1,336 @@
|
|
|
1
|
+
# Radar Architecture
|
|
2
|
+
|
|
3
|
+
**Multi-Agent Codebase Audit System — Accelerate Module**
|
|
4
|
+
|
|
5
|
+
Multi-agent codebase audit framework with decomposed components and forensic-grade traceability.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Directory Structure
|
|
10
|
+
|
|
11
|
+
### Two-System Layout
|
|
12
|
+
|
|
13
|
+
Radar is organized as two systems sharing common infrastructure:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
radar/
|
|
17
|
+
├── src/
|
|
18
|
+
│ ├── core/ # Radar Core (Diagnosis Engine)
|
|
19
|
+
│ │ ├── commands/ # Core user entry points (/radar:audit, /radar:resume)
|
|
20
|
+
│ │ ├── personas/ # 12 Core audit personas
|
|
21
|
+
│ │ ├── agents/ # 12 Core agent assemblies
|
|
22
|
+
│ │ └── workflows/ # Core phase orchestration (Phases 0-5)
|
|
23
|
+
│ ├── transform/ # Radar Transform (Controlled Evolution Engine)
|
|
24
|
+
│ │ ├── commands/ # Transform entry points (/radar:transform, /radar:remediate)
|
|
25
|
+
│ │ ├── personas/ # 5 Transform personas
|
|
26
|
+
│ │ ├── schemas/ # Transform-specific schemas (playbook, change-risk, verification)
|
|
27
|
+
│ │ ├── rules/ # Safety & liability rules
|
|
28
|
+
│ │ ├── agents/ # 5 Transform agent assemblies
|
|
29
|
+
│ │ ├── workflows/ # Transform phase orchestration (Phases 6-8)
|
|
30
|
+
│ │ └── patterns/ # Pattern corpus (accumulated over time)
|
|
31
|
+
│ ├── domains/ # Shared — 14 domain knowledge modules (Core + Transform)
|
|
32
|
+
│ ├── schemas/ # Shared — Core output contracts (finding, disagreement, signal, etc.)
|
|
33
|
+
│ ├── rules/ # Shared — Epistemic governance (applies to all agents)
|
|
34
|
+
│ └── tools/ # Shared — Tool adapters and output normalizers
|
|
35
|
+
├── docs/
|
|
36
|
+
│ ├── ARCHITECTURE.md # This file
|
|
37
|
+
│ ├── standards/ # Per-component-type conventions
|
|
38
|
+
│ └── ...
|
|
39
|
+
└── .radar-template/ # Audit workspace scaffold
|
|
40
|
+
├── context/ # Phase 0 outputs
|
|
41
|
+
├── signals/ # Phase 1 outputs
|
|
42
|
+
├── findings/ # Phase 2-3 outputs
|
|
43
|
+
├── review/ # Phase 4 outputs
|
|
44
|
+
├── report/ # Phase 5 outputs
|
|
45
|
+
├── remediation/ # Phase 6-7 outputs (Layer B)
|
|
46
|
+
└── execution/ # Phase 8 outputs (Layer C)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Component Directory Reference
|
|
50
|
+
|
|
51
|
+
| Directory | System | Purpose |
|
|
52
|
+
|-----------|--------|---------|
|
|
53
|
+
| `src/core/commands/` | Core | User entry points — slash commands that invoke Core workflows |
|
|
54
|
+
| `src/core/personas/` | Core | Identity definitions — 12 Core personas defining how agents think, argue, and calibrate confidence |
|
|
55
|
+
| `src/core/agents/` | Core | Assembly manifests — 12 Core agent compositions |
|
|
56
|
+
| `src/core/workflows/` | Core | Phase orchestration — Execution logic for Phases 0-5 |
|
|
57
|
+
| `src/transform/commands/` | Transform | User entry points — slash commands that invoke Transform workflows |
|
|
58
|
+
| `src/transform/personas/` | Transform | Identity definitions — 5 Transform personas for intervention specialists |
|
|
59
|
+
| `src/transform/schemas/` | Transform | Transform-specific output contracts (playbook, change-risk, verification-plan) |
|
|
60
|
+
| `src/transform/rules/` | Transform | Safety & liability rules (confidence gating, conservative bias, no auto-execution) |
|
|
61
|
+
| `src/transform/agents/` | Transform | Assembly manifests — 5 Transform agent compositions |
|
|
62
|
+
| `src/transform/workflows/` | Transform | Phase orchestration — Execution logic for Phases 6-8 |
|
|
63
|
+
| `src/transform/patterns/` | Transform | Pattern corpus — Accumulated anti-pattern/remediation pairs |
|
|
64
|
+
| `src/domains/` | Shared | Knowledge modules — 14 domain-specific failure patterns, questions, and red flags |
|
|
65
|
+
| `src/schemas/` | Shared | Core output contracts — Finding, disagreement, confidence, signal, report schemas |
|
|
66
|
+
| `src/rules/` | Shared | Epistemic governance — Behavioral constraints applied to all agents |
|
|
67
|
+
| `src/tools/` | Shared | Tool integrations — Adapter configs and output normalizers |
|
|
68
|
+
| `docs/` | — | Documentation root — Architecture, standards, guides |
|
|
69
|
+
| `docs/standards/` | — | Convention specifications — Per-component-type standards |
|
|
70
|
+
| `.radar-template/` | — | Audit workspace scaffold — Copied into target repo at audit start |
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 2. Component Model
|
|
75
|
+
|
|
76
|
+
### Component Types
|
|
77
|
+
|
|
78
|
+
| Type | Count | System | Purpose | Defines | Referenced By |
|
|
79
|
+
|------|-------|--------|---------|---------|---------------|
|
|
80
|
+
| **Personas** | 12 + 5 | Core / Transform | WHO — identity, risk philosophy, thinking style | How an agent thinks, argues, calibrates confidence | Agent assembly manifests |
|
|
81
|
+
| **Domains** | 14 | Shared | WHAT — failure patterns, questions, red flags, best practices | What to audit, what to look for, what matters | Agent assembly manifests, tool affinities |
|
|
82
|
+
| **Schemas** | ~5 + ~4 | Shared / Transform | HOW — output format contracts | Finding, disagreement, confidence, signal, report (Core) + playbook, change-risk, intervention-level, verification-plan (Transform) | All agents (output), workflows (validation) |
|
|
83
|
+
| **Rules** | few + few | Shared / Transform | CONSTRAINTS — epistemic governance + safety governance | Behavioral constraints for all agents (Core) + safety rules for Transform agents | All agents (enforcement) |
|
|
84
|
+
| **Tools** | 7+ | Shared | INPUTS — signal sources + normalization | How to run tools, parse output, normalize to signal schema | Domain affinities, workflow orchestration |
|
|
85
|
+
| **Agents** | 12 + 5 | Core / Transform | ASSEMBLY — composition manifests | Which persona + domains + tools + schemas + rules compose each agent | Workflows (invocation) |
|
|
86
|
+
| **Workflows** | ~8 + ~4 | Core / Transform | ORCHESTRATION — phase sequencing | Step-by-step execution logic for each phase | Commands (delegation) |
|
|
87
|
+
| **Commands** | ~4 + ~4 | Core / Transform | ENTRY — user-facing slash commands | Guided wizard UX entry points | Users (invocation) |
|
|
88
|
+
|
|
89
|
+
### Decomposed Agent Architecture
|
|
90
|
+
|
|
91
|
+
**Core Design Principle:**
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
Agent = Persona + Domains[] + Schemas + Rules + Tool Interfaces
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Three-Layer Model:**
|
|
98
|
+
|
|
99
|
+
1. **Core Persona (strong/distinct)** — Unique identity, risk philosophy, argumentation style
|
|
100
|
+
2. **Domain Modules (neutral/structured)** — Pluggable knowledge modules defining what to audit
|
|
101
|
+
3. **Execution Envelope (shared contracts)** — Common schemas, rules, and tool interfaces
|
|
102
|
+
|
|
103
|
+
**Why Monolithic Agents Are Wrong:**
|
|
104
|
+
|
|
105
|
+
- **Many-to-many relationships:** 14 domains ≠ 12 agents. A security engineer covers 3-4 domains. A frontend specialist covers 2-3 different domains. Monolithic agents force artificial 1:1 mapping.
|
|
106
|
+
- **Independent auditability:** Domain knowledge (e.g., "what makes authentication weak") must be auditable, versioned, and testable independently of any specific agent's persona.
|
|
107
|
+
- **Independent evolution:** Domains evolve based on industry standards and CVE databases. Personas evolve based on role archetypes. Tool mappings evolve based on tooling ecosystem changes. These three axes are orthogonal.
|
|
108
|
+
- **Version-locked compositions:** A reproducible audit requires locking specific versions of persona, domains, schemas, rules, and tools. This is impossible with monolithic agents where all components are entangled in a single file.
|
|
109
|
+
- **Reusability:** The same domain (e.g., "05-dependencies") is used by multiple agents (Security Engineer, SRE, Principal Engineer). Duplication creates maintenance burden and version drift.
|
|
110
|
+
|
|
111
|
+
### Two-System Model
|
|
112
|
+
|
|
113
|
+
Radar operates as two complementary systems sharing common infrastructure.
|
|
114
|
+
|
|
115
|
+
**Shared components** (used by both Core and Transform):
|
|
116
|
+
- **Domains** (`src/domains/`) — Transform agents consume domain knowledge to contextualize remediation. The same failure patterns that Core agents detect are the patterns Transform agents remediate.
|
|
117
|
+
- **Core schemas** (`src/schemas/`) — Transform agents consume Layer A outputs (findings, disagreements, confidence) as input. The schemas that define these structures are shared.
|
|
118
|
+
- **Core rules** (`src/rules/`) — Epistemic governance applies to all agents. Transform agents must meet the same evidence and confidence standards.
|
|
119
|
+
- **Tool adapters** (`src/tools/`) — Some tools produce signals consumed by both systems (e.g., git history mining feeds both change risk analysis and remediation context).
|
|
120
|
+
|
|
121
|
+
**Separate components** (system-specific):
|
|
122
|
+
- **Personas** — Core personas are domain experts optimized for finding truth. Transform personas are intervention specialists optimized for producing safe, actionable change. These are fundamentally different cognitive profiles.
|
|
123
|
+
- **Agents** — Core agents work independently (decentralized diagnosis). Transform agents coordinate (centralized intervention). Different assembly patterns.
|
|
124
|
+
- **Workflows** — Core workflows orchestrate Phases 0-5. Transform workflows orchestrate Phases 6-8. Different execution models (parallel vs sequential).
|
|
125
|
+
- **Commands** — Core commands start and manage audits. Transform commands initiate remediation pipelines.
|
|
126
|
+
- **Transform schemas** — Playbook, change-risk, verification-plan schemas are Transform-specific. Core has no use for them.
|
|
127
|
+
- **Transform rules** — Safety and liability rules (confidence gating, conservative bias, no auto-execution) apply only to Transform agents.
|
|
128
|
+
|
|
129
|
+
**Why separation matters:** Diagnosis and intervention have different cognitive requirements. A diagnostic agent should be aggressive about finding problems — false negatives are worse than false positives. A Transform agent should be conservative about proposing changes — a bad fix is worse than no fix. Mixing these postures in a single system produces mediocre diagnosis and reckless intervention.
|
|
130
|
+
|
|
131
|
+
**How they connect:** Core Layer A outputs feed Transform Layer B/C inputs. The connection point is the `.radar/` directory — specifically the `findings/`, `review/`, and `report/` directories that Transform reads as input.
|
|
132
|
+
|
|
133
|
+
### Output Layer Architecture
|
|
134
|
+
|
|
135
|
+
Radar produces three output layers with a strict derivation chain:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
Layer A (Phases 0-5) → Layer B (Phases 6-7) → Layer C (Phase 8)
|
|
139
|
+
Diagnostic artifacts Remediation knowledge Change orchestration
|
|
140
|
+
Immutable Derived from A Derived from B
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
**Layer A → Layer B:** Findings + domain knowledge + confidence scores → remediation playbooks, best-practice patterns, educational context, guardrails.
|
|
144
|
+
|
|
145
|
+
**Layer B → Layer C:** Playbooks + risk scores → dependency-ordered execution plans, verification steps, Drive project artifacts.
|
|
146
|
+
|
|
147
|
+
**Dual format specification:** Every Layer B and Layer C artifact has two representations:
|
|
148
|
+
- **Human-readable** (`.md`) — Explanations, rationale, before/after examples, educational context
|
|
149
|
+
- **Machine-consumable** (`.yaml`) — Structured data with file targets, change instructions, verification steps, risk metadata, intervention level
|
|
150
|
+
|
|
151
|
+
This dual format ensures that both human developers and AI assistants can consume Transform output effectively.
|
|
152
|
+
|
|
153
|
+
---
|
|
154
|
+
|
|
155
|
+
## 3. Component Relationships
|
|
156
|
+
|
|
157
|
+
| Relationship | Type | Description |
|
|
158
|
+
|-------------|------|-------------|
|
|
159
|
+
| **Agents → Personas** | one-to-one | Each agent references exactly one persona defining its identity and thinking style |
|
|
160
|
+
| **Agents → Domains** | one-to-many | Each agent covers 1-3 domains depending on role scope |
|
|
161
|
+
| **Domains → Tools** | many-to-many | Multiple tools feed multiple domains (e.g., semgrep feeds security and code quality) |
|
|
162
|
+
| **Agents → Schemas** | many-to-shared | All agents use the same schema contracts for findings, disagreements, signals, reports |
|
|
163
|
+
| **Rules → Agents** | global | Rules constrain all agent behavior universally (epistemic hygiene applies to all) |
|
|
164
|
+
| **Workflows → Agents** | invocation | Workflows assemble and invoke agents per phase (e.g., Phase 2 invokes all domain agents) |
|
|
165
|
+
| **Commands → Workflows** | delegation | Commands delegate to workflows for execution (e.g., `/radar:audit` → `phase-0-context.md`) |
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## 4. Cross-Referencing Patterns
|
|
170
|
+
|
|
171
|
+
### @-References (Lazy-Load)
|
|
172
|
+
|
|
173
|
+
Used in workflows and commands to lazy-load files at execution time:
|
|
174
|
+
|
|
175
|
+
```markdown
|
|
176
|
+
Load the persona: @src/core/personas/security-engineer.md
|
|
177
|
+
Load the Transform persona: @src/transform/personas/remediation-architect.md
|
|
178
|
+
Load the shared domain: @src/domains/04-security.md
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Files are read when needed, not preloaded. Note: system prefix (`core/` or `transform/`) is required for system-specific components. Shared components use root `src/` paths.
|
|
182
|
+
|
|
183
|
+
### Assembly References (Component IDs)
|
|
184
|
+
|
|
185
|
+
Used in agent manifests to reference components by ID:
|
|
186
|
+
|
|
187
|
+
```yaml
|
|
188
|
+
persona: security-engineer
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Resolved at runtime to the appropriate system path based on which system the agent belongs to.
|
|
192
|
+
|
|
193
|
+
### Domain Mapping (Numeric IDs)
|
|
194
|
+
|
|
195
|
+
Used in agent manifests to reference domains by number:
|
|
196
|
+
|
|
197
|
+
```yaml
|
|
198
|
+
domains: [04, 05, 06]
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
Maps to `src/domains/04-security.md`, `src/domains/05-dependencies.md`, `src/domains/06-secrets.md`. Domains are shared — the same path works for both Core and Transform agents.
|
|
202
|
+
|
|
203
|
+
### Tool Affinity (Tool IDs)
|
|
204
|
+
|
|
205
|
+
Used in domain files to declare preferred tools:
|
|
206
|
+
|
|
207
|
+
```yaml
|
|
208
|
+
tool_affinities: [semgrep, trivy, syft-grype]
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
References tool IDs defined in `src/tools/{tool-id}.md`.
|
|
212
|
+
|
|
213
|
+
### Transform Cross-References
|
|
214
|
+
|
|
215
|
+
Transform agents reference Core outputs:
|
|
216
|
+
|
|
217
|
+
```markdown
|
|
218
|
+
# In a Transform workflow or agent context:
|
|
219
|
+
@.radar/findings/{agent-id}/finding-NNN.md # Reference specific Core finding
|
|
220
|
+
@.radar/report/findings-by-domain.md # Reference Core synthesis
|
|
221
|
+
@src/domains/04-security.md # Reference shared domain knowledge
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Remediation playbooks reference both findings and domain best practices:
|
|
225
|
+
|
|
226
|
+
```yaml
|
|
227
|
+
# In a Layer B playbook:
|
|
228
|
+
finding_ref: F-04-001 # Core finding being remediated
|
|
229
|
+
domain_ref: domain-04 # Domain providing best-practice context
|
|
230
|
+
intervention_level: planning # Intervention classification
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
Layer C plans reference Layer B evidence:
|
|
234
|
+
|
|
235
|
+
```yaml
|
|
236
|
+
# In a Layer C execution plan:
|
|
237
|
+
playbook_ref: playbook-F-04-001 # Layer B playbook being executed
|
|
238
|
+
risk_assessment_ref: risk-F-04-001 # Change risk assessment
|
|
239
|
+
verification_ref: verify-F-04-001 # Verification plan
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## 5. Naming Conventions
|
|
245
|
+
|
|
246
|
+
| Element | Convention | Examples |
|
|
247
|
+
|---------|-----------|----------|
|
|
248
|
+
| **Files** | kebab-case.md | `security-engineer.md`, `finding.md` |
|
|
249
|
+
| **Directories** | kebab-case | `src/personas/`, `docs/standards/` |
|
|
250
|
+
| **Component IDs** | kebab-case in frontmatter | `id: security-engineer`, `id: domain-04` |
|
|
251
|
+
| **Domain numbering** | DD format (00-13) | `00-context.md`, `04-security.md` |
|
|
252
|
+
| **Domain file naming** | `{DD}-{kebab-name}.md` | `00-context.md`, `13-risk-synthesis.md` |
|
|
253
|
+
| **Persona file naming** | `{kebab-name}.md` | `principal-engineer.md`, `sre.md` |
|
|
254
|
+
| **Agent file naming** | `{kebab-name}.md` (matches persona) | `security-engineer.md` |
|
|
255
|
+
| **Tool file naming** | `{kebab-name}.md` | `semgrep.md`, `syft-grype.md` |
|
|
256
|
+
| **Schema file naming** | `{kebab-name}.md` | `finding.md`, `disagreement.md` |
|
|
257
|
+
| **Rule file naming** | `{kebab-name}.md` | `epistemic-hygiene.md` |
|
|
258
|
+
| **Workflow file naming** | `phase-{N}-{kebab-name}.md` | `phase-0-context.md`, `phase-2-domain-audits.md`, `phase-6-remediation.md` |
|
|
259
|
+
| **Command file naming** | `{kebab-name}.md` | `audit.md`, `resume.md`, `transform.md`, `remediate.md` |
|
|
260
|
+
| **Playbook file naming** | `playbook-{finding-id}.md/yaml` | `playbook-F-04-001.md`, `playbook-F-04-001.yaml` |
|
|
261
|
+
| **Risk assessment naming** | `risk-{finding-id}.yaml` | `risk-F-04-001.yaml` |
|
|
262
|
+
| **Verification plan naming** | `verify-{finding-id}.md` | `verify-F-04-001.md` |
|
|
263
|
+
|
|
264
|
+
**Conventions:**
|
|
265
|
+
|
|
266
|
+
- All filenames use lowercase with hyphens (kebab-case)
|
|
267
|
+
- Component IDs in frontmatter match filename without extension
|
|
268
|
+
- Domains use zero-padded two-digit prefixes (00-13)
|
|
269
|
+
- Workflows use phase number prefix (phase-0, phase-1, etc.)
|
|
270
|
+
- No spaces, underscores, or special characters in filenames
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## 6. Version-Locking
|
|
275
|
+
|
|
276
|
+
### Purpose
|
|
277
|
+
|
|
278
|
+
Forensic-grade traceability and reproducibility. Given the same codebase state and the same MANIFEST.md, the audit results are reproducible.
|
|
279
|
+
|
|
280
|
+
### Mechanism
|
|
281
|
+
|
|
282
|
+
Each audit run creates a `MANIFEST.md` in `.radar/` recording:
|
|
283
|
+
|
|
284
|
+
1. **Audit Metadata:**
|
|
285
|
+
- Audit start timestamp
|
|
286
|
+
- Target repository path and git commit hash
|
|
287
|
+
- Radar version and git commit hash
|
|
288
|
+
|
|
289
|
+
2. **Component Versions Table:**
|
|
290
|
+
|
|
291
|
+
| Component Type | File Path | SHA-256 Hash |
|
|
292
|
+
|---------------|-----------|--------------|
|
|
293
|
+
| Persona | `src/personas/security-engineer.md` | `a1b2c3d4...` |
|
|
294
|
+
| Domain | `src/domains/04-security.md` | `e5f6g7h8...` |
|
|
295
|
+
| Schema | `src/schemas/finding.md` | `i9j0k1l2...` |
|
|
296
|
+
| Rule | `src/rules/epistemic-hygiene.md` | `m3n4o5p6...` |
|
|
297
|
+
| Tool | `src/tools/semgrep.md` | `q7r8s9t0...` |
|
|
298
|
+
| Agent | `src/agents/security-engineer.md` | `u1v2w3x4...` |
|
|
299
|
+
| Workflow | `src/workflows/phase-2-domain-audits.md` | `y5z6a7b8...` |
|
|
300
|
+
|
|
301
|
+
### Lifecycle
|
|
302
|
+
|
|
303
|
+
- **Created:** At audit start (Phase 0 initialization)
|
|
304
|
+
- **Updated:** As each component is loaded and used during execution
|
|
305
|
+
- **Finalized:** At audit completion with final checksums
|
|
306
|
+
- **Archived:** Stored permanently with audit outputs in `.radar/`
|
|
307
|
+
|
|
308
|
+
### Use Cases
|
|
309
|
+
|
|
310
|
+
- **Reproducibility:** Re-run the same audit with the same component versions
|
|
311
|
+
- **Debugging:** Identify which component version caused a specific finding
|
|
312
|
+
- **Compliance:** Provide audit trail for security or regulatory requirements
|
|
313
|
+
- **Regression Testing:** Verify that component changes don't alter audit behavior unexpectedly
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## Design Principles
|
|
318
|
+
|
|
319
|
+
1. **Separation of Concerns:** Identity (personas), knowledge (domains), contracts (schemas), constraints (rules), and execution (workflows) are separate components.
|
|
320
|
+
2. **Composability:** Agents are assembled from reusable components, not monolithic files.
|
|
321
|
+
3. **Traceability:** Every component is versioned and locked at audit runtime.
|
|
322
|
+
4. **Auditability:** Domain knowledge is independently testable and versionable.
|
|
323
|
+
5. **Flexibility:** Components evolve independently on orthogonal axes (personas, domains, tools, schemas).
|
|
324
|
+
6. **Reproducibility:** Same codebase + same manifest = same audit results.
|
|
325
|
+
7. **Two-System Separation:** Diagnosis (Core) and intervention (Transform) have separate personas, agents, and workflows. Shared infrastructure (domains, core schemas, rules, tools) prevents duplication.
|
|
326
|
+
8. **Dual Format Output:** Transform artifacts carry both human-readable markdown and machine-consumable structured data.
|
|
327
|
+
9. **Conservative Intervention:** Transform defaults to the lowest intervention level. Escalation requires evidence, not confidence.
|
|
328
|
+
|
|
329
|
+
---
|
|
330
|
+
|
|
331
|
+
**See Also:**
|
|
332
|
+
|
|
333
|
+
- `README.md` — Source of truth for Radar design philosophy
|
|
334
|
+
- `docs/GETTING-STARTED.md` — Quickstart guide
|
|
335
|
+
- `docs/USER-GUIDE.md` — Command reference and workflows
|
|
336
|
+
- `docs/standards/` — Per-component-type conventions and specifications
|
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
# Getting Started with Radar
|
|
2
|
+
|
|
3
|
+
**From zero to first audit in 10 minutes.**
|
|
4
|
+
|
|
5
|
+
Radar is a multi-agent codebase audit system built on Claude Code. This guide walks you through installation, setup, and running your first audit. For architecture details, see the [README](../README.md).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 1. Prerequisites
|
|
10
|
+
|
|
11
|
+
**Required:**
|
|
12
|
+
|
|
13
|
+
- **Claude Code CLI** — Radar runs as Claude Code slash commands
|
|
14
|
+
```bash
|
|
15
|
+
claude --version # Verify Claude Code is installed
|
|
16
|
+
```
|
|
17
|
+
- **git** — Required for repository analysis and git-history scanning
|
|
18
|
+
|
|
19
|
+
**Optional:**
|
|
20
|
+
|
|
21
|
+
- **Docker** — Only needed if you want a local SonarQube server for code quality analysis. All other tools install without Docker.
|
|
22
|
+
|
|
23
|
+
Radar installs its own analysis tools (Semgrep, Trivy, Gitleaks, Checkov, Syft, Grype). You do not need to pre-install them.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 2. Install Radar
|
|
28
|
+
|
|
29
|
+
**One-command install (recommended):**
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
curl -sSL https://raw.githubusercontent.com/accelerationguy/accelerate/main/modules/radar/install.sh | bash
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Or clone and install locally:**
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
git clone https://github.com/accelerationguy/accelerate.git
|
|
39
|
+
cd accelerate/modules/radar
|
|
40
|
+
bash install.sh
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The installer is interactive. It copies framework files, installs slash commands, then walks you through each analysis tool:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
Radar Installer
|
|
47
|
+
================
|
|
48
|
+
|
|
49
|
+
[1/2] Installing framework files...
|
|
50
|
+
Copied 82 files to ~/.claude/radar/
|
|
51
|
+
Installed 10 commands to ~/.claude/commands/radar/
|
|
52
|
+
|
|
53
|
+
[2/2] Tool installation
|
|
54
|
+
Install Semgrep? (code pattern scanning) [Y/n]: y
|
|
55
|
+
Installing Semgrep via venv... done
|
|
56
|
+
Install Trivy? (vulnerability scanning) [Y/n]: y
|
|
57
|
+
Installing Trivy... done
|
|
58
|
+
...
|
|
59
|
+
|
|
60
|
+
Summary: 7/7 tools installed, 0 skipped
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Re-running the installer is safe — it skips tools already installed and updates framework files.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 3. Verify Installation
|
|
68
|
+
|
|
69
|
+
Open Claude Code and run:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
/radar:validate
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
This tests every installed tool and reports pass/fail:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
Radar VALIDATION REPORT
|
|
79
|
+
========================
|
|
80
|
+
|
|
81
|
+
Framework:
|
|
82
|
+
~/.claude/radar/ 82 files pass
|
|
83
|
+
~/.claude/commands/radar/ 10 commands pass
|
|
84
|
+
|
|
85
|
+
Tools:
|
|
86
|
+
Semgrep pass ~/.local/share/radar/venvs/semgrep/bin/semgrep
|
|
87
|
+
Trivy pass ~/.local/bin/trivy
|
|
88
|
+
Gitleaks pass ~/.local/bin/gitleaks
|
|
89
|
+
Checkov pass ~/.local/share/radar/venvs/checkov/bin/checkov
|
|
90
|
+
Syft pass ~/.local/bin/syft
|
|
91
|
+
Grype pass ~/.local/bin/grype
|
|
92
|
+
SonarQube pass Docker image: sonarsource/sonar-scanner-cli
|
|
93
|
+
Git pass /usr/bin/git
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
If a tool shows "not found":
|
|
97
|
+
- Re-run `bash install.sh` and select Y for that tool
|
|
98
|
+
- Check that `~/.local/bin` is in your PATH
|
|
99
|
+
- For Python tools, check `~/.local/share/radar/venvs/{tool}/bin/`
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## 4. Initialize a Project
|
|
104
|
+
|
|
105
|
+
Navigate to the repository you want to audit, then run:
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
/radar:init
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
This creates the `.radar/` workspace for audit state and findings:
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
Radar Project Initialized
|
|
115
|
+
==========================
|
|
116
|
+
|
|
117
|
+
Target: my-app (/home/user/projects/my-app)
|
|
118
|
+
State: .radar/STATE.md
|
|
119
|
+
Manifest: .radar/MANIFEST.md
|
|
120
|
+
Tools: 7/8 detected
|
|
121
|
+
|
|
122
|
+
.radar/ added to .gitignore
|
|
123
|
+
|
|
124
|
+
Next steps:
|
|
125
|
+
/radar:validate -- verify tool installation
|
|
126
|
+
/radar:audit -- begin diagnostic audit
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Init is separate from auditing — you can init a project now and audit it later. If `.radar/` already exists, you will be offered the choice to resume, start fresh, or cancel.
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 5. Run Your First Audit
|
|
134
|
+
|
|
135
|
+
In the same repository, run:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
/radar:audit
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
The audit wizard walks you through configuration:
|
|
142
|
+
|
|
143
|
+
1. **Scope selection** — Choose Full (recommended for first run), Targeted (specific domains), or Quick (phases 0-2 only)
|
|
144
|
+
2. **Tool selection** — All installed tools enabled by default; toggle any off if needed
|
|
145
|
+
3. **Confirmation** — Review the audit plan and confirm
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
AUDIT PLAN
|
|
149
|
+
===========
|
|
150
|
+
|
|
151
|
+
Target: my-app
|
|
152
|
+
Scope: Full audit
|
|
153
|
+
Phases: 0-5
|
|
154
|
+
Domains: 14 of 14
|
|
155
|
+
Tools: 7 enabled
|
|
156
|
+
Estimated sessions: 8-13
|
|
157
|
+
|
|
158
|
+
[1] Start audit
|
|
159
|
+
[2] Modify scope
|
|
160
|
+
[3] Cancel
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
After confirmation, Phase 0 (Context & Threat Modeling) starts automatically.
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## 6. Multi-Session Workflow
|
|
168
|
+
|
|
169
|
+
Radar audits span multiple Claude Code sessions. A full audit runs through 6 phases:
|
|
170
|
+
|
|
171
|
+
| Phase | Name | Sessions |
|
|
172
|
+
|-------|------|----------|
|
|
173
|
+
| 0 | Context & Threat Modeling | 1 |
|
|
174
|
+
| 1 | Automated Signal Gathering | 1 |
|
|
175
|
+
| 2 | Deep Domain Audits | 1-8 |
|
|
176
|
+
| 3 | Change Risk & Reality Gap | 1-2 |
|
|
177
|
+
| 4 | Adversarial Review | 1 |
|
|
178
|
+
| 5 | Synthesis & Report | 1 |
|
|
179
|
+
|
|
180
|
+
**After each phase completes**, you see a checkpoint:
|
|
181
|
+
|
|
182
|
+
```
|
|
183
|
+
PHASE 1 COMPLETE -- Automated Signal Gathering
|
|
184
|
+
================================================
|
|
185
|
+
|
|
186
|
+
Agents completed: (tools)
|
|
187
|
+
Findings produced: 0
|
|
188
|
+
Signals gathered: 247
|
|
189
|
+
|
|
190
|
+
CUMULATIVE PROGRESS
|
|
191
|
+
[████░░░░░░░░░░░░░░░░] Phase 1 of 5 complete
|
|
192
|
+
|
|
193
|
+
NEXT: Phase 2 -- Deep Domain Audits
|
|
194
|
+
8 domain specialist agents
|
|
195
|
+
Estimated sessions: 1-8
|
|
196
|
+
|
|
197
|
+
[1] Continue to Phase 2 (recommended)
|
|
198
|
+
[2] Pause here -- safe to close this session
|
|
199
|
+
[3] Abort audit -- preserves all work so far
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
**If you pause**, your progress is saved. Come back anytime and run:
|
|
203
|
+
|
|
204
|
+
```
|
|
205
|
+
/radar:resume
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
Resume shows what was completed, findings so far, and picks up at the next phase.
|
|
209
|
+
|
|
210
|
+
**Check progress anytime** (read-only, safe to run mid-audit):
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
/radar:status
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## 7. Viewing Results
|
|
219
|
+
|
|
220
|
+
After Phase 5 completes, generate the final audit report:
|
|
221
|
+
|
|
222
|
+
```
|
|
223
|
+
/radar:report
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
The report is written to `.radar/report/Radar-REPORT.md` — a structured markdown document with:
|
|
227
|
+
- Executive summary
|
|
228
|
+
- Findings by domain and severity
|
|
229
|
+
- Disagreements and their resolutions
|
|
230
|
+
- Risk assessment and recommendations
|
|
231
|
+
|
|
232
|
+
**Optional next steps:**
|
|
233
|
+
|
|
234
|
+
- `/radar:transform` — Start the remediation pipeline (generates fix plans from findings)
|
|
235
|
+
- `/radar:guardrails` — Generate project rules for AI coding assistants based on findings
|
|
236
|
+
|
|
237
|
+
---
|
|
238
|
+
|
|
239
|
+
## 8. Command Reference
|
|
240
|
+
|
|
241
|
+
| Command | Description |
|
|
242
|
+
|---------|-------------|
|
|
243
|
+
| `/radar:audit` | Start a new diagnostic audit (wizard-guided) |
|
|
244
|
+
| `/radar:resume` | Resume a paused audit from last checkpoint |
|
|
245
|
+
| `/radar:status` | View audit progress and findings summary (read-only) |
|
|
246
|
+
| `/radar:report` | Generate the final audit report |
|
|
247
|
+
| `/radar:init` | Initialize Radar in a project (creates .radar/) |
|
|
248
|
+
| `/radar:validate` | Test tool installation and troubleshoot |
|
|
249
|
+
| `/radar:transform` | Start the remediation pipeline on completed audit |
|
|
250
|
+
| `/radar:remediate` | Generate remediation plans for findings |
|
|
251
|
+
| `/radar:playbook` | Create a remediation playbook for a specific finding |
|
|
252
|
+
| `/radar:guardrails` | Generate project rules from audit findings |
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## 9. Troubleshooting
|
|
257
|
+
|
|
258
|
+
**"Tool X not found" during validate**
|
|
259
|
+
- Re-run `bash install.sh` and select Y for that tool
|
|
260
|
+
- For binary tools: check `~/.local/bin` is in your PATH (`echo $PATH`)
|
|
261
|
+
- For Python tools: check the venv exists at `~/.local/share/radar/venvs/{tool}/`
|
|
262
|
+
|
|
263
|
+
**"Permission denied" during install**
|
|
264
|
+
- Radar never requires sudo. All tools install to `~/.local/bin/` or `~/.local/share/radar/`
|
|
265
|
+
- Check file permissions: `ls -la ~/.local/bin/`
|
|
266
|
+
|
|
267
|
+
**"Docker not running" (SonarQube)**
|
|
268
|
+
- Start Docker: `sudo systemctl start docker` or open Docker Desktop
|
|
269
|
+
- SonarQube is optional — all other tools work without Docker
|
|
270
|
+
- Skip SonarQube during install if you don't need code quality metrics
|
|
271
|
+
|
|
272
|
+
**"Context window exceeded" during audit**
|
|
273
|
+
- Audit phases are designed for the 200k token context window
|
|
274
|
+
- If hitting limits: use Targeted audit with fewer domains, or Quick scan (phases 0-2 only)
|
|
275
|
+
- Each agent session is independent — context resets between sessions
|
|
276
|
+
|
|
277
|
+
**".radar/ already exists"**
|
|
278
|
+
- `/radar:init` detects existing state and offers: resume, fresh start (archives old state), or cancel
|
|
279
|
+
- Old state is preserved in `.radar-backup-{timestamp}/` if you choose fresh start
|
|
280
|
+
|
|
281
|
+
**"How do I update Radar?"**
|
|
282
|
+
- Re-run the install script — it overwrites framework files and preserves tool installations
|
|
283
|
+
- Your `.radar/` project state is not affected by framework updates
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
*For architecture details, audit domains, and the epistemic framework, see the [README](../README.md).*
|