API Documentation

The full Rust API reference is generated from source code documentation using cargo doc.

Viewing API Docs

Build and view the API documentation locally:

# Build all crate docs
cargo doc --workspace --no-deps --open

# Or use the unified build script
bash scripts/build-docs.sh

When using scripts/build-docs.sh, the API docs are available at target/book/doc/.

Publishing Docs

The Docs GitHub Actions workflow builds the book and Rust API docs on pushes to main and on manual dispatch.

GitHub Pages deployment is enabled only when both of the following are true:

• The repository Pages source is set to GitHub Actions
• The repository variable ENABLE_GITHUB_PAGES_DOCS is set to true

The published site is available at https://tirea-ai.github.io/tirea/.

Crate Index

Key Entry Points

tirea_state

• apply_patch — Apply a single patch to state
• Patch — Patch container
• Op — Operation types
• StateContext — Typed state access
• JsonWriter — Dynamic patch builder
• TireaError — Error types

tirea_contract

• Thread — Persisted thread model
• RunContext — Run-scoped execution context
• RunRequest — Unified protocol request
• Tool — Tool trait
• ThreadStore — Persistence abstraction

tirea_agentos

• AgentOs — Registry + run orchestration
• AgentOsBuilder — Builder for wiring
• AgentDefinition — Declarative agent config