Skip to content
Getting Started

Installation

kache requires Rust 1.95 or later and is built with the 2024 edition (Cargo.toml edition = "2024"). The binary is self-contained — no runtime dependencies.

Methods

mise downloads the pre-built binary from GitHub releases and pins the version per project or globally.

# install globally
mise use -g github:kunobi-ninja/kache@latest

# or pin a specific version
mise use -g github:kunobi-ninja/kache@0.5.0

To pin kache in your project so every contributor gets the same version, add it to your mise.toml:

[tools]
"github:kunobi-ninja/kache" = "latest"

Running mise install in the project root will install the pinned version.

cargo-binstall downloads the pre-built binary from GitHub releases without compiling.

cargo binstall kache

Every release (including RCs) is published to crates.io, so the plain crate name works. To install an unreleased branch build instead, use the --git form: cargo binstall --git https://github.com/kunobi-ninja/kache kache.

If a pre-built binary isn't available for your target, use the source install method below.

cargo install kache

This compiles kache with your local toolchain. It takes a couple of minutes and works on Linux, macOS, and Windows (with the MSVC toolchain). To build an unreleased branch instead, use cargo install --git https://github.com/kunobi-ninja/kache kache.

The methods above install the latest stable release. Release-candidates are published but never resolve as "latest", so request one explicitly: cargo install kache --version 0.6.0-rc.1 (or cargo binstall kache@0.6.0-rc.1).

OS package managers

kache is also published to Homebrew, APT, winget, Scoop, Chocolatey, and the AUR. Most have both a stable channel and an unstable channel (release-candidates / betas).

# Stable
brew install kunobi-ninja/kunobi/kache

# Unstable (RC/beta)
brew install kunobi-ninja/kunobi/kache-unstable

Install the signing key once, then add the repo — stable or unstable suite:

# Signing key (KMS-rooted OpenPGP cert), dearmored into a keyring
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://r2.kunobi.com/kache/apt/gpg.key \
  | sudo gpg --dearmor -o /etc/apt/keyrings/kache.gpg

# Stable
echo "deb [signed-by=/etc/apt/keyrings/kache.gpg] https://r2.kunobi.com/kache/apt stable main" \
  | sudo tee /etc/apt/sources.list.d/kache.list

# Unstable (RC/beta) — swap the suite instead:
# echo "deb [signed-by=/etc/apt/keyrings/kache.gpg] https://r2.kunobi.com/kache/apt unstable main" \
#   | sudo tee /etc/apt/sources.list.d/kache.list

sudo apt update && sudo apt install kache

Stable .debs also land in the unstable suite, so an unstable subscriber still receives GA releases.

# Stable
winget install kunobi-ninja.kache

# Unstable (RC/beta)
winget install kunobi-ninja.kache.Unstable

Add the Kunobi bucket once, then install from it:

scoop bucket add kunobi https://github.com/kunobi-ninja/scoop-kunobi

# Stable
scoop install kunobi/kache

# Unstable (RC/beta)
scoop install kunobi/kache-unstable

kache and kache-unstable both provide a kache command. With both installed, run scoop reset kache-unstable (or scoop reset kache) to choose which one the kache shim points at.

# Stable
choco install kache

# Unstable (RC/beta) — same package, pre-release versions
choco install kache --pre

The official prebuilt-binary package is kache-bin (statically linked, x86_64 + aarch64). Install it with your preferred AUR helper:

# paru
paru -S kache-bin

# yay
yay -S kache-bin

Supported platforms

Pre-built binaries are available for:

TargetNotes
x86_64-unknown-linux-muslStatically linked, works on any Linux
aarch64-unknown-linux-muslARM Linux (AWS Graviton, etc.)
x86_64-apple-darwinIntel macOS
aarch64-apple-darwinApple Silicon
x86_64-pc-windows-msvcWindows x64 (MSVC)
aarch64-pc-windows-msvcWindows ARM64 (MSVC)

Verify the installation

kache --version

You should see a version string like kache 0.5.0. If the command isn't found, make sure the binary is on your PATH (mise handles this automatically).

Next: enable kache for cargo

Installing the binary doesn't yet wire it into cargo. Run kache init to configure your cargo config (~/.cargo/config.toml, or the legacy ~/.cargo/config if that file already exists), install the daemon as a login service, and start it — see Quick start for the full walkthrough.

Available for:
Apple macOS logomacOSMicrosoft Windows logoWindowsLinux logoLinux
Download Kunobi