Skip to main content
Version: 0.83.13

read_file

The read_file function reads the contents of a file specified by the given locator, and requires that the Starlark script is part of a package. read_file executes at interpretation time so the file contents won't be displayed in the preview.

read_file(
# The Kurtosis locator of the file to read.
# MANDATORY
src = "LOCATOR",
)

For example:

# Reading a file from a remote package using an absolute locator
remote_contents = read_file(
src = "github.com/kurtosis-tech/datastore-army-package/README.md",
)

# Reading a file from inside the same package using a relative locator
local_contents = read_file(
src = "./file.txt",
)