Skip to content

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.

v0.1 — shipped

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-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-mcp MCP server — registered Commands as tools over rmcp. McpServer, Transport, McpError
rtb-tui Reusable TUI building blocks — Wizard, render helpers, TTY-aware Spinner. Wizard, WizardStep, Spinner, render_table, render_json

v0.2+ — pending

The following crates are stubs in the workspace. Each will gain a component doc when it reaches v0.1. Roadmap lives in framework spec §16.

Crate Target Scope
rtb-redact v0.2 Redaction helper for telemetry attrs and log fields. Implementation order: first.
rtb-vcs v0.2 + v0.5 ✅ Release-provider trait + GitHub / GitLab / Bitbucket / Gitea / Codeberg / Direct backends (v0.2 release slice), plus the Repo type with init / open / clone / walk / diff / blame / status / commit / fetch / checkout / push (v0.5 git-ops slice).
rtb-update v0.2 Self-update via rtb-vcs + self-replace + Ed25519 signature verification.
rtb-docs v0.2 ratatui docs browser + embedded-HTML docs serve for airgapped end-users + streaming AI Q&A seam.
rtb-ai v0.3 genai multi-provider + Anthropic-direct for cache/agents.
rtb-cli-bin v0.6 rtb new, rtb generate, rtb regenerate scaffolder.

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 Command section 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.