yuzutech/kroki
Kroki
Kroki is a text-to-diagram rendering API and diagram-as-code server that transforms plain text definitions from various modeling languages into SVG or PNG images. It functions as a multi-language diagram renderer, providing a unified interface to generate flowcharts, UML diagrams, and charts using a collection of external libraries.
The system utilizes a container-based plugin architecture and a sidecar rendering model to isolate external rendering engines. This design allows for the addition of new diagramming languages via companion containers and ensures stateless image generation where source definitions are not stored on disk.
The project includes capabilities for automated data visualization, interactive diagram editing with live previews, and the embedding of diagrams into documents. It provides a command-line interface for encoding and decoding diagram text, alongside security features such as resource access restrictions and CORS header management.
Kroki is available for containerized deployment and supports installation on Kubernetes clusters.
Features
- Diagram Renderers - Transforms text-based graph or diagram definitions into visual graphical elements via a standardized API.
- Text-to-Diagram Generators - Provides a web service that parses structured text syntax to render visual diagrams automatically.
- Binary Wrappers - Uses programmatic binary wrappers to invoke external command-line tools for diagram image generation.
- Containerized Image Generators - Uses a container-based architecture to isolate external rendering engines that generate visual diagrams from text.
- Self-Hosted Servers - Provides a private, containerized server for converting text-based diagram specifications into images.
- HTTP-Driven Pipelines - Implements a rendering pipeline triggered and parameterized entirely through HTTP requests.
- Diagram as Code Frameworks - Implements a workflow for defining visual diagrams using text formats, supporting version control and rapid iteration.
- Sidecar Task Delegation - Offloads the rendering process to isolated sidecar processes to maintain system security and independence.
- Container-Based Plugins - Enables extension of supported diagram languages via companion containers attached at runtime.
- Data Visualization - Renders structured data specifications into visual charts, maps, and plots.
- Live Diagram Editors - Provides a web-based editor that renders diagram code into visual diagrams in real time as you type.
- Embedded Document Renderers - Enables embedding of rendered diagrams as images directly inside markdown and other text-based documents.
- Diagram CLI Tools - Provides command line utilities for rendering text-based diagram definitions into image files.
- Diagram Rendering Configurations - Provides configuration settings to control the visual output and behavior of text-to-diagram engines.
- Document Diagramming and Iconography - Enables embedding dynamic diagram images into documents by converting definitions via an external API.
- Stateless Image Generation - Produces visual diagrams on the fly without storing the source definitions or the resulting images on disk.
- Visual Data Rendering - Renders text-based data specifications into various visual charts, maps, and plots.
- Diagramming - Enables the addition of new diagramming languages by attaching optional companion containers.
- Path Access Restrictions - Blocks rendering libraries from accessing local files or network entities to prevent unauthorized data access.
- Diagramming - API for generating diagrams from text descriptions.
