Installation
There are several ways to install Keel on your system.
Pre-built Binaries
The easiest way to get started is to download a pre-built binary from the releases page.
| Platform | File |
|---|---|
| Linux x86_64 | keel-vX.Y.Z-linux-x86_64.tar.gz |
| Windows x86_64 | keel-vX.Y.Z-windows-x86_64.zip |
Linux:
curl -L https://codeberg.org/Keel/keel-cli/releases/download/v0.0.20/keel-v0.0.20-linux-x86_64.tar.gz | tar xz
sudo mv keel /usr/local/bin/
Windows: Download keel-vX.Y.Z-windows-x86_64.zip from the releases page, extract it, and add the directory to your PATH.
Using Nix Flakes
The easiest way to get started with Keel is using Nix Flakes:
# Run directly without installing
nix run git+https://codeberg.org/Keel/keel-cli
# Or build the package
nix build git+https://codeberg.org/Keel/keel-cli
# Enter a development shell
nix develop git+https://codeberg.org/Keel/keel-cli
Building from Source
If you prefer to build from source:
# Clone the repository
git clone https://codeberg.org/Keel/keel-cli.git
cd keel-cli
# Build and install
cargo install --path .
This provides a single keel binary with all tools:
keel run <file>— Execute a Keel filekeel check <file>— Type-check without executingkeel repl— Start the interactive REPLkeel tui— Open the terminal UI (REPL + environment inspector + DataFrame viewer)keel fmt— Format source codekeel lsp— Start the language serverkeel init— Create a new project from a templatekeel templates— List available project templateskeel trace— Inspect compiler pipeline phases (AST, types, bytecode, execution)keel info— Show project manifest and permissionskeel flow— Show data flow graph between task fileskeel graph— Show file dependency graphkeel list— List.klfiles in the project
Individual Tools
If you prefer standalone binaries, each tool is also available as a separate package:
Jupyter Kernel (Optional)
For Jupyter notebook support, install the kernel separately:
cargo install --git https://codeberg.org/Keel/keel-jupyter-kernel
install-keel-kernel
See the Jupyter guide for details.
Prerequisites
- For Nix: Nix 2.4+ with flakes enabled
- For Source: Rust 1.85+ and Cargo (keel-core uses edition 2024)
Verify Installation
After installation, verify Keel is working:
keel --version
Next Steps
Now that you have Keel installed, proceed to Hello World to write your first program.