Predefined variables

Terrabuild supplies predefined values for the current run, machine, project, and target.

Name	Description	Scope
terrabuild.configuration	Name of current configuration	Global
terrabuild.environment	Name of current environment	Global
terrabuild.branch_or_tag	Name of current branch or tag	Global
terrabuild.head_commit	Head commit hash	Global
terrabuild.retry	true if build is retried.	Global
terrabuild.force	true if build is forced.	Global
terrabuild.ci	true if build is running in known CI.	Global
terrabuild.engine	Container engine used.	Global
terrabuild.debug	true if debug is enabled.	Global
terrabuild.tag	Tag provided by user or nothing.	Global
terrabuild.note	Note provided by user or nothing.	Global
terrabuild.group	Build group identifier provided by user or nothing.	Global
terrabuild.os	darwin, windows, linux or nothing if unknown.	Global
terrabuild.arch	arm64, amd64 or nothing if unknown.	Global
terrabuild.project_slug	Slug of current project (relative path from workspace)	Target
terrabuild.project	Id of current project if defined	Target
terrabuild.phase	Name of current phase or nothing if the target is unphased	Target
terrabuild.target	Name of current target	Target
terrabuild.version	Version (hash) of current project	Target
project.<id>.version	Version (hash) of given project <id>	Target

Environment-sensitive inputs

Terrabuild classifies the following predefined values as environment-sensitive:

• terrabuild.environment
• terrabuild.branch_or_tag
• terrabuild.head_commit
• terrabuild.ci
• terrabuild.tag
• terrabuild.note
• terrabuild.group

When a selected target consumes one of these values directly or through a local or extension configuration, declare environment_sensitive = true on the project target or its workspace target default. A neutral consumer fails before operation resolution and reports every target and input that requires an opt-in. Opted-in sensitive value hashes participate in the target cache key. Diagnostic JSON, terrabuild explain, and the local console expose the status while keeping values hashed.