- Alat open-source yang secara otomatis menggambar peta codebase yang dilihat bersama oleh manusia dan agen AI
- Menggabungkan analisis statis dan penalaran LLM untuk secara otomatis menghasilkan diagram arsitektur tingkat tinggi dan dokumentasi komponen utama dari codebase
- Hasil disimpan di direktori
.codeboarding/ dalam bentuk dokumen Markdown dan diagram Mermaid, sehingga bisa langsung di-embed ke IDE, CI, PR, dan dokumentasi
- Mendukung pembaruan inkremental, sehingga saat hanya sebagian codebase berubah, hanya bagian tersebut yang dianalisis ulang agar tetap cepat pada repositori besar
- Terdiri dari 6 komponen inti
- Application Orchestrator & Repository Manager: memulai workflow analisis dan meneruskan konteks
- LLM Agent Core: memanggil alat-alat khusus untuk menangani kode dan data analisis
- Static Code Analyzer: melakukan analisis statis pada segmen kode
- Agent Tooling Interface: antarmuka agar agen dapat melakukan kueri ke mesin analisis statis
- Incremental Analysis Engine: meminta analisis statis hanya untuk kode yang berubah dan melakukan caching hasil
- Documentation & Diagram Generator: mengubah hasil analisis menjadi dokumentasi dan diagram
- Skenario penggunaan
- Menjaga visibilitas arsitektur saat agen AI menulis kode
- Meninjau perubahan yang dihasilkan AI bersama konteks sistem untuk mencegah utang teknis tersembunyi sejak awal
- Memahami repositori besar dengan cepat melalui diagram berlapis dan dekomposisi komponen
- Berbagi model visual yang sama di workflow lokal, IDE, PR, dan dokumentasi
- Mendukung 8 bahasa: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
- Terintegrasi dengan banyak penyedia LLM: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter, dan lainnya
- Tersedia dalam tiga bentuk deployment
- CLI: untuk analisis lokal, otomatisasi, dan workflow CI (
pipx install codeboarding)
- Ekstensi VS Code: melihat arsitektur visual langsung di editor
- GitHub Action: menjaga diagram selalu mutakhir di CI
- Sudah menyediakan DB sampel yang memvisualisasikan lebih dari 800 repositori open-source terkenal
- Visi: membangun standar terbuka untuk pemahaman kode yang dapat dimanfaatkan baik oleh manusia maupun agen AI
- Lisensi MIT
Belum ada komentar.