GitHub

Overview / Description

CodeBoarding is an AI codebase documentation tool that generates interactive architecture diagrams by combining static control-flow analysis with a small LLM layer that names the clusters. Built for developers and coding agents, it maps the real architecture of a project instead of just listing folders or asking an LLM to index everything. It produces high-level system diagrams plus component-level documentation at multiple depth levels, and exports Mermaid-formatted output you can embed directly in docs and pull requests. Incremental analysis lets it focus on the parts of the code that changed, so reviewers can see what an AI agent built before it breaks. CodeBoarding ships as a CLI, a VS Code extension, and a GitHub Action, supports eight languages (Python, TypeScript, JavaScript, Java, Go, PHP, Rust, and C#), and works with multiple LLM providers including OpenAI, Anthropic, Google, AWS Bedrock, and Ollama. The project is open-source under the MIT license, with local CLI usage and a hosted diagram explorer at codeboarding.org. It is aimed at teams using coding agents who need readable, navigable architecture documentation that stays in sync with the code.

Used For

Developers use CodeBoarding to auto-generate architecture diagrams and documentation that map a codebase's real structure.

Pricing

Plan

Free

Open-source (MIT) — free to self-host

View pricing

Plan

Free

Hosted diagram explorer available at codeboarding.org

View pricing

Pros & Cons

Pros

  • Uses static control-flow analysis, not just LLM indexing, to find real architecture
  • Exports Mermaid diagrams you can embed in docs and pull requests
  • Ships as a CLI, VS Code extension, and GitHub Action
  • Supports 8 languages and multiple LLM providers including local Ollama
  • Open-source under the MIT license

Cons

  • Requires bringing your own LLM provider/API key for the naming layer
  • Diagram quality depends on the LLM used for cluster naming
  • Aimed at developers, so non-technical users will find it niche

Questions & Answers

Alternatives

Sourcegraph, CodeSee, Swimm, Mermaid, GitDiagram