avatar-runtime 0.1.0__tar.gz

avatar_runtime-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Avatar Runtime Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

avatar_runtime-0.1.0/NOTICE

@@ -0,0 +1,7 @@
+Avatar Engine
+Copyright 2026 Avatar Runtime Authors
+
+This product includes software developed by the Avatar Runtime Authors
+(https://github.com/avatar-runtime/avatar-engine).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.

avatar_runtime-0.1.0/PKG-INFO

@@ -0,0 +1,373 @@
+Metadata-Version: 2.4
+Name: avatar-runtime
+Version: 0.1.0
+Summary: Temporal for AI agents — a Postgres-native durable execution engine for AI agent workflows.
+Author: Avatar Runtime Authors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/avatar-runtime/avatar-engine
+Project-URL: Repository, https://github.com/avatar-runtime/avatar-engine
+Project-URL: Documentation, https://github.com/avatar-runtime/avatar-engine/blob/main/docs/AVATAR.md
+Project-URL: Issues, https://github.com/avatar-runtime/avatar-engine/issues
+Keywords: durable-execution,ai-agents,workflow,postgres,idempotency,crash-recovery
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn[standard]>=0.27
+Requires-Dist: sqlalchemy[asyncio]>=2.0
+Requires-Dist: pydantic>=2.6
+Requires-Dist: httpx>=0.27
+Requires-Dist: aiosqlite>=0.19
+Provides-Extra: postgres
+Requires-Dist: asyncpg>=0.29; extra == "postgres"
+Requires-Dist: psycopg[binary]>=3.1; extra == "postgres"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: anyio>=4; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# Avatar Engine
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![CI](https://github.com/avatar-runtime/avatar-engine/actions/workflows/ci.yml/badge.svg)](https://github.com/avatar-runtime/avatar-engine/actions/workflows/ci.yml)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/)
+
+**Temporal for AI agents.** A Postgres-native durable execution engine for AI
+agent workflows — crash-safe, replayable, idempotent. Backed entirely by Postgres.
+
+Wrap your existing tool-calling agent loop and get crash-safety, an append-only
+step ledger, idempotent tool dispatch, deterministic replay, and a dashboard to
+watch it all — without writing any of that yourself.
+
+```
+SDK → API → Postgres → Worker → Tools
+                ↑          ↓
+           Dashboard ←  SSE stream
+```
+
+> **The one guarantee:** a worker can die at any point in a run and another
+> resumes from the ledger — no step is lost. **Tool dispatch attempts may repeat,
+> but tool effects cannot duplicate when idempotency is enforced.**
+>
+> Stated precisely: *at-most-once dispatch from Avatar always; exactly-once
+> end-to-end iff the tool honors the idempotency key.* We never claim
+> unconditional exactly-once.
+
+---
+
+## Why
+
+LangChain-style frameworks give you the agent loop but no durability. Temporal
+gives you durability but no agent/tool/LLM semantics. Avatar is the only thing
+that is **both agent-native and crash-safe** — and its only infrastructure
+dependency is Postgres. The `runs` table *is* the queue. No Redis, no broker.
+
+## Documentation
+
+- **[The Complete Guide](docs/AVATAR.md)** — the comprehensive doc: mental model,
+  architecture, execution semantics, the concurrency model as theorems, the
+  failure taxonomy, the Guarantees Spec, positioning, adoption metrics, what's
+  done, and the roadmap (v1 → v2 Cloud → v3). Start here.
+- **[Deployment](docs/deployment.md)** — production guide (TLS, scaling, backups,
+  observability).
+- **[Security](SECURITY.md)** — the auth model, its limits, and production
+  must-dos.
+
+## The 30-second proof: a refund that survives a crash
+
+```bash
+git clone https://github.com/avatar-runtime/avatar-engine.git
+cd avatar-engine
+pip install -e .              # (PyPI: pip install avatar-runtime — coming soon)
+python -m avatar.cli demo
+```
+
+The demo runs `lookup_order → issue_refund → email_customer`. A worker is killed
+**after `issue_refund` dispatches but before its observation commits** (the
+decisive crash window). A fresh worker re-leases the run, rebuilds from the
+ledger, and finishes it:
+
+```
+---- timeline ----
+  #1  [plan]
+  #2  [tool_call] c1
+  #3  [observation] c1
+  #4  [plan]
+  #5  [tool_call] c2
+   ▸ resumed by host:6226 (attempt 2)      ← worker crashed here; another took over
+  #6  [observation] c2
+  ...
+  #11 [final]
+------------------
+run status        : succeeded
+dispatch attempts : 2     (the tool was physically called twice — crash + resume)
+tool effects      : 1     (one actual refund)
+
+✅ "Crashed mid-refund. Restarted. The refund wasn't issued twice."
+   Tool dispatch attempts may repeat, but tool effects cannot duplicate
+   when idempotency is enforced.
+```
+
+## Quickstart with `docker compose`
+
+```bash
+docker compose up           # Postgres + control API + dashboard + 1 worker
+# scale workers:  docker compose up --scale worker=3
+```
+
+Then open the dashboard at **http://localhost:8088** (the compose host port;
+the container serves on 8080), enqueue a run, and watch its live step timeline —
+including the visible *"resumed after crash"* marker.
+
+## Use it from Python
+
+```python
+from avatar import Avatar, tool, Plan, ToolCall
+
+app = Avatar(api_url="http://localhost:8080", api_key="dev-key")
+
+@tool(timeout=10, retries=2)
+def issue_refund(order_id: str, cents: int) -> dict:
+    # Your real side effect. Forward avatar.current_idempotency_key() to the
+    # downstream service to get exactly-once end-to-end.
+    return {"refunded": True}
+
+@app.agent("support-resolver")
+def resolve(state):
+    # A model function: read the rebuilt state, return the next Plan.
+    if any(m["role"] == "tool" for m in state.messages):
+        return Plan(final=True, output={"status": "done"})
+    return Plan(tool_calls=[ToolCall(id="c1", name="issue_refund",
+                                     arguments={"order_id": "42", "cents": 500})])
+
+run = app.runs.create(agent_ref="support-resolver", input={"ticket_id": 42})
+print(app.runs.wait(run["id"]))
+```
+
+Point the worker at your module with `AVATAR_APP=yourpkg.agents` and run
+`avatar worker`. The engine drives the durable loop; you write only the model
+call and the tools.
+
+### SDK reference
+
+**Authoring** (imported by the worker via `AVATAR_APP`):
+
+| Symbol | Purpose |
+|---|---|
+| `@tool(timeout=, retries=, idempotent=)` | Register a developer function as a governed tool. |
+| `@app.agent(ref)` / `@agent(ref)` | Register a model function `(State) -> Plan` under `ref`. |
+| `Plan(content=, tool_calls=[], final=, output=, cost_cents=)` | The model's output for one step. A plan with no tool calls is final. |
+| `ToolCall(id, name, arguments)` | One tool invocation. A **stable `id`** keeps idempotency crash-stable. |
+| `State.input` / `State.messages` | The rebuilt-from-ledger view handed to the model each iteration. |
+| `current_idempotency_key()` | Inside a tool: the key to forward to your downstream service. |
+
+**Control client** (`app.runs.*`, usable anywhere):
+
+| Call | Maps to |
+|---|---|
+| `runs.create(agent_ref=, input=, budget_cap_cents=, idempotency_key=)` | `POST /v1/runs` |
+| `runs.get(id)` · `runs.list(status=, limit=)` · `runs.steps(id)` | `GET /v1/runs…` |
+| `runs.wait(id, timeout=)` | poll until terminal / `approval_wait` |
+| `runs.stream(id)` | SSE generator of step events |
+| `runs.cancel(id)` · `runs.approve(id)` · `runs.reject(id)` | the POST actions |
+| `runs.replay(id, from_seq=)` | `POST /v1/runs/{id}/replay` (fork) |
+
+### Tools, idempotency, and the honest guarantee
+
+A tool receives the idempotency key for the in-flight call via
+`current_idempotency_key()`. Forward it to your downstream (e.g. Stripe's
+`Idempotency-Key` header). On a crash between dispatch and observation, Avatar
+re-dispatches with the **same** key, so:
+
+- **At-most-once dispatch from Avatar** — always, via the committed intent step.
+- **Exactly-once end-to-end** — iff your tool/downstream honors the key.
+
+Tools run in-process by default; set `AVATAR_TOOL_ISOLATION=subprocess` to run
+each in a child process with the wall-clock timeout and output-size cap enforced.
+A crashing in-proc tool can take the worker down, so use `subprocess` for anything
+less than fully trusted. **There is no network/SSRF sandbox** (deliberately cut from
+the wedge) — do not run untrusted third-party agent code yet. See [SECURITY.md](SECURITY.md).
+
+**Budgets stop runs, not in-flight calls.** `budget_cap_cents` halts a run *before
+its next step* once the cap is reached; the model/tool call already in flight is not
+cancelled (its provider cost is already incurred). Treat the cap as a circuit
+breaker, not a pre-charge.
+
+## How it works
+
+The engine is a state machine over two Postgres tables (`avatar/engine/schema.sql`):
+
+- **`runs`** — the durable run record *and* the work queue. Workers atomically
+  lease rows with `FOR UPDATE SKIP LOCKED` (Postgres) or a compare-and-swap
+  (SQLite), renew a heartbeated lease, and a guarded update means a worker that
+  lost its lease can never commit.
+- **`run_steps`** — an append-only, seq-ordered ledger. Steps are never updated
+  or deleted; **all run state is a pure fold over this table**, which is what
+  makes crash-resume and replay deterministic.
+
+The invariant that makes it safe:
+
+> Every tool call is preceded by a committed `tool_call` (intent) step, and its
+> result is recorded under `UNIQUE(run_id, idempotency_key)`.
+
+So on resume an already-observed call short-circuits to its recorded result, and
+a call dispatched-but-not-observed (the crash window) is re-dispatched with the
+**same** idempotency key — the downstream dedupes it.
+
+The execution loop (`avatar/engine/runtime.py`):
+
+```
+rebuild state from the ledger
+loop:
+  heartbeat (and confirm we still own the lease)
+  if pending tool calls:
+    for each: policy check → commit intent → dispatch → commit observation
+  else:
+    call the model → commit plan  (final ⇒ commit final, succeed)
+```
+
+## Features
+
+| | |
+|---|---|
+| **Crash-safe** | Lease + heartbeat + ledger replay. Kill `-9` any worker. |
+| **Idempotent tools** | Crash-stable key per tool call; `UNIQUE(run_id, key)`. |
+| **Policy hook** | `allow` / `deny` / `require_approval` before every dispatch. |
+| **Budget** | Per-run `budget_cap_cents` hard-stop. |
+| **Replay / fork** | Re-run a trace prefix without re-calling the model or re-running tools. |
+| **Control API** | REST + SSE, single static API-key auth. |
+| **Dashboard** | Runs list, step-ledger timeline, live SSE, crash-resume markers, fork. |
+
+## Control API
+
+`Authorization: Bearer $AVATAR_API_KEY` on every `/v1` route.
+
+| Method | Path | Purpose |
+|---|---|---|
+| POST | `/v1/runs` | Enqueue `{agent_ref, input, budget_cap_cents?, idempotency_key?}` |
+| GET | `/v1/runs` | List / filter (`?status=&limit=`) |
+| GET | `/v1/runs/{id}` | Status + summary |
+| GET | `/v1/runs/{id}/steps` | The append-only ledger |
+| GET | `/v1/runs/{id}/stream` | SSE — live step events |
+| POST | `/v1/runs/{id}/cancel` | Cooperative cancel |
+| POST | `/v1/runs/{id}/approve` · `/reject` | Resolve an `approval_wait` |
+| POST | `/v1/runs/{id}/replay` | Fork from a step: `{from_seq}` |
+| GET | `/healthz` · `/readyz` | Liveness / readiness |
+
+## Dashboard
+
+A single-page client of the API (served at `/`, the static API key injected so
+local dev needs no login). Four views:
+
+- **Runs** (`#/`) — table of id, agent, status badge, attempt, cost, age;
+  auto-refreshing, with a pulse on `running` and red/amber badges for
+  `failed`/`dead`/`approval_wait`.
+- **Run detail** (`#/runs/:id`) — the centerpiece. The append-only
+  **step-ledger timeline**: each step (`plan / tool_call / observation /
+  approval_wait / final / error`) is expandable to its payload JSON, with its
+  `tool_call_id`, `idempotency_key`, committing `worker_id`, and `attempt`. A
+  **▸ resumed after crash (attempt N)** divider marks where another worker took
+  over. Live updates via SSE. **Fork here** on every step, and
+  **Approve / Reject / Cancel** when applicable.
+- **Demo** (`#/demo`) — a narrated one-screen view of the crash-resume story,
+  surfacing any crash-resumed (`attempt ≥ 2`) refund run.
+- **Health** (`#/health`) — totals, queue depth, status breakdown.
+
+## Configuration
+
+Everything is an env var — one infra dependency (Postgres), one auth secret.
+See [`.env.example`](.env.example).
+
+| Var | Default | Purpose |
+|---|---|---|
+| `AVATAR_DATABASE_URL` | `sqlite+aiosqlite:///./avatar.db` | Postgres (`postgresql+asyncpg://…`) in production. |
+| `AVATAR_API_KEY` | `dev-key` | The single static Bearer key. **Required & strong in prod** (see below). |
+| `AVATAR_DEV_MODE` | `0` | `1` for local dev only — relaxes the prod key guard, injects the key into the dashboard. |
+| `AVATAR_APP` | — | Module(s) to import so `@agent`/`@tool` register (e.g. `yourpkg.agents`). |
+| `AVATAR_LEASE_SECONDS` | `30` | Lease TTL; a worker silent this long is treated as crashed. |
+| `AVATAR_HEARTBEAT_SECONDS` | `10` | In-loop lease renewal cadence. |
+| `AVATAR_POLL_INTERVAL_MS` | `500` | Worker poll when the queue is empty. |
+| `AVATAR_MAX_STEPS` | `50` | Runaway-plan guard per run. |
+| `AVATAR_MAX_ATTEMPTS` | `5` | Re-leases before a poison run → `dead`. |
+| `AVATAR_TOOL_TIMEOUT_SECONDS` | `30` | Per-tool wall-clock timeout. |
+| `AVATAR_TOOL_ISOLATION` | `inproc` | `inproc` or `subprocess` (use `subprocess` for less-trusted tools). |
+| `AVATAR_RATE_LIMIT_PER_SECOND` / `_BURST` | `50` / `100` | Per-process enqueue throttle. |
+| `AVATAR_MAX_QUEUE_DEPTH` | `10000` | Enqueue returns `429` above this. |
+| `AVATAR_DB_POOL_SIZE` / `_MAX_OVERFLOW` | `10` / `20` | Per-process Postgres connection pool. |
+
+> **Production:** the API and worker **refuse to boot** in non-dev mode with an
+> unset or default key. Generate one (`openssl rand -hex 32`), and run behind TLS.
+> The full guide — Caddy/TLS compose, backups/PITR, scaling, observability,
+> tool-isolation caveats — is in **[docs/deployment.md](docs/deployment.md)** and
+> **[SECURITY.md](SECURITY.md)**.
+
+## CLI
+
+```bash
+avatar serve [--host --port]          # control API + dashboard
+avatar worker [--max-runs --max-idle] # a stateless durable worker (scale by running more)
+avatar migrate                        # apply the canonical schema (idempotent)
+avatar demo                           # the crash-resume killer demo
+```
+
+## Project layout
+
+```
+avatar/
+  engine/        runs+run_steps models, schema.sql, execute_run, worker (lease/
+                 heartbeat/resume), idempotency, tools, policy, budget, replay
+  api/           FastAPI control API (single-key auth) + SSE
+  sdk/           @agent / @tool decorators + REST/SSE client
+  demo.py        the killer-demo agent + idempotent refund tool
+  cli.py         avatar worker | serve | demo
+  config.py      env-only settings
+  dashboard/     single-page dashboard + landing page (served at /app and /, packaged in the wheel)
+tests/           engine, crash-resume (CRASH-C), idempotency, replay, policy/budget, API
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                       # SQLite (fast)
+AVATAR_DATABASE_URL=postgresql+asyncpg://avatar:avatar@localhost:5432/avatar pytest
+```
+
+The crash/race slice runs against **Postgres** in CI for the true
+`FOR UPDATE SKIP LOCKED` path; SQLite covers the rest.
+
+## Scope
+
+This is **single-purpose infrastructure**, not a platform. It is **not** a SaaS,
+not multi-tenant, not a marketplace, not BYOK, not voice/avatars, not multi-agent
+orchestration. Those belong to **Avatar Cloud** — the hosted, commercial control
+plane built on top of this engine — not to the open-source engine. See the
+roadmap in [docs/AVATAR.md](docs/AVATAR.md).
+
+## Versioning & releases
+
+Changes are tracked in [CHANGELOG.md](CHANGELOG.md); the project follows
+[SemVer](https://semver.org/) and the API is versioned (`/v1`). A PyPI release is
+planned (`pip install avatar-runtime`); until then install from source
+(`pip install -e .`).
+
+## Contributing & governance
+
+Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md),
+[GOVERNANCE.md](GOVERNANCE.md), and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+Avatar Engine is company-led OSS and the open foundation of **Avatar Cloud**, the
+hosted multi-tenant control plane built on top of it (the Temporal model).
+
+## License
+
+Licensed under the **Apache License, Version 2.0** — see [LICENSE](LICENSE) and
+[NOTICE](NOTICE). Copyright 2026 Avatar Runtime Authors.