Boof Runner v0.2.0

Boof Runner headless CLI

Drive Boof Runner from the command line: run, scan and serve commands, flags and environment variables.

Headless CLI (no web server)

The runner can be driven entirely from the command line — no web UI required. All commands share -d, --data <path> (data root, or $BOOF_RUNNER_DATA_ROOT).

bash
# Run a single prompt through planner → developer → reviewer and stream progress.
# Exits non-zero if the task fails or parks for answers.
boof-runner run "Add a rate limiter to the API" --repo /path/to/repo
boof-runner run --file task.md --repo /path/to/repo   # prompt from a file
boof-runner run --all                                 # drive the whole pending queue

# SCAN MODE — turn a boof-seeded repo's unfinished units into tasks.
# Walks <repo> for goal.boof.xml files whose current status is not `done`,
# creating one task per unit (ordered by plan.boof.xml order + depends-on, so a
# unit's dependencies run first). Each task instructs the developer to implement
# the unit strictly from its goal.boof.xml, TDD; on success the runner appends a
# <version> to that goal file bumping its status.
boof-runner scan /path/to/repo --dry-run   # list what it would create
boof-runner scan /path/to/repo             # create the tasks
boof-runner run --all -d ./data            # then drive them to completion

Useful flags: --repo <dir> (working directory the pipeline runs against — a git repo enables worktree isolation), --base <ref> (branch or commit the task's worktree starts from instead of HEAD), --title <text> (task title, default the first line of the prompt), --tool <id>/--model <name> (force all roles to one tool, e.g. --tool mock for offline runs), --runs <n> (iterate a task N times), and, for scan, --bump review|done (status recorded on success, default done).

scan/run are universal: nothing about any specific project is hardcoded — the target repo is always taken from the argument.

Options (serve — the default command)

FlagEnvDefaultDescription
-d, --data <path>BOOF_RUNNER_DATA_ROOT./dataData root directory
-p, --port <n>BOOF_RUNNER_PORT4319Web server port
--no-runner—runner onStart the web server only
-h, --help——Show help

Run boof-runner --help for the full command reference (serve, run, scan).

Edit this page on GitHub Last updated