Skip to content
This repository has been archived by the owner on Dec 14, 2022. It is now read-only.

kurtosis-tech/zz-deprecated-kurtosis-module-api-lib

Repository files navigation

DEPRECATION NOTICE

This has been replaced in favor of Starlark Packages

Kurtosis Module API LIB

What's a module?

A Kurtosis module is a package of code with a connection to the Kurtosis engine that runs inside the Kurtosis environment. You can think of a module like a language-agnostic library, which allows for tests to be written in seconds from preexisting components. Simple modules might only have an "execute" command, while more complex modules might respond to multiple commands.

For more details on modules, see these docs.

What's in this repo?

  • A definition of the Kurtosis module API
  • A client for communicating with that API
  • Scaffolding for building a module

How do I write my own module?

Visit the Module Starter Pack which has everything you need to get going.