-
Notifications
You must be signed in to change notification settings - Fork 0
Output Modes
Output mode controls what Beez prints to the terminal during a run. Set it in config with ui.output_mode or override it for one invocation with CLI flags.
| Mode | Config value | CLI flag |
|---|---|---|
| Clean (default) | clean |
(none) |
| Verbose | verbose |
--verbose |
| Errors | errors |
--error |
| Silent | silent |
--silent |
ui = {
output_mode = "clean",
}CLI flags take precedence over config for that run.
The default for day-to-day use.
- Shows a progress line for each step (default indicator: step counter such as
[1/5]). - On a TTY, progress can animate when
ui.animation.indicatoris a spinner style (minimal,dots, orcustom) with a positive spin interval. - Hides successful subprocess output.
- Prints failure output from failed commands.
- Prints a run summary at the end (style from
ui.summary).
Use clean when you want feedback without Ninja-style log spam.
Ninja-style output: every line from worker subprocesses is streamed to the console.
- Progress lines still appear (same as clean).
- Successful and failed command output is shown.
- Optional worker prefix (
ui.prefix,ui.prefix_formatin config) labels each line in verbose mode whenui.prefixis true. - Run summary is printed on success and failure.
ui = {
output_mode = "verbose",
prefix = true,
prefix_format = "[Worker {id}]",
}When prefix is false, verbose lines are indented with | instead of a worker label.
Minimal console output on success:
- No progress lines.
- No run summary when the build succeeds.
- On failure, failure output and the run summary are still printed.
- CLI error messages are still shown (unless silent).
Useful in scripts that only care about stderr when something breaks.
Almost no terminal output:
- No progress, command output, summaries, or CLI messages on stdout/stderr from the logger.
- Exit code remains the signal for success or failure.
Run logs and worker log files still follow ui.logging unless disabled separately.
Beez distinguishes two paths:
| Path | When | Shown in clean
|
Shown in verbose
|
|---|---|---|---|
| Command output | Step runs and streams stdout/stderr | only on failure | always |
| Failure output | Step fails | yes | yes |
In errors and silent modes, failure output follows the same rules as above (shown except in silent).
In modes that show progress (clean and verbose), Beez prints a short start banner:
Starting Workflow: build
============================================================
RunKind is Task, Workflow, Step, or Phase depending on what you invoked.
This banner is also written to the run log file when ui.logging.run_log is enabled.
- Progress and Animation - what progress lines look like
- Run Summaries - end-of-run formatting
- Logging and Log Files - disk logs independent of output mode
- Output and Logging Flags - CLI reference
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