Local-first code comprehension

Source-grounded workflow diagrams for coding agents.

CodeDebrief turns a local codebase into deterministic workflow slices that agents can render, explain, expand, and cite.

View on GitHub Install from PyPI

MCP-first Mermaid No API key

A compact workflow diagram generated from CodeDebrief artifacts

For coding agents

Agents ask the MCP server for a bounded workflow slice instead of rebuilding a flow from scattered source files.

For manual exploration

Open the local viewer to inspect the complete graph, navigate files, and export visual workflow snapshots.

For stable explanations

Diagrams are derived from deterministic artifacts, with source ranges and stable visual hashes.

Install

MCP support is included by default. Install the CLI, configure an agent, then ask ordinary codebase questions. On Windows, run setup in the same environment as the agent; WSL projects are bridged through wsl.exe in JSON MCP configs.

uv tool install codedebrief
cd path/to/your/project
codedebrief setup codex
codedebrief view