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

Running in CI

Running Kurtosis on your local machine is nice, but executing it as part of CI is even better. This guide will walk you through modifying your CI config file to use Kurtosis in your CI environment:

Step One: Installing The CLI

You’ll need the Kurtosis CLI inside your CI environment. This can be accomplished by following the installation instructions for whichever package manager your CI container uses. E.g. if you’re using Github Actions with an Ubuntu executor, you’d add the instructions for installing the Kurtosis CLI via the apt package manager to your CI config file.

Step Two: Starting The Engine

You’ll need the Kurtosis engine to be running to use the engine API (which you’re likely using in your tests that use Kurtosis). Add kurtosis engine start in your CI config file after the CLI installation commands so that the engine API commands in your tests work properly.

Step Three: Run Your Custom Logic

This will be specific to whatever you want to run in CI. E.g. if you have Javascript Mocha tests that use Kurtosis, you’d put that in your CI config file after installing the Kurtosis CLI & starting the engine.


This is the relevant section of the CircleCI config file used by the testsuite used in the onboarding repo.

Back to index