- Outil open source qui génère automatiquement une carte de la base de code, lisible à la fois par les humains et les agents IA
- Combine l’analyse statique et le raisonnement par LLM pour générer automatiquement des diagrammes d’architecture de haut niveau et la documentation des composants clés d’une base de code
- Les résultats sont enregistrés dans le répertoire
.codeboarding/ sous forme de documents Markdown et de diagrammes Mermaid, pouvant être intégrés tels quels dans l’IDE, la CI, les PR et la documentation
- Prend en charge les mises à jour incrémentales : lorsqu’une partie seulement de la base de code est modifiée, seule cette portion est réanalysée, ce qui permet un fonctionnement rapide même sur de grands dépôts
- Composé de 6 composants principaux
- Application Orchestrator & Repository Manager : lance le workflow d’analyse et transmet le contexte
- LLM Agent Core : appelle des outils spécialisés pour traiter le code et les données d’analyse
- Static Code Analyzer : effectue l’analyse statique des segments de code
- Agent Tooling Interface : interface par laquelle l’agent interroge le moteur d’analyse statique
- Incremental Analysis Engine : soumet les demandes d’analyse statique uniquement pour le code modifié et met en cache les résultats
- Documentation & Diagram Generator : transforme les résultats d’analyse en documentation et en diagrammes
- Cas d’usage
- Maintenir une visibilité sur l’architecture pendant que les agents IA écrivent du code
- Relire les modifications générées par l’IA avec le contexte système afin de bloquer en amont la dette technique cachée
- Comprendre rapidement de grands dépôts grâce à des diagrammes en couches et une décomposition par composants
- Partager le même modèle visuel entre workflow local, IDE, PR et documentation
- Prise en charge de 8 langages : Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
- Intégration avec plusieurs fournisseurs de LLM : OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter, etc.
- Disponible sous trois formes de déploiement
- CLI : pour l’analyse locale, l’automatisation et les workflows CI (
pipx install codeboarding)
- Extension VS Code : pour visualiser l’architecture directement dans l’éditeur
- GitHub Action : pour maintenir les diagrammes toujours à jour dans la CI
- Fournit déjà une base d’exemples visualisant plus de 800 dépôts open source connus
- Vision : construire un standard ouvert de compréhension du code exploitable à la fois par les humains et les agents IA
- Licence MIT
Aucun commentaire pour le moment.