Skip to content
Everruns Everruns

Everruns Documentation

Everruns is a durable agentic harness engine built on Rust. It provides APIs for managing agents, sessions, and long-running tasks, with real-time SSE event streaming and PostgreSQL-backed durability.

What kind of help do you need?

The documentation is organised by what you’re trying to do.

Learn — Tutorials Hand-held lessons that take you from zero to a running agent. Start here if you're new.
Do — How-to guides Task-oriented recipes for common problems. Use these when you know what you want to build.
Understand — Explanation Background and design rationale. Read these when reference docs aren't enough on their own.
Look up — Reference API endpoints, event types, capability catalog, CLI flags, environment variables. The dry stuff.

Getting started fast

  1. Deploy with Docker Compose — full platform in one command.
  2. Follow the Build your first agent tutorial.
  3. Browse How-to guides to do something specific.
Core concepts Harness, agent, session, capability, event — what they are and how they compose.
Capabilities catalog Every built-in capability with tools, parameters, and dependencies.
Event reference Every event type in the Everruns event protocol, with payloads.
REST API reference OpenAPI-generated reference for every endpoint.
SDKs Official client libraries for Rust, Python, and TypeScript.
CLI Command-line interface for managing agents, sessions, and conversations.
Architecture Control plane, workers, durable execution — and why.
Environment variables Every configuration knob for the control plane and workers.