Rotary documentation

September 2, 2026 · View on GitHub

Rotary is the product name for the MPL-2.0 agent harness crate and CLI. The Rust crate and executable are both named rx4; use rx4, not rotary, in terminal commands.

flowchart LR
  Host["Product host"] --> Runtime["HostRuntime"]
  Runtime --> Embed["Embed rx4 as a Rust dependency"]
  Embed --> Engine["Rotary agent harness"]
  Engine --> Capabilities["Loop, scopes, permissions, tools, sessions, skills"]
  Host --> Policy["UI, scheduling, provider policy"]

Guides

  • Installcargo add / cargo install, CLI commands, Homebrew.
  • Features and flags — capabilities, scopes, Cargo feature table.
  • Providers — OpenAI / Anthropic / Ollama / custom endpoints.
  • Computer-use — Praefectus cu_* tools.
  • Events — agent loop and streaming event types.
  • Projection — prune-then-fold, request reconstruction, recovery, MCP surface.
  • Architecture — module and agent-loop contracts.
  • Hosts — embedding, IPC adapter, telekinesis / apollo.
  • Autoresearch — host-driven optimization controller.
  • Boundary ADR — rotary engine and telekinesis host ownership.
  • Comparison — scope relative to other harnesses.
  • Roadmap — completed capabilities and near-term work.
  • Accuracy bench — SWE-bench Verified resolve rate (Codex / Pi / tk).

Command contract

See INSTALL.md. Product hosts own scheduling and user experience. telekinesis owns pi protocol compatibility; Omi Desktop owns its desktop UI, local data policy, and provider-specific OAuth path.