kurtosis-tech.github.io


Project maintained by kurtosis-tech Hosted on GitHub Pages — Theme by mattgraham

Installing & Upgrading

Interacting with Kurtosis is done via a CLI. The following methods are currently supported:

Installation

Homebrew

brew install kurtosis-tech/tap/kurtosis-cli

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.

Once the CLI is installed, the quickstart is a great place to get started.

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.


Back to index