- Công cụ mã nguồn mở tự động vẽ bản đồ codebase để con người và AI agent cùng quan sát
- Kết hợp phân tích tĩnh và suy luận LLM để tự động tạo sơ đồ kiến trúc cấp cao và tài liệu cho các thành phần chính của codebase
- Kết quả được lưu trong thư mục
.codeboarding/ dưới dạng tài liệu Markdown và sơ đồ Mermaid, có thể nhúng trực tiếp vào IDE, CI, PR và tài liệu
- Hỗ trợ cập nhật gia tăng nên khi chỉ một phần của codebase thay đổi, hệ thống chỉ phân tích lại phần đó, giúp hoạt động nhanh ngay cả với repository quy mô lớn
- Gồm 6 thành phần cốt lõi
- Application Orchestrator & Repository Manager: khởi động workflow phân tích và truyền ngữ cảnh
- LLM Agent Core: gọi các công cụ chuyên biệt để xử lý mã và dữ liệu phân tích
- Static Code Analyzer: thực hiện phân tích tĩnh cho các đoạn mã
- Agent Tooling Interface: giao diện để agent truy vấn engine phân tích tĩnh
- Incremental Analysis Engine: chỉ gửi yêu cầu phân tích tĩnh cho phần mã đã thay đổi và lưu cache kết quả
- Documentation & Diagram Generator: chuyển kết quả phân tích thành tài liệu và sơ đồ
- Kịch bản sử dụng
- Duy trì khả năng quan sát kiến trúc trong khi AI agent đang viết mã
- Rà soát các thay đổi do AI tạo ra cùng với ngữ cảnh hệ thống để ngăn chặn sớm technical debt tiềm ẩn
- Nhanh chóng hiểu repository lớn nhờ sơ đồ phân lớp và phân rã thành phần
- Chia sẻ cùng một mô hình trực quan trong workflow cục bộ, IDE, PR và tài liệu
- Hỗ trợ 8 ngôn ngữ: Python, TypeScript, JavaScript, Java, Go, PHP, Rust, C#
- Tích hợp nhiều nhà cung cấp LLM: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter, v.v.
- Cung cấp theo ba hình thức triển khai
- CLI: dành cho phân tích cục bộ, tự động hóa và workflow CI (
pipx install codeboarding)
- Extension VS Code: xem kiến trúc trực quan ngay trong trình soạn thảo
- GitHub Action: luôn giữ sơ đồ ở trạng thái mới nhất trong CI
- Đã cung cấp sẵn cơ sở dữ liệu mẫu trực quan hóa hơn 800 repository mã nguồn mở nổi tiếng
- Tầm nhìn: xây dựng tiêu chuẩn mở cho việc hiểu code mà cả con người lẫn AI agent đều có thể sử dụng
- Giấy phép MIT
Chưa có bình luận nào.