Linguagem de modelagem e conjunto de ferramentas que gera diagramas de arquitetura de software baseados em código e atualizados em tempo real, com notação inspirada no C4.
plantuml-stdlib/C4-PlantUML
Uma biblioteca de macros do modelo C4 para PlantUML que permite criar diagramas de arquitetura de software usando código em texto puro.
Alternativa open source a:Lucidchart
Visio
- Estrelas
- 7,441
- Forks
- 1,168
- Issues abertas
- 0
- Último commit
- há 9 dias
O que é?
C4-PlantUML é um conjunto de macros e estereótipos do PlantUML que implementa o modelo C4 para arquitetura de software. Em vez de desenhar caixas manualmente, você descreve pessoas, sistemas, contêineres, componentes e nós de implantação em um arquivo de texto curto, e o PlantUML renderiza o diagrama. Assim, fica fácil versionar e revisar diagramas de arquitetura junto com o código.
A biblioteca oferece includes separados para diagramas de Contexto do Sistema, Contêiner, Componente, Dinâmico, Implantação e de Sequência com o estilo C4. Cada include contém macros para elementos comuns, variantes externas, bancos de dados e filas, limites e relacionamentos com controle opcional de direção. Também oferece suporte a sprites e ícones, links nos elementos, tags personalizadas com legendas geradas automaticamente e opções de layout.
O projeto é independente de plataforma, tem código aberto e inclui snippets para VS Code e live templates para IntelliJ. Os diagramas podem ser renderizados com um jar local do PlantUML ou pelo servidor web do PlantUML, e a biblioteca pode ser incluída pela URL do repositório ou pela biblioteca padrão que acompanha o PlantUML.
Recursos principais
- 01Macros para diagramas de Sistema, Contêiner, Componente, Dinâmico, Implantação e Sequência com estilo C4.
- 02Tipos de elementos para pessoas, sistemas, contêineres, bancos de dados, filas e elementos externos.
- 03Macros de relacionamento com direção e agrupamento por limites.
- 04Sprites de ícones, links nos elementos e tags personalizadas com legenda gerada automaticamente.
- 05Suporte a editores por meio de snippets para VS Code e live templates para IntelliJ.
Casos de uso
- Documentar a arquitetura de software durante sessões de planejamento inicial.
- Manter os diagramas de arquitetura no mesmo repositório que o código que descrevem.
- Comunicar o contexto do sistema e a estrutura de contêineres a stakeholders sem conhecimento especializado.
Início rápido
- 1
Inclua a biblioteca C4_Container no arquivo .puml
!include <C4/C4_Container> - 2
Escreva os elementos e as relações do C4 em texto simples entre @startuml/@enduml
- 3
Renderize o diagrama com o PlantUML, por exemplo, usando o arquivo jar
java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...
Antes de usar
- Os diagramas precisam do PlantUML para serem renderizados. Portanto, você precisa do Java ou de um servidor PlantUML para visualizá-los.
Tópicos
Perguntas frequentes
- O que é C4-PlantUML?
- Uma biblioteca de macros do modelo C4 para PlantUML que permite criar diagramas de arquitetura de software usando código em texto puro. C4-PlantUML é um conjunto de macros e estereótipos do PlantUML que implementa o modelo C4 para arquitetura de software. Em vez de desenhar caixas manualmente, você descreve pessoas, sistemas, contêineres, componentes e nós de implantação em um arquivo de texto curto, e o PlantUML renderiza o diagrama. Assim, fica fácil versionar e revisar diagramas de arquitetura junto com o código.
- C4-PlantUML é gratuito? Qual é a licença?
- C4-PlantUML é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- C4-PlantUML ainda é mantido?
- Manutenção ativa. O último commit de C4-PlantUML foi em 13 de out. de 2026.
- Para que posso usar C4-PlantUML?
- Documentar a arquitetura de software durante sessões de planejamento inicial. Manter os diagramas de arquitetura no mesmo repositório que o código que descrevem. Comunicar o contexto do sistema e a estrutura de contêineres a stakeholders sem conhecimento especializado.
- Como instalar C4-PlantUML?
- Inclua a biblioteca C4_Container no arquivo .puml: !include <C4/C4_Container> Escreva os elementos e as relações do C4 em texto simples entre @startuml/@enduml Renderize o diagrama com o PlantUML, por exemplo, usando o arquivo jar: java -jar plantuml.jar -DRELATIVE_INCLUDE="." ...
- Onde consigo C4-PlantUML?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/plantuml-stdlib/C4-PlantUML
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Gera diagramas UML e outros a partir de descrições em texto simples, incluindo diagramas de sequência, classes, atividades, estados, Gantt e muito mais.
Diagrama como código: crie diagramas de arquitetura de nuvem e sistemas com Python, usando ícones de AWS, Azure, GCP, Kubernetes e muito mais.
API HTTP unificada que renderiza descrições de diagramas em texto, como PlantUML, Mermaid, D2 e GraphViz, em SVG, PNG e outros formatos de imagem.
Uma skill de agente que transforma linguagem natural e fontes reais do sistema, como Terraform, Kubernetes, SQL e OpenAPI, em diagramas de arquitetura editáveis no draw.io.
Uma skill que faz ferramentas de programação com IA desenharem a arquitetura, as restrições e o escopo das mudanças do projeto em um mapa HTML, aguardando confirmação antes de editar o código.