- Ein Open-Source-Tool, das automatisch eine Karte der Codebasis erstellt, die Menschen und AI-Agenten gemeinsam nutzen können
- Kombiniert statische Analyse und LLM-Inferenz, um automatisch Architekturdiagramme auf hoher Ebene und Dokumentation der wichtigsten Komponenten einer Codebasis zu erzeugen
- Die Ergebnisse werden im Verzeichnis
.codeboarding/ als Markdown-Dokumente und Mermaid-Diagramme gespeichert und können direkt in IDE, CI, PRs und Dokumentation eingebettet werden
- Unterstützt inkrementelle Updates: Wenn sich nur ein Teil der Codebasis ändert, wird auch nur dieser Teil erneut analysiert, sodass das Tool selbst in großen Repositories schnell arbeitet
- Besteht aus 6 Kernkomponenten
- Application Orchestrator & Repository Manager: Startet den Analyse-Workflow und übergibt den Kontext
- LLM Agent Core: Ruft spezialisierte Tools auf, um mit Code und Analysedaten zu arbeiten
- Static Code Analyzer: Führt statische Analysen von Codesegmenten durch
- Agent Tooling Interface: Schnittstelle, über die Agenten Anfragen an die statische Analyse-Engine stellen
- Incremental Analysis Engine: Fordert statische Analysen nur für geänderten Code an und cached die Ergebnisse
- Documentation & Diagram Generator: Wandelt Analyseergebnisse in Dokumentation und Diagramme um
- Einsatzszenarien
- Architekturtransparenz erhalten, während AI-Agenten Code schreiben
- Von AI erzeugte Änderungen mit Systemkontext prüfen, um versteckte technische Schulden frühzeitig zu verhindern
- Große Repositories durch geschichtete Diagramme und Komponentenzerlegung schnell verstehen
- Dasselbe visuelle Modell in lokalen Workflows, IDEs, PRs und Dokumentation teilen
- Unterstützt 8 Sprachen: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
- Integration mit mehreren LLM-Anbietern: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter usw.
- In drei Bereitstellungsformen verfügbar
- CLI: Für lokale Analyse, Automatisierung und CI-Workflows (
pipx install codeboarding)
- VS Code-Erweiterung: Visuelle Architektur direkt im Editor ansehen
- GitHub Action: Hält Diagramme in CI immer auf dem neuesten Stand
- Stellt bereits eine Beispiel-Datenbank mit mehr als 800 bekannten Open-Source-Repositories bereit, die visualisiert wurden
- Vision: Aufbau eines offenen Standards für Codeverständnis, den sowohl Menschen als auch AI-Agenten nutzen können
- MIT-Lizenz
Noch keine Kommentare.