> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Bach builds Windows installers from one bach.toml with the bach command: bach init, bach check, bach preview, bach build. Installs are per user and need no administrator rights by default. installer.scope = "machine" installs for every user after one Windows prompt. On Windows, run setup files with Start-Process -Wait -PassThru in PowerShell, and give signtool arguments that start with the word sign.

# bach.toml reference: every setting Bach reads

> The structure of bach.toml: which sections are required, how errors are reported, and a complete example that uses every section.

`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

> [card] [\[app\]](/docs/reference/config/app)
>
> Name, version, publisher and the program.

> [card] [\[files\]](/docs/reference/config/files)
>
> What gets installed.

> [card] [\[installer\]](/docs/reference/config/installer)
>
> Look, languages, license and options.

> [card] [\[style\]](/docs/reference/config/style)
>
> The window's built-in style, fonts, colours and background.

> [card] [\[layout\]](/docs/reference/config/layout)
>
> The window's size, arrangement, spacing and motion.

> [card] [\[\[components\]\]](/docs/reference/config/components)
>
> Optional parts the user can leave out.

> [card] [\[\[protocols\]\] and \[\[file\_types\]\]](/docs/reference/config/protocols-and-file-types)
>
> Links and files your app opens.

> [card] [\[\[requirements\]\]](/docs/reference/config/requirements)
>
> What the app needs on the computer first.

> [card] [\[\[shortcuts\]\]](/docs/reference/config/shortcuts)
>
> More Start menu shortcuts.

> [card] [\[\[run\]\]](/docs/reference/config/run)
>
> Programs setup runs while installing or removing.

> [card] [\[\[registry\]\]](/docs/reference/config/registry)
>
> Registry values for your app.

> [card] [\[\[env\]\]](/docs/reference/config/env)
>
> Environment variables.

> [card] [\[\[context\_menu\]\]](/docs/reference/config/context-menu)
>
> Explorer right-click entries.

> [card] [\[\[migrate\]\]](/docs/reference/config/migrate)
>
> Remove an older install by another installer.

> [card] [\[updates\]](/docs/reference/config/updates)
>
> Updates the installed app fetches itself.

> [card] [\[access\]](/docs/reference/config/access)
>
> An access key, encrypted files and private updates.

> [card] [\[text\]](/docs/reference/config/text)
>
> Any text in the window, in any language.

> [card] [\[uninstall\]](/docs/reference/config/uninstall)
>
> The user's data and the feedback link.

> [card] [\[signing\]](/docs/reference/config/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]`](/docs/reference/config/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

```toml bach.toml theme={"theme":{"light":"github-light","dark":"github-dark"}}
[app]
name = "Hello"
version = "1.4.0"
publisher = "Hello Inc."
executable = "hello.exe"
description = "Says hello, nicely."
website = "https://hello.example"
icon = "assets/hello.ico"

[files]
source = "target/release/package"
exclude = ["*.pdb"]

[installer]
output = "dist/Hello-Setup-{version}.exe"
theme = "system"
accent = "#2563eb"
logo = "assets/logo.svg"
languages = ["en", "de"]
license = { en = "LICENSE.txt", de = "LIZENZ.txt" }
desktop_shortcut = true
start_menu_shortcut = "always"
start_with_windows = false
add_to_path = false
path_folder = "bin"

[[components]]
id = "samples"
title = { en = "Sample projects", de = "Beispielprojekte" }
files = ["samples/**"]
default = true

[[protocols]]
scheme = "hello"

[[file_types]]
extension = ".hello"
description = "Hello note"

[text]
install_subtitle = { en = "Say hello in style.", de = "Sag Hallo mit Stil." }

[uninstall]
data = ['%APPDATA%\Hello', '%LOCALAPPDATA%\Hello\Cache']
data_description = { en = "Your settings and the download cache.", de = "Deine Einstellungen und der Download-Cache." }
```

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](/docs/reference/setup/editor-support.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.