-
Notifications
You must be signed in to change notification settings - Fork 0
Run Summaries
At the end of a run, Beez prints a summary block (unless output mode suppresses it). Choose the style with ui.summary.
ui = {
summary = "simple",
show_time_saved = true,
}Allowed values: minimal, simple, compact, data.
| Output mode | Summary on success | Summary on failure |
|---|---|---|
clean |
yes | yes |
verbose |
yes | yes |
errors |
no | yes |
silent |
no | no |
Summaries are preceded by a separator line:
============================================================
Short one-liner:
Build successful in 12.3s!
or on failure:
Build failed after 4.1s.
When all of these are true, an extra line is printed above the separator:
summary = "minimal"show_time_saved = true- At least one cache hit occurred
Example:
Saved time on 5 cache hits
============================================================
Build successful in 2.1s!
For other summary styles, time saved is folded into the main summary text instead (see below).
Single line with duration, cache stats, worker peak, and optional saved time:
✓ Build finished in 12.3s | 8/10 cached | peak 4 workers | saved ~45s
Failure variant:
✗ Build failed after 4.1s | 2/5 cached | peak 2 workers
The saved ~Ns suffix appears when show_time_saved = true and estimated savings are greater than zero. Icons depend on ui.icons.
Boxed summary with labeled rows:
╭──────────────────────────────────╮
│ BUILD SUCCESSFUL │
├──────────────────────────────────┤
│ Time 12.3s │
│ Saved ~45s │
│ Cache 8/10 │
│ Peak 4 workers │
╰──────────────────────────────────╯
On failure, a Phase row names the first failed segment (workflow phase or scope) when segment data is available.
show_time_saved controls the Saved row the same way as in minimal mode.
Multi-line table broken down by segment (phase/scope) when the run tracked segments:
=================================================
PHASE | STATUS | TIME | CACHE HIT
-------------------------------------------------
compile | ✓ PASS | 8.2s | 80% (4/5)
test | ✓ PASS | 3.1s | 50% (1/2)
-------------------------------------------------
TOTAL | PASS | 12.3s | 67% overall
=================================================
When no segments were recorded, the table collapses to a single run row.
Summaries include aggregate run statistics:
| Field | Meaning |
|---|---|
| Cache hits / total steps | Steps skipped by cache vs planned steps |
| Peak workers | High-water mark of parallel workers |
| Estimated time saved | Derived from cached step timings when available |
Per-segment rows (data only) |
Name, pass/fail, duration, cache hit rate |
- Output Modes - when summaries are suppressed
- Caching - how cache hits affect summary numbers
- Colors and Themes - icons and colors in summaries
-
Phases and Scopes - segment names in
dataandcompactviews
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