Runnable Examples
The crates/everruns/examples catalog
contains the maintained public examples. Each imports the everruns facade.
| Example | Demonstrates | Command |
|---|---|---|
capability_configuration.rs | Typed Compaction and ToolSearch, a code-defined Definition, and a dynamic third-party reference through one entrypoint | cargo run -p everruns --example capability_configuration |
workspace_policy.rs | Safe workspace scopes and trusted starter files, fully offline | cargo run -p everruns --example workspace_policy |
live_session.rs | Non-blocking send, automatic steering, and optional waiting, fully offline | cargo run -p everruns --example live_session |
hello.rs | Small live-provider agent | cargo run -p everruns --features openai --example hello |
production_agent.rs | Tools, files, and production-style setup | cargo run -p everruns --features openai --example production_agent |
github_monitor.rs | Typed tools and an offline simulation mode | cargo run -p everruns --features openai --example github_monitor -- --simulate |
session_work.rs | Offline session work, leased delivery, and completion wakes | cargo run -p everruns --example session_work |
session_history.rs | Offline durable resume and bounded history pages | cargo run -p everruns --features local --example session_history |
engine_sessions.rs | Concrete Engine ownership, isolated sessions, and engine-scoped resume | cargo run -p everruns --example engine_sessions |
workspace_heads.rs | Isolated Git workspace heads, Environment binding, and durable reopening | cargo run -p everruns --features local --example workspace_heads -- /path/to/repo /path/to/state |
canonical_events.rs | Offline bounded recording and typed rendering of live events | cargo run -p everruns --example canonical_events |
subagents.rs | Public facade composition for delegated work | cargo run -p everruns --features openai --example subagents |
observe_and_cancel.rs | Live events and cancellation | cargo run -p everruns --features openai --example observe_and_cancel |
advanced_capability.rs | Code-defined capability through the unified capability(...) entrypoint | cargo run -p everruns --features openai --example advanced_capability |
lifecycle_hooks.rs | Awaited agent, turn, tool, and completion handlers | cargo 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:
cargo run -p everruns --features openai --example github_monitor -- --simulateFor 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.