67 lines
7.3 KiB
Markdown
67 lines
7.3 KiB
Markdown
# trekplan
|
|
|
|
Voyage — a contract-driven Claude Code pipeline: brief, research, plan, execute, review, continue. Deep implementation planning and research with specialized agent swarms, external research, adversarial review, session decomposition, disciplined execution, and headless support.
|
|
|
|
**Design principle: Context Engineering** — build the right context by orchestrating specialized agents. Each step in the pipeline (brief → research → plan → execute) produces a structured artifact that the next step consumes. The load-bearing benefit is the parallel wall-clock + structured artifact handoffs; main-context relief is asserted-by-design, not measured (Δ ≈ 0 in the one PoC — see `docs/T1-synthesis-poc-results.md`).
|
|
|
|
> **Architecture slot.** The plan command auto-discovers `architecture/overview.md` if present — any compatible producer plugs in (the architect plugin is no longer publicly distributed). Migration history (v3.0.0 extraction) → [CHANGELOG.md](CHANGELOG.md).
|
|
|
|
> **Trinity context (informational).** Voyage is Tier 1 (per-task) of a three-tier architecture. **Asymmetry is a hard invariant:** Voyage stays unaware of Tier 2/3; Handover 1 (brief format) is the only integration point, no producer is privileged, and brief-schema changes are breaking for downstream consumers (formalized as a public contract in v5.5.0). Tier 2/3 producer detail + the public contract → `docs/HANDOVER-CONTRACTS.md` §Handover 1 (PUBLIC CONTRACT).
|
|
|
|
> **Cross-cutting invariant: brief framing must match operator intent.** The brief is the pipeline's source of truth; operator intent lives in memory files — the pipeline must not polish a wrong premise. Enforced as the `brief_version 2.2` gate (v5.5), all BLOCKER for briefs declaring ≥ 2.2: (1) explicit `framing: preserve|refine|replace|new-direction` frontmatter, `AskUserQuestion`-validated in `/trekbrief` Phase 2.5; (2) memory-alignment as `brief-reviewer` dimension 6; (3) mandatory `## TL;DR`. Existing 2.0/2.1 briefs stay valid; `trekreview` briefs are exempt. Full implementation + contract evolution → `docs/HANDOVER-CONTRACTS.md` §Handover 1 (PUBLIC CONTRACT).
|
|
|
|
## Commands
|
|
|
|
| Command | Description | Model |
|
|
|---------|-------------|-------|
|
|
| `/trekbrief` | Brief — interactive interview produces a task brief with explicit research plan; optionally orchestrates the pipeline | opus |
|
|
| `/trekresearch` | Research — deep local + external research, produces structured research brief. Opt-in `--engine {swarm\|deep-research}` delegates the external phase to Claude Code's built-in `/deep-research` workflow (swarm default) | opus |
|
|
| `/trekplan` | Plan — brief-reviewer, explore, plan, review. Requires `--brief` or `--project`. Auto-discovers `architecture/overview.md` if present | opus |
|
|
| `/trekexecute` | Execute — disciplined plan/session-spec executor with failure recovery | opus |
|
|
| `/trekreview` | Review — independent post-hoc review of delivered code against the brief. Produces `review.md` with severity-tagged findings (Handover 6) | opus |
|
|
| `/trekcontinue` | Continue — resumes the next session of a multi-session voyage project. Reads `.session-state.local.json` (Handover 7) and immediately begins executing | opus |
|
|
| `/trekendsession` | End-session — mark the current session complete and write session-state pointing at the next session. Helper for informal multi-session flows | opus |
|
|
|
|
Full flag reference for each command (modes, `--gates`, `--profile`, breaking changes): see `docs/command-modes.md`.
|
|
|
|
## Agents
|
|
|
|
| Agent | Model | Role |
|
|
|-------|-------|------|
|
|
| planning-orchestrator | opus | Inline reference documentation for the planning pipeline workflow (brief-driven) |
|
|
| research-orchestrator | opus | Inline reference documentation for the research pipeline workflow |
|
|
| review-orchestrator | opus | Inline reference documentation for the review pipeline workflow |
|
|
| architecture-mapper | opus | Codebase structure, tech stack, patterns |
|
|
| dependency-tracer | opus | Import chains, data flow, side effects |
|
|
| task-finder | opus | Task-relevant files, functions, reuse candidates |
|
|
| risk-assessor | opus | Risks, edge cases, failure modes |
|
|
| test-strategist | opus | Test patterns, coverage gaps, strategy |
|
|
| git-historian | opus | Recent changes, ownership, hot files |
|
|
| research-scout | opus | External docs for unfamiliar tech (conditional, planning only) |
|
|
| convention-scanner | opus | Coding conventions: naming, style, error handling, test patterns |
|
|
| brief-reviewer | opus | Task brief quality (6 dimensions: completeness, consistency, testability, scope clarity, research plan validity, memory alignment) |
|
|
| brief-conformance-reviewer | opus | Brief conformance review (SC + Non-Goal traceability) |
|
|
| code-correctness-reviewer | opus | Code correctness review (7 dimensions) |
|
|
| review-coordinator | opus | Judge Agent — dedup + reasonableness filter + verdict |
|
|
| plan-critic | opus | Adversarial plan review (10 dimensions) |
|
|
| scope-guardian | opus | Scope alignment (creep + gaps) |
|
|
| session-decomposer | opus | Splits plans into headless sessions with dependency graph |
|
|
| synthesis-agent | opus | Distills Phase-5/7 exploration outputs into a findings digest (NW3 PoC — **dormant**, not wired; delegating Phase 7 alone yields Δ main-context ≈ 0, see `docs/T1-synthesis-poc-results.md`) |
|
|
| docs-researcher | opus | Official documentation, RFCs, vendor docs (Tavily, MS Learn) |
|
|
| community-researcher | opus | Community experience: issues, blogs, discussions |
|
|
| security-researcher | opus | CVEs, audit history, supply chain risks |
|
|
| contrarian-researcher | opus | Counter-evidence, overlooked alternatives |
|
|
| gemini-bridge | opus | Gemini Deep Research second opinion (conditional) |
|
|
|
|
> **Inventory (S33 reconcile).** 24 agent files = **21 spawnable** (one, `synthesis-agent`, ships **dormant** — Δ≈0, wired to nothing) **+ 3 orchestrator reference docs** (`planning-/research-/review-orchestrator` document the inline `/trek*` workflow, not spawnable capabilities). All 24 stay `model: opus` (operator pin `40d8742`); the glue/mechanical/retrieval/dormant roles were reconsidered for a sonnet downgrade and **kept opus** — decision record: `docs/voyage-vs-cc-balance-analysis.md` §10.
|
|
|
|
> **Model & effort.** `opus` = Opus 4.8 (default reasoning effort `high`); `sonnet` = Sonnet 4.6; `fable` = Fable 5 (Mythos-class, above Opus — reasoning effort inherits from the session; xhigh requires a session-level setting). Select agents carry native per-spawn `effort:` (retrieval → `medium`, adversarial-reasoning → `high`) — a different axis from brief `phase_signals.effort` (orchestration shape: which agents/passes run). Per-agent table + axes → `docs/profiles.md` §Model & effort axes.
|
|
|
|
## Reference docs (read on demand)
|
|
|
|
- **Architecture, workflows, project-directory contract, state, terminology:** `docs/architecture.md`
|
|
- **Quality infrastructure (`lib/` validators, parsers, autonomy primitives, hooks):** `docs/architecture.md` §Quality infrastructure
|
|
- **Autonomy gates (`--gates`), Path A/B/C decision:** `docs/operations.md`
|
|
- **Profile system (`--profile economy/balanced/premium/fable`), lookup order, custom profiles:** `docs/operations.md`
|
|
- **Observability (Stop hook, OTLP/textfile export, SSRF mitigation):** `docs/operations.md`
|
|
- **Handover contracts (the 7 pipeline handovers):** `docs/HANDOVER-CONTRACTS.md`
|