CLI

CLI

Beez is invoked from the project root (the directory that contains build.lua). Most commands load build.lua, merge configuration, then run a target or utility action.

Contents

• CLI Overview - syntax, invocation modes, exit codes
• Running Targets - tasks and workflows
• Filtering by Phase - -p / --phase
• Running a Single Step - -s / --step
• Listing Entities - --list
• Output and Logging Flags - --verbose, --silent, --error, log files
• Cache and Maintenance Flags - --no-cache, --clean-cache, --update
• Meta and Utility Commands - --dry-run, --show-config, completion, config discovery
• Project Scaffolding - beez --init (embedded Tempify, beta)
• CLI Flag Reference - all flags in one table

Quick examples

beez --init list                  # list Tempify templates (no build.lua)
beez --init basic_cpp ./my-app    # scaffold a project (see [[Project Scaffolding]])
beez build                    # run workflow or task named "build"
beez -p compile:code          # run phase compile, scope code
beez -s compile               # run one step by name
beez --list workflows         # list registered workflows
beez build --verbose          # verbose output for this run
beez build --no-cache         # disable caching for this run
beez --show-config            # print merged configuration

Related pages

• Configuration - settings that CLI flags override
• Fundamentals - steps, tasks, workflows, phases, scopes
• Project Layout - where to run beez from