Uma skill para Claude e agentes de programação que transforma uma especificação JSON curta em diagramas animados e interativos, exportáveis como SVG, PNG, GIF ou MP4.
68638JavaScriptMITAtualizado há 4 dias
yuzutech/kroki
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.
- Estrelas
- 4,374
- Forks
- 323
- Issues abertas
- 142
- Último commit
- ontem
O que é?
Kroki é um gateway que transforma descrições de diagramas em texto em imagens por meio de uma única API HTTP. Em vez de instalar um renderizador separado para cada ferramenta, você envia o código-fonte do diagrama para um endpoint e especifica o tipo de diagrama, como PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw ou Vega-Lite, além do formato de saída desejado.
O servidor é escrito em Java com Vert.x e executado como uma imagem Docker. As solicitações podem ser enviadas como chamadas GET com URL codificada, corpos JSON em requisições POST ou texto simples com cabeçalhos Accept. Alguns renderizadores, incluindo Mermaid, BPMN, Excalidraw e diagrams.net, são executados em containers auxiliares aos quais o servidor principal se conecta por meio de variáveis de ambiente.
O projeto oferece suporte a diversas famílias de diagramas, incluindo UML, C4, ERD, DBML, BPMN, diagramas de sequência e de rede, diagramas de temporização e de pacotes, além de layouts bytefield. Os usuários podem incorporar as imagens geradas em documentação ou páginas web sem precisar instalar cada ferramenta de diagrama localmente.
Recursos principais
- 01API única e unificada para diversas linguagens de diagramas
- 02Aceita requisições GET com código-fonte codificado, POST com JSON ou entrada em texto simples
- 03Gera imagens em SVG, PNG e outros formatos
- 04Executado como imagem Docker, com containers auxiliares opcionais para Mermaid, BPMN e Excalidraw
- 05Conexões configuráveis com serviços auxiliares por meio de variáveis de ambiente
Casos de uso
- Renderizar diagramas de arquitetura ou de sequência em pipelines de documentação
- Gerar imagens de diagramas para wikis ou ferramentas de chat a partir de código-fonte em texto
- Hospedar um serviço privado de renderização de diagramas para uma equipe interna
- Incorporar prévias de diagramas em aplicações web sem instalar ferramentas localmente
Início rápido
- 1
Execute o contêiner do Kroki com Docker
docker run -d -p 8000:8000 yuzutech/kroki - 2
Se quiser, inicie contêineres auxiliares para Mermaid, BPMN, Excalidraw ou diagrams.net usando docker-compose
docker-compose up -d
Antes de usar
- Alguns tipos de diagrama, como Mermaid, BPMN e Excalidraw, exigem que contêineres auxiliares adicionais sejam iniciados.
- A integração com diagrams.net é experimental.
Tópicos
Perguntas frequentes
- O que é kroki?
- 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. Kroki é um gateway que transforma descrições de diagramas em texto em imagens por meio de uma única API HTTP. Em vez de instalar um renderizador separado para cada ferramenta, você envia o código-fonte do diagrama para um endpoint e especifica o tipo de diagrama, como PlantUML, Mermaid, Graphviz, Ditaa, Excalidraw ou Vega-Lite, além do formato de saída desejado.
- kroki é gratuito? Qual é a licença?
- kroki é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- kroki ainda é mantido?
- Manutenção ativa. O último commit de kroki foi em 20 de out. de 2026.
- Para que posso usar kroki?
- Renderizar diagramas de arquitetura ou de sequência em pipelines de documentação Gerar imagens de diagramas para wikis ou ferramentas de chat a partir de código-fonte em texto Hospedar um serviço privado de renderização de diagramas para uma equipe interna Incorporar prévias de diagramas em aplicações web sem instalar ferramentas localmente
- Como instalar kroki?
- Execute o contêiner do Kroki com Docker: docker run -d -p 8000:8000 yuzutech/kroki Se quiser, inicie contêineres auxiliares para Mermaid, BPMN, Excalidraw ou diagrams.net usando docker-compose: docker-compose up -d
- Onde consigo kroki?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/yuzutech/kroki
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Uma skill de agente que cria diagramas editoriais em um único arquivo HTML + SVG autocontido, com 45 tipos de diagrama e correspondência com a identidade da marca.
58,9 mil3,8 milHTMLMITAtualizado ontem
Um renderizador leve e síncrono que converte texto de diagramas Mermaid em SVG, sem dependências em tempo de execução.
2,7 mil80TypeScriptOtherAtualizado há 13 horas
Uma biblioteca TypeScript que renderiza diagramas Mermaid em SVG personalizável por tema ou texto ASCII/Unicode, sem dependências do DOM.
11,2 mil411TypeScriptMITAtualizado há 6 meses
Uma skill para agentes e um linter sem dependências que ensinam agentes de programação a criar diagramas SVG com posicionamento manual e um estilo visual consistente.
62945JavaScriptMITAtualizado há 2 meses
App de menu bar para Electron que permite a agentes de programação com IA renderizar diagramas e prévias, além de anotá-los e aprová-los na tela.
34732JavaScriptMITAtualizado há 6 meses