codecartographer-pi 0.6.0 → 0.8.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/README.md CHANGED
@@ -3,115 +3,63 @@
3
3
  [![CI](https://github.com/HuginnIndustries/CodeCartographer/actions/workflows/ci.yml/badge.svg)](https://github.com/HuginnIndustries/CodeCartographer/actions/workflows/ci.yml)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
5
5
  [![npm version](https://img.shields.io/npm/v/codecartographer-pi.svg)](https://www.npmjs.com/package/codecartographer-pi)
6
+ [![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](package.json)
6
7
 
7
- A structured reverse-engineering toolkit for understanding unfamiliar codebases using LLMs. Drop it into any repository, point an LLM at the guide, and get a comprehensive analysis: architecture map, behavioral contracts, protocol documentation, defect report, porting synthesis, and reimplementation spec.
8
+ > **A structured pipeline for reverse-engineering unfamiliar codebases with an LLM.** Drop it into any repo, point an LLM at the guide, and walk away with a layered analysis: architecture map, behavioral contracts, protocol documentation, defect report, porting bundle, and a language-agnostic reimplementation spec. Every finding is evidence-tagged. Every phase output is validated before the next one starts.
8
9
 
9
- ## What It Does
10
-
11
- CodeCartographer guides an LLM through a phased analysis of your source code, producing structured documentation at each step. Instead of asking an LLM "explain this codebase" and getting a vague summary, you get a systematic evaluation with evidence-tagged findings, validated outputs, and cross-session continuity.
12
-
13
- Each phase builds on the last. The architecture map feeds into behavioral contracts, which feed into protocol documentation, which feeds into a porting bundle, which feeds into a reimplementation spec. At the end, you have a complete evaluation bundle that a human or another LLM can use to understand, maintain, or rewrite the codebase.
14
-
15
- ## Quick Start
16
-
17
- **1. Copy `.codecarto/` into your repository:**
18
-
19
- ```bash
20
- cp -r /path/to/CodeCartographer/.codecarto /path/to/your-repo/
10
+ ```text
11
+ ● CodeCartographer
12
+ ├─ ✓ architecture phase ⟳ 25 · 76 tool uses · 1.0M tokens · 4m28s
13
+ ├─ ✓ defect-scan-mech. ⟳ 39 · 91 tool uses · 2.4M tokens · 7m05s
14
+ └─ contracts phase ⟳ 11 · 37 tool uses · 335.1k tokens · 40.1s
15
+ ⎿ extracting behavioral contracts from server/index.ts…
21
16
  ```
22
17
 
23
- **2. Choose a pipeline** (optional — defaults to the full 7-phase with split defect scan):
18
+ ---
24
19
 
25
- ```yaml
26
- # Edit .codecarto/workflow/status.yaml and set the pipeline field:
27
- pipeline: workflow/pipeline-full-with-deep-audit.yaml # 7-phase with split defect scan (default; depth-first)
28
- pipeline: workflow/pipeline-full-with-audit.yaml # 6-phase with single early defect scan
29
- pipeline: workflow/pipeline.yaml # 5-phase without defect scan — remove defect-scan phases
30
- pipeline: workflow/pipeline-defect-scan.yaml # 2-phase defect audit — remove contracts through reimplementation-spec
31
- pipeline: workflow/pipeline-lite.yaml # 3-phase understanding — remove defect-scan phases, porting, and reimplementation-spec
32
- pipeline: workflow/pipeline-architecture-only.yaml # 1-phase quick overview — keep only architecture
33
- ```
20
+ ## At a glance
34
21
 
35
- **3. Point an LLM at the guide:**
22
+ | What you get | Where it lives |
23
+ |---|---|
24
+ | **Layered analysis pipeline** — architecture → defect scan → behavioral contracts → protocols → porting → reimplementation spec | `.codecarto/` template |
25
+ | **Validation gates between phases** — no advancing past a `FAIL` output | `core/` state machine |
26
+ | **Three delivery surfaces** — Pi extension, MCP server, or pure template | All three share `core/` |
27
+ | **Live progress widget** while phase sub-agents work | Pi extension |
28
+ | **HTML dashboard** — single-file aggregate of progress, links, usage, narrative | `.codecarto/dashboard.html` |
29
+ | **Per-phase token tracking** | `/codecarto-usage` |
30
+ | **Opt-in LLM steering** of the next phase's seed prompt | `/codecarto-next --llm-steer` |
36
31
 
37
- ```
38
- Read .codecarto/GUIDE.md and begin the analysis.
39
- ```
32
+ ---
40
33
 
41
- That's it. The LLM reads the guide, checks `workflow/status.yaml` for progress, and starts the next phase automatically. Each phase produces a validated output in `.codecarto/findings/`.
34
+ ## Install
42
35
 
43
- ## Pi Package
36
+ Pick the surface that matches your tooling. All three share the same `core/` and produce byte-identical phase prompts.
44
37
 
45
- This branch also packages CodeCartographer for [Pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) without changing `.codecarto/` itself. Pi is an **optional peer dependency** — if you only want the template or the MCP server, you don't need Pi installed.
38
+ ### Pi extension (recommended for interactive use)
46
39
 
47
- Install from npm, a local checkout, or a git URL:
40
+ [Pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) is a TUI coding agent. The CodeCartographer extension adds slash commands, a live agents widget, and the dashboard.
48
41
 
49
42
  ```bash
50
- pi install npm:codecartographer-pi
51
- # or, from a local checkout:
52
- pi install /absolute/path/to/CodeCartographer
53
- # or, from a git URL:
54
- pi install git:github.com/your-user/CodeCartographer
43
+ pi install npm:codecartographer-pi # from the npm registry
44
+ pi install /absolute/path/to/CodeCartographer # from a local checkout
45
+ pi install git:github.com/your-user/CodeCartographer # from a git URL
55
46
  ```
56
47
 
57
- > **Don't run `npm install codecartographer-pi` for the Pi use case.** Plain `npm install` puts the package on disk but doesn't register it with Pi, so it never appears in the TUI. Use `pi install npm:codecartographer-pi` instead Pi handles the npm install internally and writes the package into its own `settings.json` (`~/.pi/agent/settings.json` by default). Plain `npm install` is the right command only for the MCP-server use case described below.
48
+ > **Don't** run `npm install codecartographer-pi` for the Pi use case. Plain `npm install` puts the package on disk but doesn't register it with Pi. Use `pi install npm:...` so Pi writes the package into its own `~/.pi/agent/settings.json`.
58
49
 
59
- For extension development, you can also point Pi directly at the extension entrypoint or place it in an auto-discovered extensions directory and use `/reload`:
50
+ For extension development, point Pi directly at the entrypoint:
60
51
 
61
52
  ```bash
62
53
  pi -e /absolute/path/to/CodeCartographer/extensions/codecarto/index.ts
63
54
  ```
64
55
 
65
- The extension is self-contained at runtime. It uses only Node built-ins plus Pi's peer dependencies, so direct loading and `/reload` do not require a separate `npm install`.
66
-
67
- Then in the target repository:
68
-
69
- ```text
70
- /codecarto-init [full-with-deep-audit|full-with-audit|full|defect-scan|lite|architecture-only]
71
- /codecarto-status
72
- /codecarto-next
73
- ```
74
-
75
- If you install the whole repository as a Pi package, Pi may still run package installation steps for the package itself, but the CodeCartographer extension does not depend on any third-party runtime modules.
76
-
77
- What the Pi extension adds:
78
-
79
- - `/codecarto-init` to copy `.codecarto/` into the current repository
80
- - `/codecarto-next` to queue the next eligible phase prompt (or, in sub-agent mode, spawn the phase as a child session)
81
- - `/codecarto-status` to show current phase progress
82
- - `/codecarto-validate` and `/codecarto-complete` for validation-gated status updates
83
- - a footer/widget showing the active CodeCartographer phase
84
- - tool interception that blocks `edit` and `write` outside `.codecarto/`
85
- - direct phase prompts that tell Pi exactly which `.codecarto/findings/<phase>/SKILL.md` file to read, without registering those internal files as global Pi skills
86
-
87
- ### Phase sub-agents (0.2.0+)
88
-
89
- `/codecarto-next` runs each phase as an isolated in-memory `AgentSession` while your TUI stays on the orchestrator session. The phase's tool calls, file reads, and reasoning live in the child's own context window — they never accumulate in the orchestrator. A persistent **Agents** widget appears above the editor while a phase is running, showing live tool count, token usage, elapsed time, and the current activity. The widget auto-clears once the phase finishes (and lingers a few seconds after for visibility).
90
-
91
- ```
92
- ● CodeCartographer
93
- └─ ⠹ architecture phase ⟳3 · 5 tool uses · 12.3k tokens · 1m32s
94
- ⎿ reading…
95
- ```
96
-
97
- Versions 0.1.3 – 0.1.4 used a different design — a session-switching pattern via `ctx.newSession()` that flipped the TUI to the child. That delivered context isolation but the switch was visually invisible during normal flow, so 0.2.0 replaced it with the parallel-widget approach. 0.1.x workspaces don't need migration; existing `.codecarto/` directories work with 0.2.0 unchanged.
98
-
99
- The MCP-server path is unaffected — it has no session concept; the host (Claude Desktop / Claude Code / etc.) is always the orchestrator.
100
-
101
- ## MCP Server
102
-
103
- The same framework is also packaged as a [Model Context Protocol](https://modelcontextprotocol.io) server, so any MCP-compatible host (Claude Code, Claude Desktop, etc.) can drive a CodeCartographer workflow without the Pi runtime. The server imports the same `core/` primitives the Pi extension uses, so phase prompts and validation are byte-identical across both surfaces.
104
-
105
- Implements MCP spec revision [`2025-11-25`](https://modelcontextprotocol.io/specification/2025-11-25) via `@modelcontextprotocol/sdk` ≥ 1.29.0. The negotiated `protocolVersion` reflects whatever the connecting client requests; the server accepts every revision the SDK supports (currently `2025-11-25`, `2025-06-18`, `2025-03-26`, `2024-11-05`, `2024-10-07`).
106
-
107
- Install and wire it up:
56
+ ### MCP server (for Claude Code, Claude Desktop, any MCP host)
108
57
 
109
58
  ```bash
110
59
  npm install --global codecartographer-pi
111
- # or, in a project: npm install codecartographer-pi
112
60
  ```
113
61
 
114
- Add it to your MCP host config (Claude Code: `~/.config/claude-code/config.json`, Claude Desktop: `claude_desktop_config.json`):
62
+ Add to your host config (`~/.config/claude-code/config.json`, `claude_desktop_config.json`, etc.):
115
63
 
116
64
  ```json
117
65
  {
@@ -123,67 +71,186 @@ Add it to your MCP host config (Claude Code: `~/.config/claude-code/config.json`
123
71
  }
124
72
  ```
125
73
 
126
- The server exposes seven tools, each accepting an absolute `cwd` for the target repository:
74
+ ### Pure template (no runtime, any LLM that reads/writes files)
127
75
 
128
- | Tool | Purpose | Pi equivalent |
129
- |---|---|---|
130
- | `codecarto_init` | Copy `.codecarto/` into the target repo and select a pipeline | `/codecarto-init` |
131
- | `codecarto_status` | Current phase, active pipeline, progress, open questions | `/codecarto-status` |
132
- | `codecarto_next` | Return the next eligible phase prompt as text | `/codecarto-next` |
133
- | `codecarto_phase` | Return a specific phase's prompt (forced, even out of order) | `/codecarto-phase` |
134
- | `codecarto_validate` | Validate a phase output, returning structured criteria rows | `/codecarto-validate` |
135
- | `codecarto_complete` | Atomically mark a phase complete after validation passes | `/codecarto-complete` |
136
- | `codecarto_skill` | Return a post-pipeline skill prompt | `/codecarto-skill` |
76
+ ```bash
77
+ cp -r /path/to/CodeCartographer/.codecarto /path/to/your-repo/
78
+ ```
79
+
80
+ Then in the LLM session: `Read .codecarto/GUIDE.md and begin the analysis.`
81
+
82
+ ---
83
+
84
+ ## How it works
85
+
86
+ The "code" is structured Markdown + YAML inside `.codecarto/`:
87
+
88
+ - **`GUIDE.md`** — LLM entry point. Every session reads this first.
89
+ - **`workflow/pipeline.yaml`** — phase definitions, dependencies, output paths.
90
+ - **`workflow/status.yaml`** — mutable per-project state. Single source of truth for progress.
91
+ - **`workflow/VALIDATE.md`** — validation protocol run after every phase.
92
+ - **`findings/<phase>/SKILL.md`** — detailed analysis instructions per phase.
93
+ - **`templates/`** — output templates that enforce consistent structure.
94
+
95
+ Phases form a DAG: `contracts` and `protocols` can run in parallel after `architecture`; `porting` waits for both; `reimplementation-spec` is last. The host (Pi, MCP, or your shell) reads the active pipeline, finds the next phase whose dependencies are all `complete`, hands the LLM that phase's instructions, validates the output, and advances `status.yaml`.
96
+
97
+ For multi-session work, every new session reads `.codecarto/GUIDE.md` (or the lighter `NEW_THREAD_BLURB.md`), checks `workflow/status.yaml`, and picks up where the last session left off. You don't explain what happened in previous sessions.
137
98
 
138
- `codecarto_init` requires `force: true` to overwrite an existing `.codecarto/` (instead of Pi's interactive confirmation).
99
+ ---
139
100
 
140
- ## What It Produces
101
+ ## Phases produce these artifacts
141
102
 
142
103
  | Artifact | Description |
143
104
  |---|---|
144
- | Architecture map | Layers, dependency direction, public surfaces, runtime lifecycle, concurrency model |
145
- | Defect report | Multi-pass scan for logic errors, security issues, concurrency bugs, API violations |
146
- | Defect fix tracker | Remediation log mapping each fix, deferral, or acceptance back to the defect report |
147
- | Behavioral contracts | Feature-by-feature behavior with defaults, error handling, and acceptance tests |
148
- | Protocols and state | Event flows, state machines, persistence formats, compatibility hazards |
149
- | Porting bundle | Everything synthesized into a porting-oriented view with priority rankings |
150
- | Reimplementation spec | Language-agnostic build plan with modules, acceptance scenarios, and known unknowns |
105
+ | **Architecture map** | Layers, dependency direction, public surfaces, runtime lifecycle, concurrency model |
106
+ | **Defect report** | Multi-pass scan for logic errors, security issues, concurrency bugs, API violations |
107
+ | **Defect fix tracker** | Remediation log mapping each fix, deferral, or acceptance back to the defect report |
108
+ | **Behavioral contracts** | Feature-by-feature behavior with defaults, error handling, and acceptance tests |
109
+ | **Protocols and state** | Event flows, state machines, persistence formats, compatibility hazards |
110
+ | **Porting bundle** | Everything synthesized into a porting-oriented view with priority rankings |
111
+ | **Reimplementation spec** | Language-agnostic build plan with modules, acceptance scenarios, and known unknowns |
151
112
 
152
- Every finding is tagged with an evidence level: **observed fact**, **strong inference**, **portability hazard**, or **open question**. Every phase output is validated against explicit completion criteria before the pipeline advances.
113
+ Every finding is tagged with an evidence level: `observed fact`, `strong inference`, `portability hazard`, or `open question`. Every phase output is validated against explicit completion criteria before the pipeline advances.
153
114
 
154
- ## Pipeline Variants
115
+ ---
155
116
 
156
- Not every project needs the full analysis. The default is the 7-phase **full-with-deep-audit** pipeline, which splits the defect scan into an early mechanical pass and a deep semantic pass so the reimplementation can design around defects with full contracts and protocols context. Scale back if you want less, or use the legacy single-scan pipeline if you don't need the deeper context-grounded defect findings:
117
+ ## Pipeline variants
118
+
119
+ The default is a 7-phase run that splits the defect scan into a mechanical early pass and a semantic late pass — the reimplementation phase then designs around defects with full contracts and protocols context. Scale back if you want less:
157
120
 
158
121
  | Variant | Phases | Use when |
159
122
  |---|---|---|
160
123
  | **Full with deep audit** (default) | 7 | Complete analysis with split defect scan; reimplementation grounded in contracts/protocols-aware defect findings |
161
- | **Full with audit** | 6 | Single early defect scan; cheaper than the deep variant when the defects are mostly mechanical |
124
+ | **Full with audit** | 6 | Single early defect scan; cheaper than the deep variant when defects are mostly mechanical |
162
125
  | **Full** | 5 | Porting or reimplementation without any defect scan |
163
126
  | **Defect scan** | 2 | Maintenance audit to surface latent problems |
164
127
  | **Lite** | 3 | You need to understand behavior without porting plans |
165
128
  | **Architecture only** | 1 | Quick structural overview |
166
129
 
167
- ## Compatible Environments
130
+ Set the active pipeline by editing `workflow/status.yaml`'s `pipeline:` field, or pass it as the argument to `/codecarto-init`.
131
+
132
+ **On disk:**
133
+
134
+ | Variant | Pipeline file |
135
+ |---|---|
136
+ | Full with deep audit (**default**) | `workflow/pipeline-full-with-deep-audit.yaml` |
137
+ | Full with audit | `workflow/pipeline-full-with-audit.yaml` |
138
+ | Full | `workflow/pipeline.yaml` |
139
+ | Defect scan | `workflow/pipeline-defect-scan.yaml` |
140
+ | Lite | `workflow/pipeline-lite.yaml` |
141
+ | Architecture only | `workflow/pipeline-architecture-only.yaml` |
142
+
143
+ ---
144
+
145
+ ## The dashboard
146
+
147
+ Every state change re-renders `.codecarto/dashboard.html` — a self-contained single-file artifact you open in any browser. Aggregates everything a human wants to see at a glance:
148
+
149
+ - Pipeline progress strip with per-phase status badges
150
+ - Per-phase cards with output links, open questions, carry-forward routing, owner notes, last-run usage
151
+ - Aggregate token usage panel + per-phase breakdown
152
+ - Activity timeline with session-file links
153
+ - Open questions roll-up grouped by source phase
154
+ - Closeouts list (reverse-chronological) with relative-path links
155
+
156
+ No JavaScript. No external assets. Light/dark via `prefers-color-scheme`. Works opened directly from `file://`.
157
+
158
+ **Opt-in narrative summary.** `/codecarto-dashboard --narrate` runs the orchestrator's model as a one-shot session that writes a 200–400 word executive summary citing specific findings from recent closeouts. Cached to `.codecarto/.dashboard-narration.local.md` and preserved across deterministic re-renders with a "(N runs since)" staleness note.
168
159
 
169
- CodeCartographer works with any LLM that can read and write files:
160
+ ---
161
+
162
+ ## Pi extension features
163
+
164
+ Beyond the slash commands, the Pi extension layers on:
165
+
166
+ **Phase sub-agents.** `/codecarto-next` spawns each phase as an isolated `AgentSession`. Tool calls, file reads, and reasoning live in the child's own context window — they never accumulate in the orchestrator. Your TUI stays on the orchestrator session and remains responsive while phases work in background.
167
+
168
+ **Live agents widget** above the editor showing tool count, token usage, elapsed time, and current activity.
169
+
170
+ ```text
171
+ ● CodeCartographer
172
+ └─ ⠹ architecture phase ⟳ 3 · 5 tool uses · 12.3k tokens · 1m32s
173
+ ⎿ reading…
174
+ ```
175
+
176
+ **File-backed phase sessions.** Phase transcripts persist to the same Pi session directory the orchestrator uses, so `/resume`, `/tree`, and `/export` browse them as first-class sessions. Each appears as `CodeCartographer phase: <id>` with lineage back to the orchestrator's session.
177
+
178
+ **Phase-completion summary in the orchestrator transcript.** When a phase finishes, a Markdown closeout block is appended to the orchestrator's session via `pi.sendMessage(...)`. Visible in the TUI scrollback; available to the orchestrator's LLM as context on your next message. No auto-trigger — you stay in control.
179
+
180
+ **Opt-in LLM-steered seed prompts.** Set `orchestrator.llm_steer_next_phase: true` in `.codecarto/workflow/config.yaml` (or pass `--llm-steer` per invocation), and the orchestrator's LLM rewrites the next phase's seed prompt to highlight relevant prior findings. Off by default — extra orchestrator-side tokens, opt-in. The rewritten prompt is injected into the orchestrator transcript so you can audit what the rewriter chose to emphasize.
181
+
182
+ **Per-phase usage tracking.** Each phase run is appended to `.codecarto/workflow/.usage.local.yaml`. `/codecarto-usage` reports cumulative + per-phase totals.
183
+
184
+ **Tool interception.** `bash` is blocked outright; `edit` and `write` are confined to `.codecarto/`. Same rules apply to phase sub-agents.
185
+
186
+ ### Slash commands
187
+
188
+ | Command | Purpose |
189
+ |---|---|
190
+ | `/codecarto-init [variant]` | Copy `.codecarto/` into the current repository, select pipeline variant |
191
+ | `/codecarto-status` | Current phase, progress, open questions |
192
+ | `/codecarto-next [--auto [--strict]] [--llm-steer \| --no-llm-steer]` | Spawn the next eligible phase as a sub-agent. `--auto` walks the full pipeline end-to-end (auto-validate + auto-complete + advance); `--strict` flips the `PASS WITH GAPS` rule from "advance" to "pause". |
193
+ | `/codecarto-phase <id>` | Force a specific phase, even out of pipeline order |
194
+ | `/codecarto-validate [phase]` | Validate a phase output against completion criteria |
195
+ | `/codecarto-complete [phase]` | Atomically mark a phase complete (validation must pass) |
196
+ | `/codecarto-skill <name>` | Run a post-pipeline skill once all phases are complete |
197
+ | `/codecarto-usage` | Cumulative + per-phase token usage |
198
+ | `/codecarto-dashboard [--narrate]` | Regenerate `.codecarto/dashboard.html`; `--narrate` for the LLM executive summary |
199
+
200
+ ### End-to-end auto mode (0.8.0+)
201
+
202
+ `/codecarto-next --auto` walks the entire pipeline without intervention. The loop spawns each next-eligible phase, auto-validates the output, auto-marks it complete, and advances until the pipeline finishes — or until something stops it (`FAIL` / `MISSING` validation, sub-agent error, or `ctx.signal` abort). The orchestrator's TUI stays responsive throughout; per-phase summaries land in the transcript as usual, and a final `codecarto-auto-summary` block reports the outcome with cumulative tokens, wall time, and a recovery hint if the run stopped early.
203
+
204
+ - **Resumability** is implicit: re-running `--auto` reads `status.yaml` and picks up from `getNextEligiblePhase`.
205
+ - **`--strict`** (requires `--auto`) treats `PASS WITH GAPS` as a stop — useful when you want to triage gaps before advancing.
206
+ - **`--auto --llm-steer`** runs the rewriter on every phase transition; the per-phase steering blocks land in the orchestrator transcript so the run is auditable.
207
+
208
+ ### Version history (Pi orchestration)
209
+
210
+ The current parallel-sub-agent design landed in 0.2.0 and has been incrementally enriched: file-backed sessions (0.3.0), summary injection (0.4.0), opt-in LLM steering (0.5.0), usage tracking (0.6.0), HTML dashboard (0.7.0), and end-to-end auto mode (0.8.0). 0.1.x workspaces don't need migration — existing `.codecarto/` directories work unchanged. See `CHANGELOG.md` for details.
211
+
212
+ ---
213
+
214
+ ## MCP server
215
+
216
+ The same framework is packaged as a [Model Context Protocol](https://modelcontextprotocol.io) server. The MCP path returns prompt text for the host to dispatch and never runs sub-agents itself, so the Pi-only orchestration features (sub-agents, live widget, dashboard, usage tracking) don't apply — but phase prompts and validation are byte-identical with the Pi path because both import the same `core/`.
217
+
218
+ Implements MCP spec revision [`2025-11-25`](https://modelcontextprotocol.io/specification/2025-11-25) via `@modelcontextprotocol/sdk` ≥ 1.29.0. The negotiated `protocolVersion` reflects whatever the connecting client requests; the server accepts every revision the SDK supports (currently `2025-11-25`, `2025-06-18`, `2025-03-26`, `2024-11-05`, `2024-10-07`).
219
+
220
+ | Tool | Pi equivalent |
221
+ |---|---|
222
+ | `codecarto_init` | `/codecarto-init` |
223
+ | `codecarto_status` | `/codecarto-status` |
224
+ | `codecarto_next` | `/codecarto-next` |
225
+ | `codecarto_phase` | `/codecarto-phase` |
226
+ | `codecarto_validate` | `/codecarto-validate` |
227
+ | `codecarto_complete` | `/codecarto-complete` |
228
+ | `codecarto_skill` | `/codecarto-skill` |
229
+
230
+ Each tool accepts an absolute `cwd` for the target repository. `codecarto_init` requires `force: true` to overwrite an existing `.codecarto/` (instead of Pi's interactive confirmation).
231
+
232
+ ---
233
+
234
+ ## Compatible environments
170
235
 
171
236
  | Environment | Notes |
172
237
  |---|---|
173
- | **Claude Code** | Point it at `.codecarto/GUIDE.md`. Works out of the box. |
174
- | **OpenCode** | Same as Claude Code file read/write is built in. |
175
- | **Cursor / Windsurf / IDE copilots** | Open the repo. Point the LLM at `.codecarto/GUIDE.md` in chat. |
176
- | **Aider** | Run from the repo root. |
238
+ | **Pi** | Native install the extension, get slash commands + widget + dashboard. |
239
+ | **Claude Code** | MCP server, or point it at `.codecarto/GUIDE.md` directly. |
240
+ | **Claude Desktop** | MCP server. |
241
+ | **OpenCode / Aider / Cursor / Windsurf / IDE copilots** | Open the repo, point the LLM at `.codecarto/GUIDE.md`. |
177
242
  | **Claude.ai / ChatGPT (web chat)** | Paste file contents manually. Tedious for multi-phase runs. |
178
243
  | **API-based agents** | Load files programmatically, pass to the model, write outputs back. |
179
244
 
180
- ## Token Usage and Cost
245
+ ---
181
246
 
182
- CodeCartographer is token-intensive. It reads your source code multiple times across phases and produces thousands of words of structured output. Here's what to expect:
247
+ ## Token usage and cost
183
248
 
184
- ### Template Overhead (Fixed Cost)
249
+ CodeCartographer is token-intensive it reads source code multiple times across phases and produces thousands of words of structured output. Plan accordingly.
185
250
 
186
- Every session reads the guide, pipeline definition, status file, and validation protocol. On top of that, each phase reads its own SKILL.md and output template. This overhead is fixed regardless of codebase size:
251
+ ### Template overhead (fixed cost)
252
+
253
+ Every session reads the guide, pipeline definition, status, and validation protocol. Each phase additionally reads its own `SKILL.md` and output template. Fixed regardless of codebase size:
187
254
 
188
255
  | Component | Tokens (input) |
189
256
  |---|---|
@@ -194,17 +261,16 @@ Every session reads the guide, pipeline definition, status file, and validation
194
261
  | Protocols phase instructions | ~1,200 |
195
262
  | Porting phase instructions | ~1,200 |
196
263
  | Reimplementation spec phase instructions | ~1,100 |
197
- | **Total template overhead for a 6-phase run** | **~27,000** |
198
-
199
- ### Source Code Reading (Variable Cost)
264
+ | **Total template overhead, 6-phase run** | **~27,000** |
265
+ | **Total template overhead, 7-phase deep-audit** | **~32,000** (split defect scan adds one more SKILL load) |
200
266
 
201
- This is the dominant cost. Each phase reads some or all of your source code. The architecture phase reads the most (full structural scan); later phases are more targeted but also read prior findings.
267
+ ### Source code reading (variable cost)
202
268
 
203
- Rough guide: **expect to read 1-3x your codebase size in tokens per phase**. A 50k-token codebase might consume 100-200k input tokens across a full pipeline run.
269
+ The dominant cost. Each phase reads some or all of your source code; the architecture phase reads the most. Rough guide: **expect 1–3× your codebase size in tokens per phase**. A 50k-token codebase might consume 100200k input tokens across a full pipeline run.
204
270
 
205
- ### Output Generation
271
+ ### Output generation
206
272
 
207
- Each phase produces a structured findings document. From a real 6-phase run (CodeCartographer analyzing itself — a small ~14k-word template):
273
+ From a real 6-phase run (CodeCartographer analyzing itself — a small ~14k-word template):
208
274
 
209
275
  | Phase | Output size |
210
276
  |---|---|
@@ -218,36 +284,40 @@ Each phase produces a structured findings document. From a real 6-phase run (Cod
218
284
 
219
285
  Larger codebases produce proportionally larger outputs.
220
286
 
221
- ### Cost Estimates
287
+ ### Cost estimates
222
288
 
223
289
  For a medium-sized codebase (~100k tokens of source):
224
290
 
225
- | Pipeline | Estimated Input | Estimated Output | Total |
291
+ | Pipeline | Estimated input | Estimated output | Total |
226
292
  |---|---|---|---|
227
293
  | Architecture only | ~130k | ~5k | ~135k tokens |
228
294
  | Defect scan (2-phase) | ~260k | ~10k | ~270k tokens |
229
295
  | Lite (3-phase) | ~370k | ~15k | ~385k tokens |
230
296
  | Full (5-phase) | ~570k | ~22k | ~592k tokens |
231
297
  | Full with audit (6-phase) | ~700k | ~27k | ~727k tokens |
298
+ | Full with deep audit (7-phase, default) | ~830k | ~32k | ~862k tokens |
232
299
 
233
- At current API pricing (~$3/M input, ~$15/M output for Claude Sonnet), a full 5-phase run on a 100k-token codebase costs roughly **$2-4**. Larger codebases scale linearly.
300
+ At current API pricing (~$3/M input, ~$15/M output for Claude Sonnet), a full 5-phase run on a 100k-token codebase costs roughly **$24**. Larger codebases scale linearly.
234
301
 
235
- ### Tips to Reduce Token Usage
302
+ ### Tips to reduce token usage
236
303
 
237
- - **Start with architecture-only** to see if the output quality is useful before committing to a full run.
238
- - **Use one session per phase** — each phase gets a fresh context window, so you're not paying to carry stale context.
239
- - **For very large codebases** (500k+ tokens of source), the LLM can't read everything anyway. It will use the architecture map to prioritize and produce partial results. Check `open_questions` in status.yaml to see what it skipped.
240
- - **The lite pipeline (3 phases) gives 80% of the value** for understanding a codebase without the porting-specific phases.
304
+ - **Start with `architecture-only`** to see if the output quality is useful before committing to a full run.
305
+ - **One LLM session per phase** — each phase gets a fresh context window so you're not paying to carry stale context.
306
+ - **For very large codebases** (500k+ tokens of source), the LLM can't read everything anyway. It uses the architecture map to prioritize and produces partial results. `open_questions` in `status.yaml` shows what was skipped.
307
+ - **The `lite` pipeline (3 phases) gives 80% of the value** for understanding a codebase without porting-specific phases.
308
+ - **Skip `--llm-steer`** unless you're hitting cross-phase coherence issues — the rewriter costs orchestrator-side tokens per phase.
241
309
 
242
- ## Model Compatibility
310
+ ---
243
311
 
244
- CodeCartographer is LLM-agnostic by design, but model choice affects both what you can analyze and how good the results are. There are two independent constraints: context window size and model capability.
312
+ ## Model compatibility
245
313
 
246
- ### Context Window
314
+ LLM-agnostic by design, but model choice affects both what you can analyze and how good the results are. Two independent constraints: **context window size** and **model capability**.
247
315
 
248
- Each phase runs in its own session, so the context window limits how much source code can be read per phase — not across the whole pipeline. After subtracting template overhead, prior-phase findings, and output generation, here's how much room remains for reading source code:
316
+ ### Context window
249
317
 
250
- | Phase | Available for Source Code (128k model) | Available (200k model) |
318
+ Each phase runs in its own session, so the context window limits how much source code can be read per phase — not across the whole pipeline. After template overhead, prior-phase findings, and output generation:
319
+
320
+ | Phase | Available for source (128k model) | Available (200k model) |
251
321
  |---|---|---|
252
322
  | Architecture | ~121k | ~193k |
253
323
  | Defect scan | ~115k | ~187k |
@@ -256,79 +326,40 @@ Each phase runs in its own session, so the context window limits how much source
256
326
  | Porting | ~104k | ~176k |
257
327
  | Reimplementation spec | ~103k | ~175k |
258
328
 
259
- Since each phase reads 1–3x the codebase, practical limits by context window:
329
+ Practical limits by codebase size:
260
330
 
261
- | Codebase Size | 128k Context | 200k Context |
331
+ | Codebase | 128k context | 200k context |
262
332
  |---|---|---|
263
333
  | <30k tokens | All phases comfortable | All phases comfortable |
264
- | 30–60k tokens | Feasible, some PARTIAL results | Comfortable |
265
- | 60–100k tokens | Marginal — heavy PARTIAL use | Feasible with prioritization |
266
- | >100k tokens | Not viable | Feasible, later phases may PARTIAL |
334
+ | 30–60k tokens | Feasible, some `PARTIAL` results | Comfortable |
335
+ | 60–100k tokens | Marginal — heavy `PARTIAL` use | Feasible with prioritization |
336
+ | >100k tokens | Not viable | Feasible, later phases may `PARTIAL` |
267
337
 
268
- The pipeline handles context exhaustion gracefully: phases can write `PARTIAL` validation and log remaining work in `open_questions` in status.yaml.
338
+ The pipeline handles context exhaustion gracefully: phases write `PARTIAL` validation and log remaining work in `open_questions`.
269
339
 
270
- ### Model Capability
340
+ ### Model capability
271
341
 
272
- Context window is the easier problem. The harder constraint is whether the model can handle the cognitive demands of each phase. The tasks that degrade fastest on weaker models:
342
+ The harder constraint. Tasks that degrade fastest on weaker models:
273
343
 
274
- 1. **Evidence classification** (high risk) — distinguishing `observed fact` from `strong inference` from `open question` requires calibrated self-awareness about certainty. Weaker models tend to over-classify inferences as facts and skip `open question` tagging.
275
- 2. **Defect scan** (high risk) — the 6-pass scan demands domain-specific reasoning (concurrency, security, API contracts). Weaker models produce more false positives, miss subtle bugs, and over-report style issues as defects.
276
- 3. **Architecture synthesis** (medium-high risk) — abstracting a coherent layer map from many files is high-order reasoning. Weaker models produce flatter, shallower descriptions with poor dependency direction analysis.
344
+ 1. **Evidence classification** (high risk) — distinguishing `observed fact` from `strong inference` from `open question` requires calibrated self-awareness about certainty. Weaker models over-classify inferences as facts and skip `open question` tagging.
345
+ 2. **Defect scan** (high risk) — the multi-pass scan demands domain-specific reasoning (concurrency, security, API contracts). Weaker models produce more false positives, miss subtle bugs, and over-report style issues as defects.
346
+ 3. **Architecture synthesis** (medium-high risk) — abstracting a coherent layer map from many files is high-order reasoning.
277
347
  4. **Structured output adherence** (medium risk) — filling templates correctly with all required sections and consistent formatting.
278
- 5. **Cross-phase coherence** (medium risk) — later phases build on earlier findings. Weak architecture output compounds errors downstream.
348
+ 5. **Cross-phase coherence** (medium risk) — later phases build on earlier findings. Weak architecture compounds errors downstream.
279
349
 
280
- ### Recommended Model Tiers
350
+ ### Recommended model tiers
281
351
 
282
- | Model Tier | Examples | Recommended Pipeline | Notes |
352
+ | Tier | Examples | Recommended pipeline | Notes |
283
353
  |---|---|---|---|
284
- | Frontier | Claude Opus 4.6, Claude Sonnet 4.6 | Full-with-deep-audit (default) or full-with-audit | Full quality on codebases up to ~100k tokens; the deep audit's semantic pass benefits most from frontier reasoning |
285
- | Strong mid-tier | Claude Haiku 4.5, GPT-4o | Lite (3-phase) | Architecture and contracts are solid. Skip defect scan — false positive rate too high. Evidence classification less reliable. |
286
- | Smaller / faster | GPT-4o-mini, Gemini Flash, small open-weight models | Architecture only | Fair structural overview. Multi-phase pipelines produce significant quality loss. Defect scan not recommended. |
287
-
288
- ### What to Expect Below Sonnet 4.6
289
-
290
- - **Architecture phase**: Usually passable. The layer map and public surfaces will be present but may lack nuance in dependency direction and porting priorities.
291
- - **Contracts and protocols**: Quality depends heavily on how well architecture was captured. Expect missing edge cases and less precise error-behavior documentation.
292
- - **Defect scan**: Not recommended. The six specialized passes require strong domain reasoning. Weaker models produce noisy reports that cost more time to triage than they save.
293
- - **Porting and reimplementation**: These synthesis phases amplify upstream quality. If earlier phases are weak, these will be too.
354
+ | **Frontier** | Claude Opus 4.6, Claude Sonnet 4.6 | Full-with-deep-audit (default) | Full quality on codebases up to ~100k tokens; the deep audit's semantic pass benefits most from frontier reasoning. |
355
+ | **Strong mid-tier** | Claude Haiku 4.5, GPT-4o | Lite (3-phase) | Architecture and contracts are solid. Skip defect scan — false-positive rate too high. |
356
+ | **Smaller / faster** | GPT-4o-mini, Gemini Flash, small open-weight models | Architecture only | Fair structural overview. Multi-phase runs produce significant quality loss. |
294
357
 
295
- If you're testing a new model, start with `pipeline-architecture-only.yaml` on a codebase you already understand, and compare the output against your own knowledge. That gives you a fast signal on whether to trust the model with deeper phases.
358
+ If you're testing a new model, start with `pipeline-architecture-only.yaml` on a codebase you already understand and compare the output against your own knowledge. Fast signal on whether to trust the model with deeper phases.
296
359
 
297
- ## How It Works
298
-
299
- CodeCartographer is a pure template — no CLI, no runtime, no dependencies. The "code" is structured Markdown and YAML files that tell an LLM what to analyze, in what order, and how to format the results.
300
-
301
- The workflow is driven by flat files inside `.codecarto/`:
302
-
303
- - **`GUIDE.md`** — the LLM entry point. Every session starts here.
304
- - **`workflow/pipeline.yaml`** — phase definitions, dependencies, and output paths.
305
- - **`workflow/status.yaml`** — mutable per-project state. Single source of truth for progress.
306
- - **`workflow/VALIDATE.md`** — validation protocol run after every phase.
307
- - **`findings/<phase>/SKILL.md`** — detailed analysis instructions per phase.
308
- - **`templates/`** — output templates that enforce consistent structure.
360
+ ---
309
361
 
310
- Phases form a DAG: `contracts` and `protocols` can run in parallel after `architecture`; `porting` waits for both; `reimplementation-spec` is last.
311
-
312
- ### Multi-Session Workflows
313
-
314
- Large codebases typically need one LLM session per phase. Start a new session and point it at `.codecarto/GUIDE.md` — it reads `status.yaml`, sees what's done, and picks up the next phase automatically. You don't need to explain what happened in previous sessions.
315
-
316
- For follow-up sessions, you can also use `NEW_THREAD_BLURB.md` as a lighter entry point — it's a compact checklist that saves tokens by skipping the full guide.
317
-
318
- ### The Defect Scan
319
-
320
- The defect-scan phase runs six sequential analysis passes: logic and correctness, error handling, concurrency, security, API contract violations, and configuration hazards. Each finding gets a severity (critical/high/medium/low) and a recommended action (fix before porting / port differently / leave behind).
321
-
322
- ## Design Principles
323
-
324
- - **LLM-agnostic**: works with any model that can read/write files.
325
- - **Phase-gated**: one phase per session, validated before advancing.
326
- - **Single source of truth**: `status.yaml` tracks progress; no duplicated state.
327
- - **Evidence-classified**: every finding is tagged as observed fact, strong inference, portability hazard, or open question.
328
- - **Template-driven**: consistent output structure across projects and sessions.
329
- - **Drop-in**: lives inside your repo as `.codecarto/`. No symlinking or copying source code.
330
-
331
- ## Repository Structure
362
+ ## Repository structure
332
363
 
333
364
  ```
334
365
  .codecarto/ # The drop-in template (Markdown + YAML).
@@ -336,30 +367,30 @@ The defect-scan phase runs six sequential analysis passes: logic and correctness
336
367
  findings/
337
368
  architecture/ # System structure, layers, dependency direction.
338
369
  defect-scan/ # Multi-pass defect report with severity and actions.
339
- passes/ # Per-category analysis instructions (6 pass files).
340
370
  contracts/ # User-visible behavior, defaults, acceptance checks.
341
371
  protocols/ # Event streams, state machines, persistence formats.
342
372
  porting/ # Reverse-engineering synthesis bundle.
343
- reimplementation-spec/ # Final language-agnostic build spec.
373
+ reimplementation-spec/ # Language-agnostic build spec.
344
374
  scratch/ # Disposable analysis notes.
345
375
  templates/ # Output structure templates.
346
- workflow/ # Pipeline definitions, status, validation.
376
+ workflow/ # Pipeline definitions, status, validation, config.
377
+ closeouts/ # Per-session closeout files.
347
378
  THREAD_LOG.md # Cross-session summary log.
348
- core/ # Pipeline state machine, validators, prompt assembly.
349
- extensions/codecarto/ # Pi extension surface (slash commands, widget, tool gating).
350
- mcp-server/ # MCP server surface (seven tools mirroring the Pi commands).
379
+ dashboard.html # Generated; gitignored.
380
+ core/ # Pipeline state machine, validators, prompt assembly,
381
+ # dashboard renderer, usage log, orchestrator config.
382
+ extensions/codecarto/ # Pi extension surface (slash commands, widget,
383
+ # tool gating, dashboard writer + narrator).
384
+ mcp-server/ # MCP server surface (seven tools mirroring Pi commands).
351
385
  tests/ # Invariant tests catching cross-wrapper drift.
352
386
  docs/ # Roadmap, design notes.
353
- CONTRIBUTING.md # How to contribute to CodeCartographer itself.
354
- SECURITY.md # Security policy and reporting.
355
- CHANGELOG.md # Version history.
356
387
  ```
357
388
 
358
- ## Git
389
+ The `.codecarto/.gitignore` excludes generated findings, scratch files, the dashboard, and the local usage / narration caches. Template files (workflow definitions, skills, output templates) are safe to commit so teammates can run their own analyses.
359
390
 
360
- The `.codecarto/.gitignore` excludes generated findings and scratch files by default. The template files (workflow definitions, skills, templates) are safe to commit so other team members can run their own analysis.
391
+ ---
361
392
 
362
- ## For Automated Agents
393
+ ## For automated agents
363
394
 
364
395
  1. Load the active pipeline YAML and `workflow/status.yaml`.
365
396
  2. Select the first phase whose status is not `complete` and whose dependencies are all `complete`.
@@ -367,9 +398,24 @@ The `.codecarto/.gitignore` excludes generated findings and scratch files by def
367
398
  4. Write outputs to the declared paths. Run validation. Update status.
368
399
  5. Repeat until all phases are complete. Set `current_phase` to `complete` when done.
369
400
 
401
+ The MCP server does steps 1–3 directly; the Pi extension wraps them as slash commands plus the parallel-sub-agent runner described above.
402
+
403
+ ---
404
+
405
+ ## Design principles
406
+
407
+ - **LLM-agnostic** — works with any model that can read and write files.
408
+ - **Phase-gated** — one phase per session, validated before advancing.
409
+ - **Single source of truth** — `status.yaml` tracks progress; no duplicated state.
410
+ - **Evidence-classified** — every finding tagged as observed fact, strong inference, portability hazard, or open question.
411
+ - **Template-driven** — consistent output structure across projects and sessions.
412
+ - **Drop-in** — lives inside your repo as `.codecarto/`. No symlinks, no copying source code, no runtime daemon.
413
+
414
+ ---
415
+
370
416
  ## Contributing
371
417
 
372
- Bug reports, feature requests, and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, branch model, and the maintainer release process. All participants are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). For security issues, please follow [SECURITY.md](SECURITY.md) instead of filing a public issue.
418
+ Bug reports, feature requests, and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, branch model, and the maintainer release process. All participants are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). For security issues, follow [SECURITY.md](SECURITY.md) instead of filing a public issue.
373
419
 
374
420
  ## License
375
421