Components¶
Per-crate reference documentation. Each page describes the shipped public API, design rationale, usage patterns, and the consumers that tie into the crate. For a conceptual overview that cuts across crates, see the Concepts section.
Shipped¶
Every framework crate through v0.5 has reached v0.1+ and has a reference page below.
| Crate | Purpose | Key types |
|---|---|---|
rtb-error |
Canonical Error enum + miette hook pipeline. |
Error, Result, hook::install_* |
rtb-app |
App context, ToolMetadata, Features, Command trait, BUILTIN_COMMANDS. |
App, ToolMetadata, Command, BUILTIN_COMMANDS |
rtb-config |
Typed layered config over figment with atomic reload. | Config<C>, ConfigBuilder<C> |
rtb-assets |
Overlay asset FS over rust-embed + dirs + memory. | Assets, AssetSource, AssetsBuilder |
rtb-cli |
Application::builder, clap wiring, built-in commands. |
Application, HealthCheck, Initialiser |
rtb-credentials |
CredentialStore + Resolver for env/keychain/literal/fallback. | CredentialStore, Resolver, CredentialRef |
rtb-redact |
Free-form secret redaction for logs + telemetry. | string, SENSITIVE_HEADERS, is_sensitive_header |
rtb-telemetry |
Opt-in events with pluggable sinks + salted machine ID. | TelemetryContext, TelemetrySink, Event |
rtb-test-support |
Sealed-trait test helper for constructing App. |
TestAppBuilder, TestWitness |
rtb-vcs |
Release-provider trait (GitHub/GitLab/Bitbucket/Gitea/Codeberg/Direct) + the Repo git-ops type. |
ReleaseProvider, Repo, Release |
rtb-update |
Signature-verified self-update flow. | Updater, RunOptions, CheckOutcome |
rtb-ai |
Multi-provider AI chat — genai + Anthropic-direct. | AiClient, ChatRequest, Config, Provider |
rtb-mcp |
MCP server — registered Commands as tools over rmcp. |
McpServer, Transport, McpError |
rtb-docs |
Docs browser TUI + embedded HTML server + full-text search. | DocsBrowser, DocsServer, Index |
rtb-tui |
Reusable TUI building blocks — Wizard, render helpers, TTY-aware Spinner. |
Wizard, WizardStep, Spinner, render_table, render_json |
rtb-cli-bin |
The rtb binary — scaffolder + AI codegen. rtb generate project / command / flag / setting / docs, rtb remove command / flag / setting, rtb regenerate manifest / project. Two presets (minimal, cli); marker-driven file edits; linkme-based command dispatch in generated tools; rtb-ai-driven --prompt / --script codegen with a cargo check-driven verifier loop. |
rtb binary (CLI grammar) |
Roadmap lives in framework spec §16.
Reading guide¶
- New to RTB? Start with App context in the Concepts section, then rtb-cli for the entry- point pattern.
- Implementing a new command? rtb-app's
Commandsection and rtb-cli's "Replacing a built-in" walk through registration and dispatch. - Authoring a new crate for the framework? Read Engineering Standards first. Every existing component follows it.
- Security-sensitive code? Start with §1 of the Engineering Standards then the relevant component's "Security" section: rtb-credentials, rtb-assets, rtb-telemetry.