bach.toml is the only file Bach needs from you. It lives in your project folder, all paths in it are relative to the file itself, and only two sections are required: [app] and [files]. This page shows how to create it and how to check it.
Create the file
bach init writes a commented bach.toml in the current folder, or in the folder you pass. It never overwrites an existing file.
In a project it recognises, it fills the file in from the project’s own metadata and tells you which stack it found:
Anything it cannot read is left for you to fill in. In a folder it does not recognise, it writes placeholders based on the folder’s name.
The smallest config
bach.toml
name, version and publisher from your project’s own metadata instead of inventing them, and keep version in sync with it.
Validate it
bach check reads the config and lists every file the installer will install, plus the options, components and texts it found. Mistakes are reported as one sentence naming the setting at fault. Unknown settings are an error too, so a typo never goes unnoticed.
Treat every warning: line as something to fix or to mention to your team. A typical warning is a [text] entry given in only one language while the window speaks several.
Get completion in your editor
The first line of the generated file is a schema comment:Next steps
Customize the window
Logo, accent, theme, languages, license and texts.
Full reference
Every setting with defaults.