The instructions in this guide assume you already have Kurtosis installed, and will walk you through upgrading to the latest version of Kurtosis.
If you're looking to install Kurtosis, see here.
I. Check breaking changes
You can check the version of the CLI you're running with
kurtosis version. Before upgrading to the latest version, check the changelog to see if there are any breaking changes before proceeding with the steps below to upgrade.
II. Upgrade the CLI
- brew (MacOS)
- apt (Ubuntu)
- yum (RHEL)
- deb, rpm, and apk
brew update && brew upgrade kurtosis-tech/tap/kurtosis-cli
apt install --only-upgrade kurtosis-cli
yum upgrade kurtosis-cli
Download the appropriate artifact from the release artifacts page.
The Kurtosis CLI cannot be installed directly on Windows. Windows users are encouraged to use Windows Subsystem for Linux (WSL) to use Kurtosis.
III. Restart the engine
If you upgraded the CLI through a 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