Installing The CLI
Interacting with Kurtosis is done via a CLI. The instructions below will walk you through installing it.
Kurtosis supports tab completion, and we strongly recommend installing it after you install the CLI.
Homebrew
brew install kurtosis-tech/tap/kurtosis-cli
NOTE: Homebrew might warn you that your Xcode is outdated, like so:
Error: Your Xcode (11.5) is too outdated.
Please update to Xcode 12.5 (or delete it).
This is a Homebrew requirement, and has nothing to do with Kurtosis (which ships as prebuilt binaries). To update your Xcode, run:
xcode-select --install
apt
echo "deb [trusted=yes] https://apt.fury.io/kurtosis-tech/ /" | sudo tee /etc/apt/sources.list.d/kurtosis.list
sudo apt update
sudo apt install kurtosis-cli
yum
echo '[kurtosis]
name=Kurtosis
baseurl=https://yum.fury.io/kurtosis-tech/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/kurtosis.repo
sudo yum install kurtosis-cli
deb, rpm, and apk
Download the appropriate artifact from the release artifacts page.
Kurtosis CLI cannot be installed directly on Windows. Windows users are encouraged to use Windows Subsystem for Linux (WSL) to use Kurtosis.
Once you're done, the quickstart is a great place to get started.
Analytics
On installation Kurtosis enables anonymized analytics by default. In case you want to disable
it you can run kurtosis analytics disable.
Upgrading
You can check the version of the CLI you're running with kurtosis version. To upgrade to latest, check the changelog to see if there are any breaking changes and follow the steps below.
NOTE: if you're upgrading the CLI's minor version (the Y in a X.Y.Z version), you may need to restart your Kurtosis engine after the upgrade. If this is needed, the Kurtosis CLI will prompt you with an error like so:
The engine server API version that the CLI expects, 1.7.4, doesn't match the running engine server API version, 1.6.8; this would cause broken functionality so you'll need to restart the engine to get the correct version by running 'kurtosis engine restart'
The fix is to restart the engine like so:
kurtosis engine restart
Homebrew
brew upgrade kurtosis-tech/tap/kurtosis-cli
apt
apt install --only-upgrade kurtosis-cli
yum
yum upgrade kurtosis-cli
deb, rpm, and apk
Download the appropriate artifact from the release artifacts page.