Skip to content
BenchBarBenchBar

Quick start

Two starting points. Pick the one that matches your Mac.

You already have a bench

Terminal window
benchbar doctor --bench-dir ~/frappe-bench   # read only
benchbar adopt ~/frappe-bench                # shows its plan and asks

doctor prints [OK], [WARN] or [FAIL] per check with the exact fix. adopt writes only the service files (Procfile.lean, the runner script, the launchd agent, the shell helpers and the hosts line) and remembers the bench. It never runs migrate, build or update, and it never touches sites/. When the bench uses the same ports as another bench benchbar knows, it moves this one to the next free port block, after asking. See install and adopt.

You have no bench yet

Terminal window
benchbar install

install runs three phases with a live step list: system dependencies, bench and site, background service. It asks for two passwords, the MariaDB root password (generated unless you set MARIADB_ROOT_PASSWORD, kept in your Keychain) and the site’s Administrator password (or ADMIN_PASSWORD). It asks for sudo once, only when a step ahead needs it: the wkhtmltopdf package and the /etc/hosts line.

To pick the Frappe version or the apps, pass a profile and a bundle, for example benchbar install --profile v16-lts --bundle common. The choices are in Configuration.

Start it

Terminal window
source ~/.zshrc
benchup
open http://macdev:8000

Log in as Administrator and walk through the setup wizard. You can close Terminal; the bench keeps running.

macdev is the default site name. When you picked another one, or adopted a bench, benchbar status shows the site’s URL.

What next