CLI Flag Reference

CLI Flag Reference

Complete list of flags supported by Beez as of the current CLI implementation.

General

Flag	Short	Argument	Description
--help	-h		Show help and exit (0)
--version	-v		Show Beez and Lua version; exit 0
--init		Tempify args	Run Tempify project scaffolding; all following args passed through. See Project Scaffolding. Does not need build.lua. Beta.

Execution targets

Flag	Short	Argument	Description
--list		tasks, workflows, steps, phases	List registered entities
--phase	-p	phase spec	Run phase (and optional scopes)
--step	-s	step name	Run a single step
target		name	Run task or workflow (positional)

See Running Targets, Filtering by Phase, Running a Single Step, Listing Entities.

Output and logging

Flag	Argument	Description
--verbose		Verbose (Ninja-style) output
--silent		No output; exit code only
--error		Errors only
--log-file	PATH	Write run log to PATH
--no-log-file		Disable run log

Mutually exclusive: --verbose, --silent, --error.

See Output and Logging Flags.

Cache

Flag	Description
--no-cache	Disable step and success cache
--clean-cache	Remove configured cache directory before run (default: .cache/)
--update	Apply cache storage updates for the active configuration (recompress to match compression settings)

See Cache and Maintenance Flags.

Performance

Flag	Short	Argument	Description
--threads	-j	1-1024	Max worker threads

Run control

Flag	Description
--dry-run	Load build.lua, build the graph, show progress; skip shell commands and Lua callbacks (CLI help: "without executing Lua scripts")
--install	Install all dependencies declared in reqpack { ... } via ReqPack (rqp), then exit (does not run a target). Combine with --dry-run to print the rqp command only. See ReqPack Declaration.

Dependencies (ReqPack)

Flag	Description
--install	Force-install every package in the reqpack block. Requires build.lua and rqp on PATH.

On normal runs (without --install), Beez installs only plugins whose reqpack declaration changed since the last successful install (cache under .cache/reqpack/).

Configuration

Flag	Argument	Description
--show-config		Print merged config (needs build.lua)
--config-options	[PATH]	List config keys or enum values
--complete-config-options	[PREFIX]	Completion helper for config paths

Shell completion

Flag	Argument	Description
--dump-completion	bash or zsh	Print completion script
--install-completion		Install completion in shell rc

Pass-through

Form	Description
-- followed by args	Stored as userOptions; not used yet

Config overrides (summary)

Flag	Setting affected
--verbose	ui.output_mode
--error	ui.output_mode
--silent	ui.output_mode
--dry-run	Run-only: skip shell commands and Lua step callbacks (not a config file key)
--no-cache	cache.enabled
-j N	performance.max_threads
--log-file PATH	ui.logging.run_log, run_log_file
--no-log-file	ui.logging.run_log = false

Invocation priority

When multiple run modes are specified:

1. --list
2. -s / --step
3. -p / --phase
4. positional target

Phase argument grammar (-p)

Form	Example
phase	compile
phase:scope	compile:code
phase:scope1,scope2	test:unit,integration
phase["s1","s2"]	generate["code","docs"]

Requires build.lua

Needs build.lua	Does not need build.lua
target, -p, -s, --list	-h, -v
--show-config	--init (embedded Tempify; see Project Scaffolding)
--clean-cache, --update	--config-options
--install	--complete-config-options
	--dump-completion, --install-completion

Related pages

• CLI Overview
• Project Scaffolding
• Configuration
• Config Reference
• Appendix