-
Notifications
You must be signed in to change notification settings - Fork 0
FAQ and Troubleshooting
General problems when using Beez. For cache-specific issues see Caching Troubleshooting.
Beez looks for build.lua in the current working directory. The CLI prints:
Error: build script not found: <path>/build.lua
cd /path/to/your/project
beez buildCommands that do not need build.lua: -h, -v, --config-options, --complete-config-options, --dump-completion, --install-completion.
Commands that do need it: targets, -p, -s, --list, --show-config, --clean-cache, --update, --install.
If build.lua contains reqpack { ... } and Beez cannot find the rqp executable:
ReqPack (rqp) is required to install dependencies. Install it with:
curl -fsSL https://raw.githubusercontent.com/Coditary/ReqPack/main/install.sh | sh
Install ReqPack, ensure rqp is on PATH, then rerun. Use beez --install to install all declared packages without running a target. See ReqPack Declaration.
Beez prints per-package errors when rqp returns structured JSON output, for example:
reqpack install failed:
npm:vitest: plugin action failed
Fix the failing package or plugin configuration, then run beez --install again.
The file exists but Lua failed to parse or execute it. At load time the CLI prints:
Error: failed to load build script: <path>/build.lua
During a run, the orchestrator may report failed to load build.lua for the same class of problem.
- Check syntax errors (missing comma, unclosed brace)
- Read the
Lua error:orDSL error:line printed before the generic message - Confirm
require("config")paths exist when usingbeez.config(require("config")) - Ensure only supported Lua libraries are used in the DSL sandbox (
baseandpackage)
The CLI target, step, task, or workflow name does not exist.
beez --list tasks
beez --list workflows
beez --list stepsCommon causes:
- Typo in
beez my-target - Step exists but no task/workflow exposes it (use
beez -s stepnameor add a workflow) - Phase filter
-pmatches no registered steps
Rare orchestrator error when the phase name is empty internally. It is not the usual message for a bad -p argument.
| Situation | Result |
|---|---|
Malformed -p syntax (e.g. generate:, generate:code,) |
Parse error, help printed, exit 1
|
| Valid phase with no registered steps | Success, exit 0, nothing executed |
| Valid phase but wrong scope | Success for that scope if empty; no steps run |
For phase and scope issues:
- Use
beez --list phasesto see registered phases - Check scope spelling:
compile:codenotcompile/code - Comma-separated scopes run sequentially; bracket syntax selects explicit scope lists
See Filtering by Phase and Selecting with Phases and Scopes.
order() declared a dependency cycle, or two steps with overlapping mutate patterns could not be ordered.
- List steps in that phase+scope:
beez --list steps - Review
order()declarations for cycles - Ensure ordered step names match registered
namefields exactly
See Order Declaration and Parallel Execution and Dependencies.
A shell command returned non-zero or a Lua callback returned a non-zero exit code.
- Re-run the failing step:
beez -s stepname --verbose - Check worker logs in
.cache/logs/workers/(whenui.logging.workersallows) - Inspect the run log at
ui.logging.run_log_file
See Caching Troubleshooting. Quick checks:
- Step has
input,output, ormutatepatterns - Output files still exist on disk
-
--no-cachenot set;cache.enabledis true - Changed files are covered by
input/mutateglobs - Toolchain env vars are in
env.hash_vars
beez --clean-cache buildThen verify artifact patterns and env fingerprint settings. See Cache Keys and Invalidation.
--silent or ui.output_mode = "silent" suppresses almost all terminal output. Use echo $? to read the exit code, or run with --verbose.
Requires a valid build.lua in the current directory so project config can load.
Check merge order: global → project → env → CLI. Inspect effective values:
beez --show-configCLI flags override file config for the same run. See Configuration Overview.
ui.theme must name an entry in ui.themes. Fix the name or define the palette table. Beez validates the theme when UI settings are resolved (at run time or with --show-config), not when parsing beez.config().
-
performance.max_threadscaps workers (-jon CLI) - Steps in the same phase+scope without
order()can run in parallel; ordered steps wait on predecessors - A workflow runs its steps sequentially; only
parallelgroups overlap
See Parallel Execution and Dependencies and Performance Settings.
beez --install-completion
# restart shell or source rc fileOr manually: beez --dump-completion zsh. See Meta and Utility Commands.
Beez parses userOptions after -- but does not pass them to steps yet. Pass values via environment variables or step config instead.
| Log | Default path |
|---|---|
| Run log | .cache/logs/latest.log |
| Worker logs | .cache/logs/workers/ |
Configure under ui.logging. See Logging and Log Files.
| Goal | Command / page |
|---|---|
| List entities | beez --list steps |
| Inspect config | beez --show-config |
| Schema keys | beez --config-options |
| Dry run graph | beez build --dry-run |
| Verbose subprocess output | beez build --verbose |
- Caching Troubleshooting - cache hits and misses
- Quick Reference - common commands
- Appendix - appendix index
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