# Everruns

> Everruns is a durable agentic harness engine built on Rust. These docs cover deploying and operating the Platform, and building agents with the Framework, SDKs, and REST API.

Everruns is used in three ways, in increasing order of what it operates for you:

- **Framework**: embed Everruns in a Rust application with the `everruns` crate. You own the process, deployment, integrations, and data path. Start at <https://everruns.com/docs/framework/quickstart/>.
- **Self-hosted platform**: run the shared runtime in infrastructure you manage when you need a control plane, server, workers, UI, remote API, and durable execution. Start at <https://everruns.com/docs/getting-started/docker-compose/>.
- **Everruns Cloud**: use the shared runtime and production operations without operating the platform yourself, with a built-in model provider and starter credit. Start at <https://everruns.com/docs/getting-started/cloud/>.

The documentation sets below are organised the same way, so a reader with a narrow question can take one set instead of the complete text. Every page in them carries a `Source:` line with its canonical URL; cite that rather than the text file.

The sets contain prose documentation only. The REST API is not among them: take its shapes from the OpenAPI schema linked under Optional.

## Documentation Sets

- [Abridged documentation](https://everruns.com/docs/llms-small.txt): a compact version of the documentation for Everruns, with non-essential content removed
- [Complete documentation](https://everruns.com/docs/llms-full.txt): the full documentation for Everruns
- [Start here](https://everruns.com/docs/_llms-txt/start-here.txt): choose between the Framework, a self-hosted Platform, and Everruns Cloud, then the first steps for each
- [Framework](https://everruns.com/docs/_llms-txt/framework.txt): build and run agents inside a Rust application with the everruns crate
- [Platform](https://everruns.com/docs/_llms-txt/platform.txt): the feature surface of a running Everruns Platform, self-hosted or Everruns Cloud; architecture is under Explanation
- [Built-ins](https://everruns.com/docs/_llms-txt/built-ins.txt): the harness and capability catalog, with tools and parameters
- [Guides](https://everruns.com/docs/_llms-txt/guides.txt): tutorials and task-oriented how-to guides
- [Integrations](https://everruns.com/docs/_llms-txt/integrations.txt): model providers, sandboxes, browsers, messaging, and observability vendors
- [Explanation](https://everruns.com/docs/_llms-txt/explanation.txt): architecture and design rationale
- [Reference](https://everruns.com/docs/_llms-txt/reference.txt): the event protocol and every CLI command with its flags; REST endpoints live in the OpenAPI schema
- [Operations](https://everruns.com/docs/_llms-txt/operations.txt): environment variables, admin container, and SRE runbooks
- [Changelog](https://everruns.com/docs/_llms-txt/changelog.txt): what changed in each product, one dated entry per change, newest first; check the release a change shipped in before relying on it

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [OpenAPI schema](https://everruns.com/docs/api/openapi.json): the REST API as OpenAPI 3.0 — authoritative request and response shapes
- [REST API reference](https://everruns.com/docs/api/): the same endpoints as browsable pages
- [Source repository](https://github.com/everruns/everruns): Rust workspace, examples, and contributor conventions
- [everruns crate](https://crates.io/crates/everruns): the application-facing crate on crates.io