Terramate Metadata Variables
Terramate supports access to metadata of stacks, projects and the repository in the
Project metadata is the same independent of a stack.
terramateobject provides access to project metadata.
version(string) The Terramate version.
stacks.list(list of strings) List of all stacks inside the project. Each stack is represented by its absolute path relative to the project root. The list will be ordered lexicographically.
root.path.fs.absolute(string) The absolute path of the project root directory. Will be the same for all stacks.
root.path.fs.basename(string) The base name of the project root directory. Will be the same for all stacks.
terramate.stackobject grants access to stack metadata and is only available in the stack context. The following keys are available in the
terramate.stackobject and can be accessed with
id(string) The user-defined
idof the stack.
name(string) The user-defined
nameof the stack.
description(string) The user-defined
descriptionof the stack.
tags(list of string) The user-defined
tagsof the stack.
path(object) An object defining the path of a stack within the repository in different ways
absolute(string) The absolute path of the stack within the repository.
basename(string) The base name of the stack path.
relative(string) The relative path of the stack from the repository root.
to_root(string) The relative path from the stack to the repository root (upwards).
terramate.stacksobject grants access to a list of all stacks The following keys are available in the
terramate.stacks.object and can be accessed with
list(list of string) A list of all absolute stack paths in the current repository.