Skip to content

Runnable Examples

The crates/everruns/examples catalog contains the maintained public examples. Each imports the everruns facade.

The root-level examples/agents catalog pairs importable Platform definitions with five self-contained Framework programs. Each cargo run uses a real provider and model; CI only constructs the agents with placeholder credentials, so it never makes billed calls.

ExampleProvider and modelWhat it does
Support AgentOpenAI gpt-5.6-terraLooks up safe customer state and answers support questions.
Everruns Support AgentAnthropic claude-opus-5Troubleshoots Framework questions with documentation links.
Coding Review AgentAnthropic claude-sonnet-5Reads and reviews a self-contained code change.
Research AgentOpenRouter z-ai/glm-5.2Uses typed Brave web search, cites sources, and reports uncertainty.
Incident Commander AgentMeta Model API muse-spark-1.3Records an incident update and coordinates safe next actions.

Each example page includes source, prerequisite, command, and terminal screencast.

ExampleDemonstratesCommand
capability_configuration.rsTyped Compaction and ToolSearch, a code-defined Definition, and a dynamic third-party reference through one entrypointcargo run -p everruns --example capability_configuration
workspace_policy.rsSafe workspace scopes and trusted starter files, fully offlinecargo run -p everruns --example workspace_policy
live_session.rsNon-blocking send, automatic steering, and optional waiting, fully offlinecargo run -p everruns --example live_session
hello.rsSmall live-provider agentcargo run -p everruns --features openai --example hello
production_agent.rsTools, files, and production-style setupcargo run -p everruns --features openai --example production_agent
github_monitor.rsTyped tools and an offline simulation modecargo run -p everruns --features openai --example github_monitor -- --simulate
session_work.rsOffline session work, leased delivery, and completion wakescargo run -p everruns --example session_work
session_history.rsOffline durable resume and bounded history pagescargo run -p everruns --features local --example session_history
engine_sessions.rsConcrete Engine ownership, isolated sessions, and engine-scoped resumecargo run -p everruns --example engine_sessions
workspace_heads.rsIsolated Git workspace heads, Environment binding, and durable reopeningcargo run -p everruns --features local --example workspace_heads -- /path/to/repo /path/to/state
canonical_events.rsOffline bounded recording and typed rendering of live eventscargo run -p everruns --example canonical_events
subagents.rsPublic facade composition for delegated workcargo run -p everruns --features openai --example subagents
observe_and_cancel.rsLive events and cancellationcargo run -p everruns --features openai --example observe_and_cancel
advanced_capability.rsCode-defined capability through the unified capability(...) entrypointcargo run -p everruns --features openai --example advanced_capability
lifecycle_hooks.rsAwaited agent, turn, tool, and completion handlerscargo run -p everruns --features openai --example lifecycle_hooks

Live-provider modes use gpt-5.6-terra and require OPENAI_API_KEY. capability_configuration, canonical_events, engine_sessions, live_session, session_work, workspace_heads, workspace_policy, and session_history are fully offline; the GitHub monitor also offers a simulated GitHub flow:

Terminal window
cargo run -p everruns --features openai --example github_monitor -- --simulate

For copyable command details and behavior notes, use the examples/README.md next to the source. Examples that demonstrate low-level host internals remain advanced-host examples, not alternative Framework entrypoints.