Lua DSL

build.lua (Lua DSL)

build.lua is the project manifest for Beez. It is a Lua script that registers tasks, steps, workflows, and project settings. Beez loads it once at startup, builds an internal registry, then runs what you invoke on the CLI.

Contents

• DSL Overview - how loading works, available globals, errors
• Step Declaration - step({ ... })
• Task Declaration - task(...)
• Workflow Declaration - workflow(...)
• Order Declaration - order(before, after)
• Configure Step - configure_step(name, config)
• Beez API - beez.config(), beez.env()
• Step Context - the ctx object in Lua callbacks
• DSL Patterns - common recipes (incremental checks, workers, config)

Minimal example

beez.config(require("config"))

step({
    name = "compile",
    phase = "build",
    scope = "default",
    run = "cmake --build build",
})

workflow("build", {
    { phase = "build", scope = "default" },
})

task("clean", "rm -rf build")

beez build
beez clean
beez -s compile

Related pages

• Fundamentals - concepts (step, task, workflow, phase, scope)
• CLI - how to run what you declare
• Configuration - beez.config() settings
• Caching - input / output / mutate and success cache