> ## 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.

# [text]: replace any text the installer window shows

> Reference for [text] in bach.toml: every text name, its English default and its placeholders, for replacing any word in the window, per language.

`[text]` replaces any text the window shows. Give one text for every language, or a text per language:

```toml bach.toml theme={"theme":{"light":"github-light","dark":"github-dark"}}
[text]
install_title = { en = "Get {name}", de = "Hol dir {name}" }
install_subtitle = "The fastest way to write things down."
footer = "Made with care by {publisher}"
```

Every text can use `{name}`, `{version}` and `{publisher}`. A few have their own placeholders, listed below. When the window speaks several languages and a text is given in only one, `bach check` points it out.

The built-in texts exist in all 19 languages. Your `[text]` replaces them per language.

## Install

| Text | English default |
| - | - |
| `window_install` | {name} Setup |
| `install_title` | Install {name} |
| `install_subtitle` | The app's description. `{description}` works here. |
| `install_button` | Install |
| `reinstall_title` | Reinstall {name} |
| `reinstall_subtitle` | {name} {version} is already installed. Reinstalling keeps your data. |
| `reinstall_button` | Reinstall |
| `update_title` | Update {name} |
| `update_subtitle` | {name} {old_version} is installed. This updates it to {version} and keeps your data. |
| `update_button` | Update |
| `license_title` | License agreement |
| `license_subtitle` | Please read the terms before you install {name}. |
| `license_accept` | I agree |
| `location` | Location |
| `choose_folder` | Choose where to install {name} |
| `preview` | Preview |
| `footer` | {publisher} · Version {version} |

## Remove

| Text | English default |
| - | - |
| `window_remove` | Remove {name} |
| `remove_title` | Remove {name} |
| `remove_subtitle` | This removes {name} and its shortcuts from this computer. |
| `remove_button` | Remove |
| `removed_title`, `removed_subtitle`, `removed_data_deleted`, `removed_data_kept` | The last page after removing |

## Buttons and common words

| Text | English default |
| - | - |
| `cancel`, `close`, `retry`, `change` | Cancel, Close, Try again, Change |
| `open`, `open_short` | Open {name}, Open |
| `website`, `feedback` | The link buttons on the last page |

## Choices

| Text | English default |
| - | - |
| `desktop_shortcut`, `desktop_shortcut_description` | Desktop shortcut, Start {name} from your desktop too. |
| `start_menu`, `start_menu_description` | Start menu, Find {name} in the Start menu. |
| `start_with_windows`, `start_with_windows_description` | Start with Windows, Open {name} automatically when you sign in. |
| `add_to_path`, `add_to_path_description` | Add to PATH, Run {name} from any terminal. |
| `auto_update`, `auto_update_description` | Automatic updates, Install new versions of `{name}` in the background while it isn't running. Shown when `[updates]` offers the box. |
| `delete_data`, `delete_data_description` | Also delete my data, Settings and files {name} saved on this computer. |

## Progress

| Text | English default |
| - | - |
| `installing`, `updating`, `removing` | Installing {name}, Updating {name}, Removing {name} |
| `step_preparing`, `step_copying`, `step_tidying`, `step_uninstaller`, `step_shortcuts`, `step_registering` | The progress labels while installing |
| `step_removing`, `step_removing_shortcuts`, `step_unregistering`, `step_deleting_data`, `step_cleaning`, `step_done` | The progress labels while removing |
| `step_downloading` | The progress label while updating from the app |
| `step_finding`, `step_fetching` | The [online installer's](/docs/reference/config/installer.md#online-and-offline-installers) labels while it finds and downloads the newest version. `step_fetching` has `{name}` |
| `step_running` | The label while a [`[[run]]`](/docs/reference/config/run) step works. Placeholder: `{task}` |
| `step_migrating` | The label while an older install by another installer is removed ([`[[migrate]]`](/docs/reference/config/migrate)) |

## Access key

| Text | English default |
| - | - |
| `access_title` | Enter your access key |
| `access_subtitle` | `{name}` is protected. Enter the key you were given to continue. |
| `access_hint` | Access key |
| `access_button`, `access_paste`, `access_get` | Continue, Paste, Get a key |
| `access_wrong` | That key doesn't fit. Check it and try again. |

See [`[access]`](/docs/reference/config/access).

## Done

| Text | English default |
| - | - |
| `installed_title` | {name} is installed |
| `installed_subtitle` | Find it in the Start menu, or open it now. |
| `installed_subtitle_plain` | {name} is ready to use. |
| `updated_title` | {name} is up to date |

## Failures

| Text | English default |
| - | - |
| `install_failed`, `update_failed`, `remove_failed` | {name} couldn't be installed (updated, removed) |
| `error_still_open`, `error_busy` | The app is still open, or another setup is running |
| `error_in_use` | A file is in use. Placeholder: `{path}` |
| `error_disk_full` | Not enough disk space. Placeholders: `{size}`, `{free}` |
| `error_no_access` | Access was denied. Placeholder: `{path}` |
| `error_create`, `error_write`, `error_delete`, `error_shortcut`, `error_delete_data`, `error_not_found` | Errors about one file or folder. Placeholder: `{path}`. Windows' own reason follows them. |
| `error_read_setup`, `error_damaged`, `error_uninstaller`, `error_register`, `error_unregister`, `error_system`, `error_open_failed` | The rarer errors. Placeholder: `{error}` |
| `error_download` | A failed download of an update. Placeholder: `{error}` |
| `error_fetch` | The online installer could not download the app. Placeholder: `{error}` |
| `error_run` | A `[[run]]` step failed. Placeholders: `{task}`, `{code}` (its exit code) |
| `error_patch_base` | An [update patch](/docs/guides/updates.md#update-patches) was started on files that are not the version it was made for |
| `problem_title`, `problem_damaged` | The page a damaged setup file shows. `problem_damaged` has `{error}` |

## Downgrade, closing the app and requirements

| Text | English default |
| - | - |
| `downgrade_title`, `downgrade_subtitle`, `downgrade_button` | Installing over a newer version. `downgrade_subtitle` has `{old_version}` |
| `close_app`, `error_close_app` | "Close and continue", and what it says when the app will not close |
| `requirement_skip` | "Continue anyway" on the requirement page |
| `support_save`, `support_saved`, `support_failed` | "Save support info" on the failed page, what it says once the file is on the desktop ("Saved on your desktop"), and when it could not be saved |
| `requirement_title`, `requirement_subtitle`, `requirement_button` | The page for a missing requirement. All three have `{requirement}` |

## Placeholders

| Placeholder | Available in |
| - | - |
| `{name}`, `{version}`, `{publisher}` | Every text |
| `{description}` | `install_subtitle` |
| `{old_version}` | `update_subtitle`, `downgrade_subtitle` |
| `{path}` | `error_in_use`, `error_no_access`, `error_create`, `error_write`, `error_delete`, `error_shortcut`, `error_delete_data`, `error_not_found` |
| `{size}`, `{free}` | `error_disk_full` |
| `{error}` | `error_read_setup`, `error_damaged`, `error_uninstaller`, `error_register`, `error_unregister`, `error_system`, `error_open_failed`, `error_download`, `error_fetch`, `problem_damaged` |
| `{task}` | `step_running`, `error_run` |
| `{code}` | `error_run` |
| `{requirement}` | `requirement_title`, `requirement_subtitle`, `requirement_button` |

> [!NOTE]
>
> The source of truth for every English text and every translation is `crates/pack/src/i18n` in the Bach repository.


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