- Ferramenta open source que desenha automaticamente um mapa da codebase para ser visualizado em conjunto por pessoas e agentes de AI
- Combina análise estática com raciocínio de LLM para gerar automaticamente diagramas de arquitetura de alto nível da codebase e documentação dos principais componentes
- Os resultados são salvos no diretório
.codeboarding/ como documentos Markdown e diagramas Mermaid, podendo ser incorporados diretamente em IDE, CI, PR e documentação
- Suporta atualizações incrementais: quando apenas parte da codebase é alterada, reanalisa somente aquela parte, funcionando rapidamente mesmo em repositórios de grande porte
- Composto por 6 componentes principais
- Application Orchestrator & Repository Manager: inicia o workflow de análise e repassa o contexto
- LLM Agent Core: chama ferramentas especializadas para lidar com código e dados de análise
- Static Code Analyzer: realiza análise estática de segmentos de código
- Agent Tooling Interface: interface pela qual o agente consulta o mecanismo de análise estática
- Incremental Analysis Engine: solicita análise estática apenas do código alterado e faz cache dos resultados
- Documentation & Diagram Generator: converte os resultados da análise em documentação e diagramas
- Cenários de uso
- Manter visibilidade da arquitetura enquanto agentes de AI escrevem código
- Revisar alterações geradas por AI com o contexto do sistema, bloqueando antecipadamente dívida técnica oculta
- Entendimento rápido de repositórios grandes com diagramas em camadas e decomposição de componentes
- Compartilhar o mesmo modelo visual em workflows locais, IDE, PR e documentação
- Suporte a 8 linguagens: Python, TypeScript, JavaScript, Java, Go, PHP, Rust e C#
- Integração com vários provedores de LLM: OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter etc.
- Disponível em três formas de implantação
- CLI: para análise local, automação e workflows de CI (
pipx install codeboarding)
- Extensão do VS Code: visualização da arquitetura dentro do editor
- GitHub Action: mantém os diagramas sempre atualizados no CI
- Já oferece uma base de amostras com mais de 800 repositórios open source conhecidos visualizados
- Visão: construir um padrão aberto para compreensão de código que possa ser usado tanto por humanos quanto por agentes de AI
- Licença MIT
Ainda não há comentários.