Realm documentation
Realm is a workflow engine that an AI agent calls. These pages describe Realm as it is on the main branch; the published version is 0.47.0. Where a page shows something added after version 0.46.0, the page says so; it is in 0.47.0 unless the page says otherwise. Every command and output in them came from a run. User names, host names and folders in the outputs may be placeholders, such as ops@server-1, /srv/shop or /home/you.
Start here
Section titled “Start here”- What is Realm, and when to use it?
- Install and first run
- How a run moves
- How Realm compares with other workflow tools, a page on the website
Concepts
Section titled “Concepts”- Workflows, steps and the run record
- The four step kinds
- Order and routing
- Human gates and trust levels
- Evidence, and how a run ends
- Who drives a run
Guides
Section titled “Guides”- Write your first workflow
- Call a service with an adapter
- Write an agent step
- Give an agent step tools
- Add a human gate
- Write a step handler
- Run a workflow with
realm agent - Connect an MCP client
- Start runs from webhooks
- Answer gates from Slack
- Handle failure
- Start runs safely
- Test a workflow
- Operate runs
- Deploy a project
- Let an assistant plan its own workflow
- Upgrade Realm
Reference: the workflow file
Section titled “Reference: the workflow file”- Workflow file: top-level fields
- Workflow file: step fields
- Input maps, template expressions and filters
- Conditions:
when,preconditions,abort_unless - Gates:
trustand thegateblock - Retry and timeouts
- Agent-step controls
- Services, tool servers, step templates, profiles and workflow context
- Webhook trigger
- JSON Schema blocks
- What the loader refuses and warns about
Reference: the command line
Section titled “Reference: the command line”realm workflowrealm run: commands that readrealm run: commands that actrealm agentrealm listenrealm mcpandrealm serve
Reference: MCP
Section titled “Reference: MCP”Reference: code and settings
Section titled “Reference: code and settings”- Adapters
- Handlers
- Deployment manifest (
realm.yaml) - Project extensions
- Testing package
- Core library: stores and the store contract