CodeBoarding/CodeBoarding

Interactive architecture diagrams for codebases

解决的问题

CodeBoarding 解决了理解大型复杂代码库的困难，以及 AI 编码代理引入“隐藏债务”的风险，通过使系统架构可见化来达成。它提供代码库的可视化地图，以便开发者和代理在实施更改之前查看高层结构和组件关系。

工作原理

该工具结合静态代码分析和 LLM 推理来生成架构洞察。它使用静态分析器提取代码洞察，并使用 LLM 代理核心提供结构化分析。增量分析引擎确保仅重新处理代码库中已更改的部分，从而减少开销。输出内容生成为 Mermaid 图表、Markdown 文档，以及一个可在 IDE、Web 平台中查看，或通过 GitHub Actions 集成到 CI/CD 流水线中的 JSON 分析文件。

适用人群

  • 开发者：需要更快上手大型代码仓库，或在具备系统上下文的情况下审查 AI 生成更改的开发者。
  • 编码代理：需要代码库的可视化、高层表示以更准确运行的代理。
  • 团队：希望在其文档或拉取请求中自动维护最新架构图和文档的团队。

亮点

  • 多语言支持：支持 Python、TypeScript、JavaScript、Java、Go、PHP、Rust 和 C#。
  • 灵活的 LLM 集成：通过 LiteLLM 或 OpenRouter 兼容 OpenAI、Anthropic、Google、Ollama 及其他提供商。
  • 详细输出：生成高层系统架构图、组件级分解和 Markdown 文档。
  • 增量更新：仅分析已更改的代码段以保持效率。
  • 广泛集成：提供 CLI、VS Code 扩展、Web 平台和 GitHub Action 等形式。

相关

  • 项目
    Egonex-AI/Understand-Anything

    一个多代理工具，能将代码库与知识库转换为交互式知识图谱，帮助开发者可视化架构与业务逻辑。

  • 项目
    Agents365-ai/drawio-skill

    一个将自然语言、代码和基础设施配置转换为可编辑 .drawio 图表的工具，具备增量同步和架构即测试验证功能。

  • 项目
    vercel-labs/lat.md

    lat.md 是一个通过 npm 分发的 CLI，为代码库创建基于 Markdown 的知识图谱。它允许您在 `lat.md/` 中编写链接文档，使用 `@lat` 注释标注源文件，并验证图谱。开发者和代理可以离线使用 MiniLM 或远程调用 OpenAI/Vercel 嵌入进行语义搜索，并使用 `lat check`、`lat locate` 和 `lat expand` 等命令，使设计决策、约束和测试规范与代码保持同步。

  • 项目
    bytedance/flowgram.ai

    一个用于构建自定义 AI 工作流平台的可组合工作流开发框架和工具包，支持可视化画布和变量管理。

  • 项目
    trailhq/Graft

    Graft 是一个开源的 TypeScript/Node.js 工具，利用 tree-sitter 进行结构化解析，并可选地使用 LLM 摘要，构建本地、基于 Markdown 的代码库知识图谱（摘要、关键代码片段、类型化链接）。图谱缓存在 `graft/` 文件夹中，仅在文件变更时刷新，并自动集成到 Claude Code、Cursor、Codex 和 Gemini 等编码代理中。基准测试显示，最多减少 46% 的工具调用、42% 的 token 消耗、60% 的延迟，并在 SWE-bench 上实现 12 点准确率提升。集成通过单个 `graft init` 命令完成，生成代理专用的指令文件；CLI 还提供搜索、可视化和遥测控制功能。项目采用 MIT 许可证，旨在实现更快、更低成本的 AI 辅助开发。