Installation and requirements

Kallyup is the recommended bootstrapper for the Kalcite toolchain. Its scripts detect missing host requirements, install them when the operating system allows it, install Kallyup, and then install the selected toolchain profile.

Install with Kallyup

Choose minimal for Kalcite and Kally, developer to add the language server, or full to add the editor too.

# Linux and macOS
curl -fsSL https://raw.githubusercontent.com/Kalcite-Engine/kallyup/main/scripts/kallyup-bootstrap.sh | sh -s -- install developer

# Windows PowerShell
irm https://raw.githubusercontent.com/Kalcite-Engine/kallyup/main/scripts/kallyup-bootstrap.ps1 | iex; kallyup install developer

The Linux launcher supports APT, DNF, Pacman, and Zypper. It may ask for your password while installing system packages. On NixOS, it uses nix profile install to place Git, Curl, Cargo, Rust and the C toolchain in the user’s Nix profile; it does not use Rustup or mutate the system. On macOS, complete Apple’s Command Line Tools dialog once if it appears, then run the command again. On Windows, the launcher uses Winget, Chocolatey, or Scoop to install Git and downloads Rustup when Cargo is not present.

Kallyup does not alter your PATH. Add its Cargo binary directory to PATH after installation if your shell cannot find kalcite, kally, or an optional tool. Use --root DIR after the profile to choose a different installation directory.

Nix installation in a custom directory

With Nix already installed, Kallyup can keep each selected repository flake in a directory you choose and install the tools to a profile beside them:

kallyup install full --nix --flakes "$HOME/.local/share/kalcite-flakes"

The first run clones the selected flakes into DIR; the installed profile is DIR/profile. Kallyup asks whether it should refresh flake inputs with nix flake update before installing. Choose no to preserve the locked inputs, or use --refresh-flakes and --no-refresh-flakes for unattended installation. Add DIR/profile/bin to PATH to make the installed commands available.

Build from source

The workspace declares Rust 1.85 and edition 2024. Clone the authoritative source, then run:

cargo test --workspace

For NumWorks builds, install the thumbv7em-none-eabihf Rust target. Building an .nwa also needs Node.js and npx for the NumWorks tooling route.

The bootstrap scripts install source builds from the repositories’ main branches. Use a platform package or Nix flake when you need a reproducible, pinned build.