If you were able to install Kani normally, you do not need to build Kani from source. You probably want to proceed to the Kani tutorial.
In general, the following dependencies are required to build Kani from source.
NOTE: These dependencies may be installed by running the scripts shown below and don't need to be manually installed.
Kani has been tested in Ubuntu and macOS platforms.
Support is available for Ubuntu 20.04, 22.04, and 24.04. The simplest way to install dependencies (especially if you're using a fresh VM) is following our CI scripts:
# git clone [email protected]:model-checking/kani.git
git clone https://github.com/model-checking/kani.git
cd kani
git submodule update --init
./scripts/setup/ubuntu/install_deps.sh
# If you haven't already (or from https://rustup.rs/):
./scripts/setup/install_rustup.sh
source $HOME/.cargo/env
Support is available for macOS 11. You need to have Homebrew installed already.
# git clone [email protected]:model-checking/kani.git
git clone https://github.com/model-checking/kani.git
cd kani
git submodule update --init
./scripts/setup/macos/install_deps.sh
# If you haven't already (or from https://rustup.rs/):
./scripts/setup/install_rustup.sh
source $HOME/.cargo/env
Build the Kani package:
cargo build-dev
Then, optionally, run the regression tests:
./scripts/kani-regression.sh
This script has a lot of noisy output, but on a successful run you'll see at the end of the execution:
All Kani regression tests completed successfully.
To use a locally-built Kani from anywhere, add the Kani scripts to your path:
export PATH=$(pwd)/scripts:$PATHIf you're learning Kani for the first time, you may be interested in our tutorial.