Reference¶

Information-oriented material you look things up in: what a flag does, what a configuration key defaults to, what happens when a value is wrong, and what changed in a release that needs your attention.

If you are trying to accomplish something rather than look something up, start at the how-to guides. If you want to understand why something works the way it does, start at explanation.

Commands¶

CLI reference — every built-in command a GTB tool ships, with its flags, defaults and behaviour.

The pages most people arrive at:

• Root command — the global flags (--config, --debug, --ci, --output), signal handling and exit codes.
• config — reading, writing, validating and trusting configuration from the command line.
• init — first-run bootstrap and the per-subsystem wizards.
• update — self-update, and the verification it can be made to require.
• doctor — health checks and the redacted support bundle.

Configuration¶

Configuration keys — every key the framework reads, its type, its default, and what happens when it is set to something unusable. Also the precedence order between flags, environment, project-local file, config files and embedded defaults, and the rule that decides whether an environment variable reaches the key you meant.

API stability¶

API stability policy — what "pre-1.0" commits GTB to, which surfaces are stable, and how deprecations are staged.

Migration notes¶

Migration guides — one note per breaking change, each naming the release, what moved, and the mechanical edit that fixes a consumer. Start here when an upgrade stops compiling.