Skip to main content
bach is the command developers run. It reads a bach.toml, checks it, previews the window and writes the setup file. It runs on Windows, macOS and Linux, so installers can come out of any CI. Run bach on its own (or bach --help) to see every command grouped by what you are doing. bach COMMAND --help lists the options of one command.
The names are coloured in a terminal that shows colour, and plain when the output is piped or NO_COLOR is set. The update notice (below) follows the list, so bach alone is also where you learn that a new release is out. The same commands, with their usage:

Commands

Global flags

Exit codes

Every command exits with 0 on success. On any problem it prints a readable sentence, never raw debug output, and exits with a non-zero code. That makes the commands safe to use in scripts and CI.

Config path

check, build, preview and doctor take an optional path to a config file. It defaults to bach.toml in the current folder. Paths inside the config are relative to the config file.

Platform notes

Update notice

When a newer release exists, a command run in a terminal, and plain bach, ends with a line that says so and names the command that updates bach. It is silent in CI, with --json and when output is piped, and BACH_NO_UPDATE_CHECK turns it off. See bach update.

The setup runtime

Every installer is built on bach-setup.exe. bach finds it next to itself, in a repository checkout, in a download cache or downloads it once. See Install Bach.