Skip to main content
bach.toml holds every setting Bach reads. Paths in it are relative to the bach.toml file. Unknown settings are an error, so a typo never goes unnoticed, and every mistake is reported as one sentence naming the setting at fault. Only [app] and [files] are required. Everything else has a sensible default, so a five-line config already builds a complete installer.

Sections

[app]

Name, version, publisher and the program.

[files]

What gets installed.

[installer]

Look, languages, license and options.

[style]

The window’s built-in style, fonts, colours and background.

[layout]

The window’s size, arrangement, spacing and motion.

[[components]]

Optional parts the user can leave out.

[[protocols]] and [[file_types]]

Links and files your app opens.

[[requirements]]

What the app needs on the computer first.

[[shortcuts]]

More Start menu shortcuts.

[[run]]

Programs setup runs while installing or removing.

[[registry]]

Registry values for your app.

[[env]]

Environment variables.

[[context_menu]]

Explorer right-click entries.

[[migrate]]

Remove an older install by another installer.

[updates]

Updates the installed app fetches itself.

[access]

An access key, encrypted files and private updates.

[text]

Any text in the window, in any language.

[uninstall]

The user’s data and the feedback link.

[signing]

Sign your setup files while building. Optional.

Conventions

  • Text or per language. Wherever a setting is text (a component title, a data description, a [text] entry), you can give one text for every language, or a table with one text per language: { en = "...", de = "..." }.
  • Options. desktop_shortcut and its siblings take true, false, "always" or "never". See [installer].
  • Patterns. * matches within a name, ** across folders, ? one character. Case does not matter.
  • Windows paths. Write them in single quotes so backslashes stay as they are: '%APPDATA%\My App'.
  • Placeholders. {name}, {version} and {publisher} can be used in every text.

A complete example

bach.toml
The repository also has a working example in examples/hello, with a tiny app and the bach.toml that packages it.

Editor support

bach init starts the file with a schema comment so editors can complete every setting. See Editor support.