Skip to content

Listing Entities

Leonard Ramminger edited this page Aug 9, 2026 · 1 revision

Listing Entities

Use --list to print what build.lua registered. Requires build.lua in the current directory.

beez --list tasks
beez --list workflows
beez --list steps
beez --list phases

Allowed kinds

Kind Output
tasks Table of task names
workflows Table of workflow names
steps Table: name, phase, scope, description
phases Table: phase name and list of scopes

Any other value is a parse error.

Example output

Tasks / workflows (name column only):

tasks:

| Name   |
|--------|
| clean  |
| hello  |

Steps:

steps:

| Name    | Phase    | Scope   | Description        |
|---------|----------|---------|--------------------|
| compile | compile  | code    | Build binaries     |

Phases:

phases:

| Phase    | Scopes              |
|----------|---------------------|
| compile  | [code]              |
| generate | [code, docs]        |

Empty description shows as -.

Use cases

  • Discover available workflows before running CI locally
  • Check phase/scope names for -p
  • Find exact step names for -s
  • Debug build.lua registration

Does not run anything

--list loads build.lua, prints the table, and exits 0. It does not execute steps or tasks.

Combining with other modes

--list has the highest invocation priority. If present, Beez lists and exits; targets, -p, and -s are not executed.

Next steps

Clone this wiki locally