Reference¶

Lookup material. Every entry states what something is, what it defaults to, and what happens when it is wrong.

Command-line¶

• CLI reference — the root command, the --output flag, dispatch order, the built-in command set, exit codes.
• version, doctor, init
• config — show / get / set / schema / validate
• credentials — list / add / remove / test / doctor
• telemetry — status / enable / disable / reset
• docs — list / show / browse / serve / ask
• update — check / run
• mcp — serve / list

Configuration and state¶

• Environment variables and on-disk files — everything read from the environment, everything written to disk, per platform.
• ToolMetadata fields this family reads — the build-time values that change CLI behaviour.
• Automatic update checks — the pre-run policy hook, its throttle, and its failure behaviour.

Build-time¶

• Crates, Cargo features and registries — the four crates, the one Cargo feature, the four link-time registries, the MSRV.

Where the Rust API reference lives¶

Item-level signatures are on docs.rs, generated from the source: rtb-cli · rtb-docs · rtb-update · rtb-mcp.

This site does not restate them. A signature copied into prose goes stale the first time it changes; the generated reference cannot.