CLI reference

Global options

Flag	Description
-c, --config PATH	Path to config file
-v, --verbose	Debug logging
-q, --quiet	Errors only
--version	Print version
--license	Print license text

bitrab run

Execute the pipeline.

bitrab run [options]

Flag	Description
--dry-run	Show what would execute
--parallel N, -j N	Maximum local concurrency
--jobs JOB...	Run only named jobs
--stage STAGE...	Run only selected stages
--no-tui	Disable the Textual interface
--parallel-backend {thread,process}	Override the configured parallel executor backend
--serial	Run one job at a time in the project root and disable worktrees
--no-worktrees	Disable per-job git worktree isolation for parallel runs
--offline	Resolve remote includes only from the locked vendor snapshot
--changed	Run affected jobs, unknown-input jobs, and needs: dependents
--changes-base REF	Override the local git comparison baseline
--no-include-cache	Bypass transparent remote-include cache reads and writes

Running plain bitrab is equivalent to bitrab run.¹

bitrab watch

Re-run the pipeline when the root config or local include files change.

bitrab watch
bitrab watch --dry-run

Supports the same --parallel, --jobs, and --stage filters as run.²

bitrab list

List jobs grouped by stage.

bitrab list

bitrab validate

Validate the configuration.

bitrab validate
bitrab validate --json
bitrab validate --offline
bitrab validate --no-include-cache

This performs schema validation, capability checks, and semantic checks.¹³

bitrab vendor

Snapshot the recursive remote include graph for reproducible and network-free use.

bitrab vendor
bitrab vendor --check

See Vendoring and offline mode for the lockfile and payload contract.

bitrab install-hook

Install the changed-job fast path as a managed git pre-push hook:

bitrab install-hook
bitrab install-hook --uninstall

The hook runs bitrab run --changed --incremental --no-tui. Skip it once with git push --no-verify, or set BITRAB_SKIP_HOOK=1. Existing shell hooks are preserved and chained; non-shell hooks are never overwritten.

bitrab graph

Render the pipeline structure.

bitrab graph
bitrab graph --format dot

text is the default. dot emits Graphviz DOT output.⁴

bitrab debug

Show quick environment and pipeline facts.

bitrab debug

bitrab clean

Clean .bitrab/ workspace data.

bitrab clean
bitrab clean --dry-run
bitrab clean --what artifacts

bitrab logs

Manage persisted run logs.

bitrab logs
bitrab logs show
bitrab logs rm --keep 5

bitrab folder

Inspect or clean the .bitrab/ folder with a size breakdown.

bitrab folder
bitrab folder clean --dry-run

bitrab lint

Reserved for GitLab server-side linting. The command exists, but today it only reports that server-side linting is not implemented yet.¹

---

1. Source: bitrab/cli.py ↩↩↩

2. Source: bitrab/watch.py ↩

3. Source: bitrab/config/validate_pipeline.py and bitrab/config/capabilities.py ↩

4. Source: bitrab/graph.py and bitrab/folder.py ↩