Skip to content

doctor and repair

What each check means, and its fix, is in the Doctor and repair guide. Both commands take the options for every command.

doctor

benchbar doctor [--json | --fix-hints] [--quick] [--ack CHECK | --unack CHECK] [--prerequisites] [--fetch] [--bench-dir DIR] [--profile NAME]

The read only health report. Every check prints [OK], [WARN] or [FAIL], and a fix: line with the exact command follows every WARN and FAIL. It changes nothing (except --ack and --unack, which write one line to the bench’s state file), never reads the Keychain and never touches the network unless you pass --fetch.

FlagWhat it does
--jsonEvery check with its id, level, fix_command and action (schema)
--fix-hintsOnly the fix commands of FAIL and WARN checks, failures first, one per line, each once; nothing else on stdout
--quickSkip the slow checks (those that start brew, python, node, bench or git, or ask the site) and name them. --json has quick: true and skipped_checks
--ack CHECKSilence one named WARN for this bench until its message changes. The check stays in --json with acked: true; the text output and --fix-hints leave out its fix. A FAIL cannot be acknowledged
--unack CHECKUndo --ack
--prerequisitesWhat this Mac needs before an install, without a bench: Apple Silicon, macOS 14, the Command Line Tools, Homebrew, free disk, a bench folder outside iCloud Drive, Desktop and Documents, CleanMyMac, Mole and the default ports (on Linux: disk, folder and ports). --bench-dir names the folder a new bench would go to
--fetchFirst git fetch the branches of the apps your focus apps need, for dependency_behind (20 seconds each, no prompt; only .git changes; not with OFFLINE=1 or --dry-run)
--bench-dir DIRThe bench to check
--profile NAMECheck against another release profile than the remembered one

Exit codes: 0 no check failed (warnings allowed); 1 at least one FAIL. The same with --fix-hints, which prints nothing when all is well.

benchbar doctor --json --bench-dir ~/frappe-bench
benchbar doctor --fix-hints

repair

benchbar repair [--dry-run] [--yes] [--json] [--bench-dir DIR] [--profile NAME]

Applies only the fixes doctor flagged, in dependency order, with a backup before each change. It shows the plan and asks first. A broken folder is moved aside, never deleted. The bench path is remembered after the first call.

FlagWhat it does
--dry-runPrint the plan, change nothing
-y, --yesApply without asking (a sudo step still asks for the password)
--jsonEvents as JSON lines on stdout, the text in the run’s log (schema). Without --yes or --dry-run nothing is applied
--profile NAMERepair toward another release profile

Exit codes: 0 repaired, or nothing to do; 1 a step failed or the plan was declined, a check that has a repair action still needs it after the run, or a check FAILs and the plan is empty (nothing can repair it). A run that applied its steps exits 0 even when a check without a repair action still FAILs; it says so, and benchbar doctor exits 1 while it does.

The full output of every run is in logs/<date>-<time>-<pid>.log and the backups in backups/<date>-<time>-<pid>/, in benchbar’s state folder: ~/.local/state/benchbar for Homebrew, the one line installer and the app’s CLI, .benchbar in a git checkout. benchbar where shows it.

benchbar repair --dry-run
benchbar repair --yes