Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 0
Home
Leonard Ramminger edited this page Aug 11, 2026
·
4 revisions
Beez is a build and task orchestrator. Projects define pipelines in a Lua DSL (build.lua). Beez runs them with parallelism, caching, and a progress UI.
| I want to... | Start here |
|---|---|
| Understand how Beez works | Fundamentals |
Write a build.lua | Lua DSL |
Use beez.fs, beez.net, etc. | Lua API Overview |
| Configure Beez | Configuration |
| Understand caching | Caching |
| Understand phases and scopes | Phases and Scopes |
| Look up CLI flags | CLI |
| Scaffold a new project | Project Scaffolding |
| Tune terminal output | UI and Output |
| Contribute to Beez | Development and Contribution |
| Look up a term or flag | Appendix |
- Fundamentals - Core concepts, project layout, first pipeline
- Configuration - global, project, env, performance, cache, UI
- CLI - commands, flags, phases, steps, completion
- Lua DSL -
build.luareference: steps, tasks, workflows,ctx - Phases and Scopes - selection, workflows, CLI, design patterns
- Caching - step cache, success cache, invalidation
- UI and Output - output modes, progress, themes, summaries, logs
- Development and Contribution - build, tests, QA, PR workflow
- Appendix - glossary, quick reference, troubleshooting, full index
- Recipes (coming soon)
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
- Development and Contribution
- Building and Setup
- Repository Layout
- Testing
- Code Quality
- Feature Development Workflow
- Submitting Changes