Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Release Artifacts & Installation

Kroki-rs is distributed through several channels to support different platforms and integration needs.

1. Installation Channels

ChannelMethodPlatformBest For
Install Scriptcurl | shLinux, macOSQuickest setup, automatic PATH detection.
Homebrewbrew installmacOS, LinuxManaged updates and dependency handling.
GitHub ReleasesManual DownloadAll (Native)Air-gapped envs or specific version pinning.
Docker (GHCR)docker pullAll (OCI)Server deployments and dependency-free usage.

2. Install Script (Quickest)

The automated script detects your architecture and installs the optimized binary for your platform.

curl -sSfL https://raw.githubusercontent.com/softmentor/kroki-rs/main/install.sh | sh

3. Homebrew

For macOS and Linux users who prefer a package manager:

# Tap the repository
brew tap softmentor/kroki-rs

# Install the tool
brew install kroki-rs

4. GitHub Releases (Binaries)

Standardized native binaries are available for every release tag.

Available Platforms

Verification

Always verify the integrity of your download using the provided checksums.txt:

shasum -a 256 -c checksums.txt

5. Docker Images

The official multi-arch image is hosted on GitHub Container Registry (GHCR).

# Pull the latest version
docker pull ghcr.io/softmentor/kroki-rs:latest

# Or pin to a specific version
docker pull ghcr.io/softmentor/kroki-rs:v0.0.5

For detailed production instructions, see the Docker Deployment Guide.