kurtosis-yml.md

title	sidebar_label
kurtosis.yml	kurtosis.yml

:::info The kurtosis.yml is part of the Kurtosis package system. To read about the package system in detail, see here. :::

The kurtosis.yml file is a manifest file necessary to turn a directory into a Kurtosis package. This is the spec for the kurtosis.yml:

# The locator naming this package.
name: github.com/package-author/package-repo/path/to/directory-with-kurtosis.yml

Example usage:

if kurtosis.yml is in the repository root:

name: github.com/author/package-repo

if kurtosis.yml is in a directory other than repository root:

name: github.com/author/package-repo/path/to/directory-with-kurtosis.yml

:::info The key take away is that /path/to/directory-with-kurtosis.yml only needs to be provided if kurtosis.yml is not present in the repository's root. :::