Documentation Index
Fetch the complete documentation index at: https://errand.nuvrel.dev/llms.txt
Use this file to discover all available pages before exploring further.
Errand’s file format is defined in terms of HCL (HashiCorp Configuration Language). This page covers the HCL features that Errand uses. For the complete syntax definition, see the HCL native syntax specification.
Blocks
A block has a type, an optional name label, and a body enclosed in {}:
task "build" {
commands = ["go build ./..."]
}
task. The label is "build". The body contains one attribute.
Some blocks (like errand) take no label:
errand {
working_dir = "./src"
}
Attributes
An attribute assigns a value to a name:
description = "Build the project"
working_dir = "/tmp/build"
commands = ["go build ./...", "go vet ./..."]
= signs is optional but common for readability.
Strings
Strings are enclosed in double quotes. You can use ${} for expression interpolation:
commands = ["docker build -t ${var.image}:${var.tag} ."]
commands = [
<<-EOT
if [ "${var.env}" = "production" ]; then
echo "deploying to prod"
fi
EOT
]
Lists
Lists are written with square brackets. Items are separated by commas. A trailing comma is allowed:
depends_on = [task.lint, task.test]
commands = [
"go build ./...",
"go vet ./...",
]
// or #. Block comments use /* */:
// This task builds the project
task "build" {
# Run tests first
depends_on = [task.test]
commands = ["go build ./..."]
}
/* This is a
multi-line comment */
Expressions
Expressions can be literals, references, function calls, or combinations:
# String literal
description = "Build the project"
# Reference to a variable
commands = ["echo ${var.version}"]
# Function call
expression = lower(env("BUILD_ENV", "development"))
# Arithmetic and comparison (used in conditions)
condition = length(var.targets) > 0
