> ## 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 doctor: check that a build will work

> bach doctor [CONFIG]: reports the Bach version, the setup runtime, the config, preview availability and signtool, and says exactly what to fix.

`bach doctor` says whether everything a build needs is in place, in a few lines a person or a script can act on. Run it first when something does not work.

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
bach doctor
bach doctor path/to/bach.toml
```

| Argument | Default | Meaning |
| - | - | - |
| `CONFIG` | `bach.toml` | The config file to check |

## What it reports

| Line | Meaning |
| - | - |
| Bach `<version>` on `<os>` (`<arch>`) | The first line |
| Runtime | Where `bach-setup.exe` is and its SHA-256, or that the first build will download it from a URL, or why it is unusable |
| Runtime trust | Whether this `bach` has the runtime's SHA-256 built in (a release) or only checks a download against the `.sha256` next to it (a build from source) |
| Config | That the config is valid with the app name and version (and a hint when there are warnings), or the sentence that explains what is wrong, or that no `bach.toml` is here and `bach init` writes one |
| Preview | `available` on Windows, otherwise that preview needs Windows (`bach check` works there) |
| Signing | Whether `signtool` was found. It is optional. |

It ends with `Ready to build.` or tells you how many problems to fix and run `bach doctor` again.

## In CI

The GitHub Action runs `bach doctor` on your config before building.


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