yuzutech/kroki

これは何？

主な機能

• 01さまざまな図の記述言語に対応する統合API
• 02ソースをエンコードしたGETリクエスト、JSONのPOST、プレーンテキスト入力に対応
• 03SVG、PNGなどの画像形式で出力
• 04Dockerイメージとして動作し、Mermaid、BPMN、Excalidraw用の補助コンテナも利用可能
• 05環境変数を使って補助サービスへの接続を設定可能

ユースケース

• ドキュメント生成パイプラインにアーキテクチャ図やシーケンス図を組み込む
• テキスト形式のソースから、Wikiやチャットツール用の図を生成する
• チーム内向けのプライベートな図のレンダリングサービスを運用する
• ツールをローカルにインストールせず、Webアプリケーションに図のプレビューを埋め込む

クイックスタート

1. 1

   DockerでKrokiコンテナを実行します

   docker run -d -p 8000:8000 yuzutech/kroki
2. 2

   必要に応じて、docker-composeを使ってMermaid、BPMN、Excalidraw、またはdiagrams.net用のコンパニオンコンテナを起動します

   docker-compose up -d

使う前に知っておきたいこと

• !Mermaid、BPMN、Excalidrawなど、一部の図の種類では追加のコンパニオンコンテナを起動する必要があります。
• !diagrams.netとの連携は実験的です。

トピック

よくある質問

kroki とは？

PlantUML、Mermaid、D2、GraphVizなどのテキスト形式の図を、SVGやPNGなどの画像に変換する統合HTTP API。 Krokiは、単一のHTTP APIを通じて、テキスト形式の図の記述を画像に変換するゲートウェイです。ツールごとに個別のレンダラーをインストールする代わりに、1つのエンドポイントへ図のソースを送り、PlantUML、Mermaid、Graphviz、Ditaa、Excalidraw、Vega-Liteなどの図の種類と、出力形式を指定します。

kroki は無料で使えますか？ライセンスは？

kroki は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

kroki は今もメンテナンスされていますか？

活発にメンテナンス中。kroki の最終コミットは 2026年10月20日 です。

kroki は何に使えますか？

ドキュメント生成パイプラインにアーキテクチャ図やシーケンス図を組み込む テキスト形式のソースから、Wikiやチャットツール用の図を生成する チーム内向けのプライベートな図のレンダリングサービスを運用する ツールをローカルにインストールせず、Webアプリケーションに図のプレビューを埋め込む

kroki のインストール方法は？

DockerでKrokiコンテナを実行します: docker run -d -p 8000:8000 yuzutech/kroki 必要に応じて、docker-composeを使ってMermaid、BPMN、Excalidraw、またはdiagrams.net用のコンパニオンコンテナを起動します: docker-compose up -d

kroki はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/yuzutech/kroki