Skip to content

lock

benchbar.toml, the team lockfile: each app’s repo, branch and commit, and the sites. The guide is Teams. Every command takes --lock PATH; without it benchbar uses BENCHBAR_LOCK, then the path remembered for the bench, then <bench>/benchbar.toml.

lock write

benchbar lock write [--lock PATH] [--no-commits] [--allow-dirty]

Writes the lockfile from this bench. It asks, shows the diff, and backs up the old file.

FlagWhat it does
--lock PATHWhere to write it; the path is remembered for the bench
--no-commitsPin branches only, no commits
--allow-dirtyWrite it even when an app has local changes

Exit codes: 0 written or unchanged; 1 declined or refused.

Terminal window
benchbar lock write --lock apps/acme/benchbar.toml

lock check

benchbar lock check [--lock PATH] [--json]

Compares the bench with the lockfile. Read only: no network, no database.

FlagWhat it does
--jsonThe differences as JSON (schema)

Exit codes: 0 the bench matches; 1 any difference, or no readable lockfile.

Terminal window
benchbar lock check --json

lock apply

benchbar lock apply [--lock PATH] [--dry-run] [--yes]

Clones missing apps, switches clean apps to the locked branch, fast forwards to pinned commits, then runs requirements and build. It never touches a site (it prints the site add, app install and migrate steps instead) and never overwrites local work: an app with local changes or commits of its own is skipped with a warning.

FlagWhat it does
--dry-runPrint what would change
-y, --yesApply without asking

Exit codes: 0 applied or nothing to do; 1 a step failed.

Terminal window
benchbar lock apply --dry-run