# DomainRuntime

Canonical developer docs: https://docs.domainruntime.dev

DomainRuntime is a hosted backend defined in TypeScript: entities, live queries, and actions as the only way to write. Every page is marked Verified (runs today), Guide (runs today; planned helpers marked inline) or Planned (designed, not available). Never present a Planned API as runnable; check the status page.

- [Quickstart](https://docs.domainruntime.dev/docs/introduction/quickstart.md)
- [What works today](https://docs.domainruntime.dev/docs/reference/status.md)
- [Using LLMs](https://docs.domainruntime.dev/docs/introduction/using-llms.md)
- [Guarantees](https://docs.domainruntime.dev/docs/data/guarantees.md)
- [All docs](https://docs.domainruntime.dev/llms-full.txt)

## Pages

- [DomainRuntime](https://docs.domainruntime.dev/docs.md): The backend for your business domain: typed data, live queries, actions and durable workflows. [Guide]
- [Agentic experiences](https://docs.domainruntime.dev/docs/agents/agentic-experiences.md): An agent that acts on a concrete domain, as the person using it, with exact control of what it sees: the domain, the context, the turn, live state and the chat. [Guide]
- [Permissions](https://docs.domainruntime.dev/docs/auth/permissions.md): Rules, per entity, deciding which objects each user can see and change. [Guide]
- [Service keys](https://docs.domainruntime.dev/docs/auth/service-keys.md): Credentials for your backend, CI and scripts. [Planned]
- [Users](https://docs.domainruntime.dev/docs/auth/users.md): Sign your app's users in to an environment, and know who they are in queries and actions. [Planned]
- [Actions](https://docs.domainruntime.dev/docs/data/actions.md): The only way data changes: validated input, your code, a typed result. [Guide]
- [Error handling](https://docs.domainruntime.dev/docs/data/error-handling.md): Failing on purpose, what the caller sees, and which errors are worth retrying. [Guide]
- [Files](https://docs.domainruntime.dev/docs/data/files.md): Uploads stored with your data, readable through queries and links. [Guide]
- [Guarantees](https://docs.domainruntime.dev/docs/data/guarantees.md): What is atomic, what runs once, what is live, and what you design for yourself. [Verified]
- [Modeling data](https://docs.domainruntime.dev/docs/data/modeling-data.md): Entities, attributes, links and indexes, declared in your domain. [Verified]
- [Patterns](https://docs.domainruntime.dev/docs/data/patterns.md): Recipes for common problems: ownership, safe creates, uniqueness, counts, imports and backfills. [Guide]
- [Reading data](https://docs.domainruntime.dev/docs/data/reading-data.md): Queries that stay live: filters, ordering, pagination and nested links. [Guide]
- [Streams](https://docs.domainruntime.dev/docs/data/streams.md): Ordered, durable output that clients read while it is being written. [Planned]
- [Workflows](https://docs.domainruntime.dev/docs/data/workflows.md): Actions that run for minutes or days: steps and waits that survive restarts. [Guide]
- [Environments](https://docs.domainruntime.dev/docs/environments/environments.md): Development and production environments: what each is for and how they are organized. [Guide]
- [Local development](https://docs.domainruntime.dev/docs/environments/local-development.md): Edit locally, run in the cloud: druntime keeps your development environment in sync as you save. [Planned]
- [Production](https://docs.domainruntime.dev/docs/environments/production.md): Release your domain to a production environment, change it safely, and roll back. [Planned]
- [Sandboxes](https://docs.domainruntime.dev/docs/environments/sandboxes.md): A machine that runs the whole stack for one environment, for tests, agents and previews. [Planned]
- [Testing](https://docs.domainruntime.dev/docs/environments/testing.md): Unit-test actions with a fake runtime; test permissions and contracts on a real environment. [Guide]
- [How it works](https://docs.domainruntime.dev/docs/introduction/how-it-works.md): The mental model: a domain, live reads, actions as the only writes, and what each piece guarantees. [Guide]
- [Project structure](https://docs.domainruntime.dev/docs/introduction/project-structure.md): The files a DomainRuntime app has and what each one is for. [Planned]
- [Quickstart](https://docs.domainruntime.dev/docs/introduction/quickstart.md): From an empty folder to a live environment, then change an action and watch it update. [Planned]
- [Using LLMs](https://docs.domainruntime.dev/docs/introduction/using-llms.md): Give your coding agent the docs and the rules it needs to write DomainRuntime code correctly. [Guide]
- [HTTP API](https://docs.domainruntime.dev/docs/platform/admin-http-api.md): Call an environment over HTTP from any language. [Verified]
- [Architecture](https://docs.domainruntime.dev/docs/platform/architecture.md): What runs where, where your data is stored, and how it is protected. [Verified]
- [CLI](https://docs.domainruntime.dev/docs/platform/cli.md): druntime: create apps, run development, release to production, run actions and query data. [Planned]
- [MCP](https://docs.domainruntime.dev/docs/platform/mcp.md): Every environment is an MCP server: connect Claude, ChatGPT, Codex, Cursor or your own agent. [Guide]
- [Platform SDK](https://docs.domainruntime.dev/docs/platform/platform-sdk.md): Manage projects, environments, sandboxes, releases and keys from code. [Planned]
- [Errors](https://docs.domainruntime.dev/docs/reference/errors.md): Every error has a stable code. Branch on the code, not the message. [Verified]
- [Limits](https://docs.domainruntime.dev/docs/reference/limits.md): Sizes and timeouts you can design against. [Verified]
- [Status](https://docs.domainruntime.dev/docs/reference/status.md): What runs in production today, what is built but not public, and what is designed. [Verified]