CodeBoarding provides visual diagrams of codebases by combining static analysis with LLM reasoning to generate architecture diagrams and documentation. It offers a CLI, a web platform, and IDE integrations, with multiple language/server support and incremental analysis workflows.
Collecting history — the radar snapshots this repo daily. The trend line appears after 3 days of data (1 so far).
What it is
CodeBoarding generates architecture diagrams and component-level documentation for codebases by combining static analysis with LLM reasoning. It outputs Markdown docs in .codeboarding/, Mermaid diagrams, and incremental updates when only parts of the codebase change. It targets IDE, CI, and docs workflows and offers a web platform and extensions.
How it works
The project describes a workflow with an Application Orchestrator & Repository Manager, an LLM Agent Core, a Static Code Analyzer, an Agent Tooling Interface, an Incremental Analysis Engine, and a Documentation & Diagram Generator. These components interact to perform analysis, caching, tool queries, and diagram/document generation. The README provides a Mermaid diagram illustrating their interactions and data flow, including incremental updates based on code changes and LLM-assisted insights.
Getting started
- Quick start: Run from source:
uv sync --frozen
source .venv/bin/activate # On Windows: .venv\Scripts\activate
python install.py
python main.py full --local /path/to/repo
- Use the packaged CLI (Python 3.12/3.13 required). Installation methods include pipx, or pip in a virtual environment:
pipx install codeboarding --python python3.12
codeboarding-setup
codeboarding full --local /path/to/repo
pip install codeboarding --extra-index-url https://pip.codeboarding.org/simple/
codeboarding-setup
codeboarding full --local /path/to/repo
- Output written to
/path/to/repo/.codeboarding/; interactive exploration via web platform. Language server binaries are downloaded to~/.codeboarding/servers/during setup; Node.js is required for several language servers, with a pinned Node runtime downloaded if needed.
Recent releases
- v0.13.1 Release v0.13.1 (2026-07-28)
- v0.13.0 Release v0.13.0 (2026-07-13)
- v0.12.4 Release v0.12.4 (2026-06-23)
- v0.12.3 Release v0.12.3 (2026-06-19)
- v0.12.2 Release v0.12.2 (2026-06-13)
Traction
Stars: 2371 Forks: 197 Open issues: 15
Behind the repo
Website and web platform available at app.codeboarding.org; Open VSX extension and a VS Code extension are listed, with a GitHub Action integration for diagrams.
Caveats
License: MIT Created: 2025-04-08 Last push: 2026-08-04 Languages: Python; stacks include TypeScript, JavaScript, Java, Go, PHP, Rust, C#. Common commands and configuration are provided, including environment variable and config file-based provider setup.