Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Workspace crates

When to read this: You need a one-glance map of the 13 workspace crates and where to dive deeper. This page opens the Reference section.

The Reference section is lookup material, most of it generated or synced from the repository: the crate index below (one README per crate), the tools catalog, the provider matrix, the slash commands, the CLI flags, the environment variables, the settings schema, the GPUI event catalog, the singleton inventory, the WIT interface, the curated MCP catalog, build disk usage, make targets & CI workflows, the doc frontmatter schema and the glossary. The reference/* pages are regenerated by make docs-gen from scripts/gen-docs-reference.sh; edit the script, not the page.

Each crate has a README synced into this site on make docs-sync. Edit the source at crates/<name>/README.md, not the built copy under dev/crates/.

None of the workspace crates are published to crates.io / docs.rs today. Research crates set publish = false. Until a crate is published, use the README on this site and cargo doc -p <crate> --open locally — do not add docs.rs badge URLs (they 404 and fail the link checker).

Cratecrates.io / docs.rsLocal rustdoc
Application + WASM + Hive cratesUnpublishedcargo doc -p <crate> --open
chatty-trace, chatty-playbook, chatty-flow, chatty-optimizepublish = falsecargo doc -p <crate> --open

When a crate is published, add a docs.rs badge here and on its README, and keep the crate-level //! docs complete enough for docs.rs.

Application crates

CratePurposeREADME
chatty-coreUI-agnostic agent core: models, services, tools, settings, sandboxcrates/chatty-core/
chatty-gpuiGPUI desktop app — ships the chatty binarycrates/chatty-gpui/
chatty-tuiRatatui terminal app — interactive, headless, and pipe modescrates/chatty-tui/

WASM modules & protocols

CratePurposeREADME
chatty-wasm-runtimeWasmtime embedding and host-side WIT interfacescrates/chatty-wasm-runtime/
chatty-module-registryModule discovery, manifest, and lifecyclecrates/chatty-module-registry/
chatty-protocol-gatewayHTTP gateway: OpenAI / MCP / A2A protocol surfacescrates/chatty-protocol-gateway/
chatty-module-sdkSDK for authoring wasm32-wasip2 agent modulescrates/chatty-module-sdk/

Research crates (Self-improving chatty2)

Reserved symbols and human-only entry points are listed in RESERVED.md. Linear project: Self-improving chatty2.

CratePurposeREADME
chatty-traceTrace capture, ATIF export, feedback hooks (M0)crates/chatty-trace/
chatty-playbookACE-style playbook memory for evolving instructions (M4)crates/chatty-playbook/
chatty-flowAFlow workflow representation and IR (M2)crates/chatty-flow/
chatty-optimizeGEPA/AFlow optimizers, paired stats, QA loaders (M3)crates/chatty-optimize/

Hive integration

CratePurposeREADME
hive-clientOpen-source client for the Hive module registrycrates/hive-client/
hive-billing-sdkPublisher SDK for Hive billing in WASM modules (separate Cargo.lock)crates/hive-billing-sdk/

Dependency direction

flowchart TB
  gpui[chatty-gpui] --> core[chatty-core]
  tui[chatty-tui] --> core
  gateway[chatty-protocol-gateway] --> core
  registry[chatty-module-registry] --> runtime[chatty-wasm-runtime]
  runtime --> core
  trace[chatty-trace] -.-> core
  playbook[chatty-playbook] -.-> core
  flow[chatty-flow] -.-> core
  optimize[chatty-optimize] -.-> trace
  optimize -.-> playbook
  optimize -.-> flow

chatty-core never depends on a UI crate. Research crates integrate with production code but optimizer runs must not block the interactive chat path.