Esc
Start typing to search...

Installation

There are several ways to install Keel on your system.

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 file
  • keel repl — Start the interactive REPL
  • keel fmt — Format source code
  • keel lsp — Start the language server

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.70+ and Cargo

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.