Repository navigation
Progress and Animation
While steps run, Beez updates a progress line for each unit of work. In clean mode on an interactive terminal, non-cached steps can use an animated spinner instead of printing a new line per step.
Each progress event has:
-
Category - the step phase name, or
stepwhen no phase is set. -
Detail - the step
descriptionif set, otherwise the step name.
Example:
compile | Compile shaders
Cached steps append (cached) to the category and use the cache_hit theme color:
compile (cached) | Compile shaders
When ui.hide_cache_hits = true, Beez does not print progress lines for cache hits. The internal progress counter still advances, so indicators and summaries stay consistent.
ui = {
hide_cache_hits = true,
}ui = {
animation = {
progress = "minimal",
indicator = "step",
indicator_spin_interval = 80,
},
}Legacy keys ui.animation.spinner and nested progress.numbers are still accepted for compatibility.
| Value | Result |
|---|---|
minimal |
Indicator + category + detail (no bar) |
lines |
Bar with line characters + indicator + text |
blocks |
Bar with block characters + indicator + text |
custom |
Bar from a custom table (see below) |
Custom progress table (also used when progress is a table):
ui = {
animation = {
progress = {
start = "[",
end_delimiter = "]",
fill = "=",
empty = "-",
indicator = "percent", -- optional, same as top-level indicator
},
},
}Controls the leading segment (step counter, percent, or spinner).
| Value | Behavior |
|---|---|
step |
Current index and total, e.g. 3/12
|
percent |
Rounded percentage |
minimal |
Compact spinner (` |
dots |
Animated dot spinner (requires icons = true for default frames) |
custom |
Cycles through custom frames |
Custom indicator as a frame list:
ui = {
animation = {
indicator = { "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" },
indicator_spin_interval = 80,
},
}Custom indicator as a config table:
ui = {
animation = {
indicator = {
type = "custom",
frames = { "|", "/", "-", "\\" },
start = "[",
end_delimiter = "]",
spin_interval = 100,
},
},
}indicator_spin_interval is in milliseconds. Animation runs only when the interval is greater than zero and the indicator style uses a spinner.
Animated spinners are used when all of these hold:
- Output mode is
clean - stdout is a TTY
- The step is not a cache hit
- The indicator style is spinner-based (
minimal,dots, orcustomframes) -
indicator_spin_intervalis greater than 0
Otherwise Beez prints a full progress line per step (still respecting hide_cache_hits).
If icons = false and the indicator would be dots, Beez falls back to minimal automatically.
ui.log_level filters Beez's own log messages (info, warn, error). It applies to console and run log loggers.
ui = {
log_level = "warn",
}This does not suppress progress lines or subprocess output; use Output Modes for that.
- Output Modes - which modes show progress
- Colors and Themes - colors used on progress lines
- Caching - cache hits in progress output
-
Step Declaration -
descriptionandphasefields
Quick Reference · Glossary · FAQ
- Fundamentals
- Core Concepts
- Project Layout
- First Pipeline
- Phases and Scopes
- How Phases and Scopes Work
- Selecting with Phases and Scopes
- Designing Phases and Scopes
- Parallel Execution and Dependencies
- Configuration
- Configuration Overview
- Global User Config
- Project Config
- Environment Variables
- Performance Settings
- Cache Settings
- Config Reference
- CLI
- CLI Overview
- Running Targets
- Filtering by Phase
- Running a Single Step
- Listing Entities
- Output and Logging Flags
- Cache and Maintenance Flags
- Meta and Utility Commands
-
Project Scaffolding —
beez --init(embedded Tempify) - CLI Flag Reference
- Lua DSL
- DSL Overview
- Plugin System — Plugins, Config DSL, Standard-Workflows
- Step Declaration
- Task Declaration
- Workflow Declaration
- Order Declaration
- Configure Step
- ReqPack Declaration
- Beez API
- Step Context
- DSL Patterns
- Caching
- Caching Overview
- Step Cache
- Success Cache
- Glob Metadata Cache
- Artifact Patterns
- Cache Keys and Invalidation
- Cache Storage and Maintenance
- Caching Troubleshooting
- UI and Output
- Output Modes
- Progress and Animation
- Colors and Themes
- Run Summaries
- Logging and Log Files
- Development and Contribution
- Building and Setup
- Repository Layout
- Testing
- Code Quality
- Feature Development Workflow
- Submitting Changes