WindowsmacOSLinux

Where Is the Topgrade Config File?

Topgrade keeps its upgrade steps in a TOML config under the config home. Path per OS and what it controls.

Last updated

Topgrade upgrades everything from one TOML file. Disabled steps, ignored packages and custom commands live there. The tools themselves stay installed by their own managers.

That single file design makes fleet setups one template with per host tweaks. Copy it to the config home and every run matches. Dry runs preview the order without changing anything.

Where Topgrade stores this, by platform

Windows
%APPDATA%\topgrade.toml

Step toggles, ignore lists and custom commands in one TOML file. Tools stay installed by their own managers. Copy to the same path for matching runs.

macOS
~/.config/topgrade.toml

Same filename on Mac under home. Package managers differ per platform, so steps valid on Linux may noop here without failing the run.

Linux
~/.config/topgrade.toml

Identical layout on Linux under XDG config home. Pair config copies with the underlying package managers for full fleet moves.

Frequently asked questions

How do I move Topgrade settings?

Copy topgrade.toml to the same relative path on the new machine. Step toggles, ignore lists and pre commands travel with it. Package managers themselves need installing first, since the config only orchestrates them.

How do I skip steps?

In the config file with disable, ignore and pre_command sections per step. Each line names a tool or a custom command to run in order. Keep one config per machine role with host specific steps commented clearly.

Notice an outdated path? Let us know.