Installation

grim is a single self-contained binary. Once it is on your PATH there is nothing else to configure. Pick the method that fits your setup — every one of them lands the same grim binary.

Recommended: install with ocx

ocx is an OCI-native package manager for pre-built binaries — the same idea as Grimoire, applied to executables instead of agent config. It is the recommended way to install grim: ocx resolves the right build for your platform, keeps the binary versioned in a local store, and upgrades it in place. Every Grimoire release is published to ocx.sh/grim.

Install ocx once — its installer wires up your shell so ocx-managed binaries land on PATH:

curl -fsSL https://setup.ocx.sh/sh | sh

On Windows, install ocx with PowerShell 7.4 or newer:

irm https://setup.ocx.sh/pwsh | iex

Then install grim and make it the current version:

ocx package install --select ocx.sh/grim

ocx.sh/grim resolves to the newest release; re-run the same command to upgrade. The grim package page lists every published version.

Install script

If you would rather not adopt ocx, the Grimoire site hosts a one-line installer. It detects your platform, downloads the matching archive from the GitHub release, verifies its SHA-256 checksum, and drops grim onto your PATH.

On macOS or Linux:

curl --proto '=https' --tlsv1.2 -LsSf https://michael-herwig.github.io/grimoire/install.sh | sh

On Windows, run it from PowerShell:

irm https://michael-herwig.github.io/grimoire/install.ps1 | iex

The installer is generated by cargo-dist and installs to ~/.cargo/bin by default; set GRIMOIRE_INSTALL_DIR to choose another directory. The archives it downloads are exactly the pre-built binaries listed below — reach for those when you want to pick the platform by hand or check the checksums yourself.

Pre-built binaries

Every release publishes archives for macOS, Linux, and Windows on both aarch64 and x86_64, each accompanied by a SHA-256 checksum and a CycloneDX software bill of materials. Download the latest from the releases page.

On Linux or macOS, download the right archive, extract it, and move the grim binary onto your PATH. Each archive also carries the license, README, and changelog alongside the binary:

curl -LO https://github.com/michael-herwig/grimoire/releases/latest/download/grimoire-x86_64-unknown-linux-gnu.tar.xz
tar -xf grimoire-x86_64-unknown-linux-gnu.tar.xz
install -m 0755 grim ~/.local/bin/grim

On Windows, unzip the archive and place grim.exe somewhere on PATH.

Build from source

With a Rust toolchain installed (Grimoire targets the stable 2024 edition), install straight from the repository:

cargo install --git https://github.com/michael-herwig/grimoire grimoire

Or clone and build a release binary at target/release/grim:

git clone https://github.com/michael-herwig/grimoire.git
cd grimoire
cargo build --release

Verify

grim --version

If the command prints a version string, you are ready for the Quick Start.