CodeBoarding - コードベース向けインタラクティブアーキテクチャ図
(github.com/CodeBoarding)- 人とAIエージェントが一緒に見るコードベースの地図を自動生成するオープンソースツール
- 静的解析とLLM推論を組み合わせ、コードベースの高レベルなアーキテクチャ図と主要コンポーネント文書を自動生成
- 成果物は
.codeboarding/ディレクトリに Markdownドキュメント と Mermaidダイアグラム の形で保存され、IDE、CI、PR、ドキュメントにそのまま埋め込み可能 - 増分更新 をサポートし、コードベースの一部だけが変更された場合はその部分のみを再解析するため、大規模リポジトリでも高速に動作
- 6つの中核コンポーネントで構成
- Application Orchestrator & Repository Manager: 解析ワークフローの開始とコンテキストの受け渡し
- LLM Agent Core: 特化ツールを呼び出してコードと解析データを扱う
- Static Code Analyzer: コードセグメントの静的解析を実行
- Agent Tooling Interface: エージェントが静的解析エンジンに問い合わせるためのインターフェース
- Incremental Analysis Engine: 変更されたコードのみ静的解析を要求し、結果をキャッシュ
- Documentation & Diagram Generator: 解析結果をドキュメントとダイアグラムに変換
- 活用シナリオ
- AIエージェントがコードを書く間も アーキテクチャの可視性を維持
- AI生成の変更を システムコンテキストとともにレビュー し、隠れた技術的負債を事前に防止
- レイヤードダイアグラムとコンポーネント分解 により、大規模リポジトリを素早く理解
- ローカルワークフロー、IDE、PR、ドキュメントで同じ視覚モデルを共有
- 8言語 をサポート: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
- 複数のLLMプロバイダーと連携: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter など
- 3つのデプロイ形態で提供
- CLI: ローカル解析、自動化、CIワークフロー向け (
pipx install codeboarding) - VS Code拡張機能: エディター内で視覚的なアーキテクチャを確認
- GitHub Action: CIでダイアグラムを常に最新の状態に維持
- CLI: ローカル解析、自動化、CIワークフロー向け (
- すでに 800以上の著名なオープンソースリポジトリ を可視化したサンプルDBを提供
- 公開リポジトリ: GeneratedOnBoardings
- ホストされたエクスプローラーで一部を確認可能 codeboarding.org/diagrams
- ビジョン: 人間とAIエージェントの双方が活用できる コード理解のオープンスタンダード を構築
- MITライセンス
まだコメントはありません。