Skip to content
Search

CodeBoarding

lastmod 2026-05-29created 2026-05-291 edits

Interactive architecture diagrams for codebases

About

  • An open-source tool that automatically draws a codebase map for both humans and AI agents to view
  • Combines static analysis and LLM reasoning to automatically generate high-level architecture diagrams of a codebase and documentation of its key components
  • Output is saved in the .codeboarding/ directory as Markdown documents and Mermaid diagrams, and can be embedded as-is in IDEs, CI, PRs, and documentation
  • Supports incremental updates: when only part of a codebase changes, only that part is re-analyzed, so it runs fast even on large repositories
  • Consists of 6 core components
    • Application Orchestrator & Repository Manager: starts the analysis workflow and passes context
    • LLM Agent Core: calls specialized tools to work with code and analysis data
    • Static Code Analyzer: performs static analysis of code segments
    • Agent Tooling Interface: interface through which agents query the static analysis engine
    • Incremental Analysis Engine: requests static analysis only for changed code and caches results
    • Documentation & Diagram Generator: turns analysis results into documentation and diagrams
  • Use cases
    • Keep architectural visibility while AI agents write code
    • Review AI-generated changes with system context to head off hidden technical debt
    • Quickly understand large repositories through layered diagrams and component breakdowns
    • Share the same visual model across local workflows, IDEs, PRs, and documentation
  • Supports 8 languages: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
  • Integrates with multiple LLM providers: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter, etc.
  • Available in three distribution forms
    • CLI: for local analysis, automation, and CI workflows (pipx install codeboarding)
    • VS Code extension: view the architecture visually inside the editor
    • GitHub Action: keeps diagrams always up to date in CI
  • Provides a sample DB that has already visualized more than 800 well-known open-source repositories
    • Public Repo : GeneratedOnBoardings
    • Some can be viewed in the hosted explorer codeboarding.org/diagrams
  • Vision: build an open standard for code understanding usable by both humans and AI agents
  • MIT License

See also

Favorite site

author Zer0 sitemap