cayu 0.1.0a1__tar.gz

cayu-0.1.0a1/.gitignore

@@ -0,0 +1,20 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.coverage
+.ruff_cache/
+.mypy_cache/
+dist/
+build/
+*.egg-info/
+.DS_Store
+.cayu/
+.cayu-internal-runtime-acceptance.json
+.cayu-example-results/
+.cayu-example-workspaces/
+.examples-workspaces/
+node_modules/
+dashboard/dist/
+model-catalog-refresh.md
+.claude/worktrees/

cayu-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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 [yyyy] [name of copyright owner]
+
+   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
+
+       https://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.

cayu-0.1.0a1/NOTICE

@@ -0,0 +1,4 @@
+Cayu
+Copyright 2026 Cayu Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0.

cayu-0.1.0a1/PKG-INFO

@@ -0,0 +1,430 @@
+Metadata-Version: 2.4
+Name: cayu
+Version: 0.1.0a1
+Summary: A Python runtime for production AI agents with durable sessions, controlled tool execution, context management, reviewed knowledge, recovery, evals, and replay.
+Author: Cayu Technologies, Inc.
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Requires-Dist: certifi>=2024.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: jsonschema>=4.23
+Requires-Dist: pydantic>=2.12
+Requires-Dist: tzdata>=2024.0; sys_platform == 'win32'
+Provides-Extra: all
+Requires-Dist: boto3<2,>=1.43.44; extra == 'all'
+Requires-Dist: cryptography>=42; extra == 'all'
+Requires-Dist: e2b<3,>=2.28; extra == 'all'
+Requires-Dist: fastapi>=0.115; extra == 'all'
+Requires-Dist: google-auth[requests]<3,>=2; extra == 'all'
+Requires-Dist: ipython<10,>=9; extra == 'all'
+Requires-Dist: opentelemetry-api>=1.20; extra == 'all'
+Requires-Dist: opentelemetry-sdk>=1.20; extra == 'all'
+Requires-Dist: pillow>=10; extra == 'all'
+Requires-Dist: psycopg-pool>=3.2; extra == 'all'
+Requires-Dist: psycopg[binary]>=3.2; extra == 'all'
+Requires-Dist: pypdf>=4; extra == 'all'
+Requires-Dist: sse-starlette>=2.0; extra == 'all'
+Requires-Dist: uvicorn>=0.30; extra == 'all'
+Provides-Extra: aws
+Requires-Dist: boto3[crt]<2,>=1.43.44; extra == 'aws'
+Provides-Extra: browser
+Requires-Dist: playwright>=1.61; extra == 'browser'
+Provides-Extra: console
+Requires-Dist: ipython<10,>=9; extra == 'console'
+Provides-Extra: dev
+Requires-Dist: cryptography>=42; extra == 'dev'
+Requires-Dist: fastapi>=0.115; extra == 'dev'
+Requires-Dist: httpx2<3,>=2.3; extra == 'dev'
+Requires-Dist: opentelemetry-api>=1.20; extra == 'dev'
+Requires-Dist: opentelemetry-sdk>=1.20; extra == 'dev'
+Requires-Dist: pillow>=10; extra == 'dev'
+Requires-Dist: psycopg-pool>=3.2; extra == 'dev'
+Requires-Dist: psycopg[binary]>=3.2; extra == 'dev'
+Requires-Dist: pypdf>=4; extra == 'dev'
+Requires-Dist: pytest-cov>=7.1; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.11; extra == 'dev'
+Requires-Dist: sse-starlette>=2.0; extra == 'dev'
+Requires-Dist: testcontainers[postgres]>=4.0; extra == 'dev'
+Requires-Dist: ty>=0.0.1a8; extra == 'dev'
+Requires-Dist: uvicorn>=0.30; extra == 'dev'
+Provides-Extra: e2b
+Requires-Dist: e2b<3,>=2.28; extra == 'e2b'
+Provides-Extra: egress
+Requires-Dist: cryptography>=42; extra == 'egress'
+Provides-Extra: files
+Requires-Dist: pillow>=10; extra == 'files'
+Requires-Dist: pypdf>=4; extra == 'files'
+Provides-Extra: microsandbox
+Requires-Dist: microsandbox==0.6.6; extra == 'microsandbox'
+Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.20; extra == 'otel'
+Requires-Dist: opentelemetry-sdk>=1.20; extra == 'otel'
+Provides-Extra: postgres
+Requires-Dist: psycopg-pool>=3.2; extra == 'postgres'
+Requires-Dist: psycopg[binary]>=3.2; extra == 'postgres'
+Provides-Extra: server
+Requires-Dist: fastapi>=0.115; extra == 'server'
+Requires-Dist: sse-starlette>=2.0; extra == 'server'
+Requires-Dist: uvicorn>=0.30; extra == 'server'
+Provides-Extra: vertex
+Requires-Dist: google-auth[requests]<3,>=2; extra == 'vertex'
+Description-Content-Type: text/markdown
+
+# Cayu
+
+Cayu is a runtime for building production AI agents in Python.
+
+It provides the durable execution layer—sessions, model calls, tool execution,
+approvals, context management, budgets, recovery, events, and evals—while
+applications retain control of their UI, authentication, domain logic, and
+workflows.
+
+Cayu is designed for agents that do consequential or long-running work. It is
+not a prompt-chain DSL, a visual workflow builder, or an application frontend;
+you compose its runtime primitives directly.
+
+## Why Cayu
+
+Agent prototypes are easy to start. Production failures happen at the
+boundaries:
+
+- a process dies after a side effect but before state is recorded;
+- a model requests a valid tool with the wrong authority;
+- a run needs human input or approval halfway through;
+- context grows until a provider rejects the next request;
+- retries, forks, or subagents lose cost and causal attribution;
+- operators cannot reconstruct what happened from prompt text alone; or
+- evals test final prose while missing the runtime trajectory.
+
+Cayu treats these as runtime contracts. Important actions become structured
+events; tool authority and recovery are explicit; configured durable stores let
+transcripts and checkpoints survive process boundaries; and the same public
+seams support local development, tests, control-plane inspection, and hosted
+deployments.
+
+## What Cayu provides
+
+| Need | Cayu primitive |
+| --- | --- |
+| Long-running work | Durable sessions, transcripts, events, resume, fork, interruption |
+| Safe effects | Typed tools, effect declarations, policies, approvals, idempotency keys |
+| Human interaction | User-input checkpoints, approval resolution, manual recovery |
+| Context pressure | Token counting, projection, compaction, overflow recovery |
+| Cost control | Usage events, run limits, budgets, pricing, causal-budget summaries |
+| Execution boundaries | Environments, workspaces, runners, artifacts, vaults, egress |
+| Reviewed knowledge | Durable entries, approval state, keyword/vector retrieval, recall tools |
+| Provider flexibility | OpenAI, Anthropic, Bedrock, Vertex, OpenAI-compatible APIs |
+| Durable automation | Tasks, dispatchers, event watchers, subagents, runtime hooks |
+| Behavioral proof | Runtime tests, trajectory assertions, replay, eval reports |
+| Operations | FastAPI control plane and a packaged inspection dashboard |
+
+## Quickstart
+
+### Start a project
+
+The generated project is the recommended path for both humans and coding
+agents. Cayu requires Python 3.11 or newer.
+
+```bash
+pip install cayu pytest
+cayu new myagent
+cd myagent
+
+cayu inspect --json
+cayu check --json
+pytest
+cayu eval run evals.assistant:build_eval
+```
+
+The scaffold is credential-free and includes:
+
+- a process-scoped `build_app()` factory with bounded local-store initialization;
+- one safe example tool;
+- a hermetic runtime test and trajectory eval; and
+- a project-local `AGENTS.md` with the exact build and verification contract.
+
+Open the generated project, replace the tracer-bullet behavior with your domain
+behavior, and keep the public test/eval seam intact.
+
+### Run an agent
+
+This compact example shows the core API. Real projects should put the same
+registrations in the generated `build_app()` factory instead of constructing a
+module-global app.
+
+```python
+import asyncio
+
+from cayu import (
+    AgentSpec,
+    CayuApp,
+    Message,
+    OpenAIProvider,
+    RunRequest,
+    run_to_completion,
+)
+
+
+async def main() -> None:
+    app = CayuApp()
+    app.register_provider(OpenAIProvider(), default=True)  # reads OPENAI_API_KEY
+    app.register_agent(AgentSpec(name="assistant", model="gpt-5.6"))
+
+    outcome = await run_to_completion(
+        app,
+        RunRequest(
+            agent_name="assistant",
+            messages=[Message.text("user", "Explain durable agent sessions.")],
+        ),
+    )
+
+    if outcome.ok:
+        print(outcome.final_text)
+    else:
+        print(f"{outcome.status}: {outcome.error}")
+
+
+asyncio.run(main())
+```
+
+`CayuApp()` uses in-memory stores by default, which is appropriate for this
+one-shot example and for tests. The generated project configures SQLite so its
+sessions survive process restarts. Multi-process production deployments should
+select a conforming shared store such as PostgreSQL.
+
+`CayuApp.run(...)` is the lower-level event-stream API. Runtime failures are
+terminal `session.failed` events, not exceptions raised from iteration.
+`run_to_completion(...)` consumes that same stream and returns a typed outcome
+when an application only needs the result. It retains the complete event stream
+in `RunOutcome.events`; use it for bounded runs. Consume `CayuApp.run(...)`
+incrementally for long-lived or high-volume runs.
+
+For a runnable example with no API key, use
+[`examples/echo_tool_runtime.py`](https://github.com/vertexkg/cayu/blob/main/examples/echo_tool_runtime.py). To add
+workspace tools and command execution, see
+[`examples/local_environment_runtime.py`](https://github.com/vertexkg/cayu/blob/main/examples/local_environment_runtime.py).
+
+### Build with a coding agent
+
+The generated `AGENTS.md` is the project-local source of truth. Ask the coding
+agent to read it first, then use Cayu's package-shipped guides and structured
+inspection:
+
+```bash
+cayu guide anatomy
+cayu guide authoring
+cayu inspect --json
+cayu check --fail-on warning --json
+```
+
+The supported authoring loop is:
+
+```text
+understand -> inspect -> plan -> change -> test -> eval -> exercise -> report evidence
+```
+
+Use `cayu generate slice ... --dry-run --json` to plan a small vertical slice.
+Generated slices are intentionally unfinished tracer bullets; replace their
+placeholder prompt, tool behavior, runtime test, and eval before treating them
+as application functionality.
+
+## Mental model
+
+Cayu separates the agent's identity from the resources and durable state used
+for one execution:
+
+```text
+AgentSpec
+  identity, model, instructions, defaults, runtime policies
+
+Environment
+  workspace, runner, artifacts, vault, proxy, knowledge, MCP
+
+Session
+  durable identity, transcript, events, status, checkpoints
+
+ToolContext
+  the active environment services and call identity for one tool execution
+```
+
+- **Agent** describes who is acting and how model work is configured.
+- **Environment** describes what that agent can touch.
+- **Session** records one durable execution and its lineage.
+- **Tool** is an explicitly registered capability, not arbitrary model code.
+- **Task** is an optional durable unit of background or orchestrated work.
+- **Workflow** is deterministic application orchestration around agent steps.
+
+An environment is optional for a conversational agent. It becomes important
+when tools need files, commands, artifacts, secrets, network policy, or a
+sandbox. Static environments are useful for trusted local work;
+`EnvironmentFactory` creates or reattaches session-specific environments in
+production.
+
+## Use the smallest runtime shape
+
+Do not add every Cayu primitive to every application.
+
+| Desired behavior | Start with |
+| --- | --- |
+| One model-driven interaction | `CayuApp`, `AgentSpec`, provider, `RunRequest` |
+| Deterministic model-callable action | `Tool`, `ToolSpec`, explicit `ToolEffect` |
+| Authority over an effect | `ToolPolicy`; approval only where a human gate is required |
+| Mutable files or commands | Explicit `Environment`, `Workspace`, and `Runner` |
+| Durable uploaded or generated files | `ArtifactStore` |
+| Long-lived conversation or recovery | Durable `SessionStore` and checkpoint APIs |
+| Background durable work | `TaskStore` plus an explicitly started worker |
+| Delegated model work | Subagent tools with bounded child-session policy |
+| Behavioral regression proof | `EvalSuite` and trajectory assertions |
+
+A conversation agent does not automatically need a workflow, task queue,
+environment, memory store, server, or multi-agent topology. A coding agent does
+not automatically need unrestricted shell access. Prefer narrow domain tools
+and add authority only when the behavior requires it.
+
+## Application UI and control plane
+
+Your application should own:
+
+- end-user prompts and domain forms;
+- product authentication and authorization;
+- business-specific workflow and state;
+- user-facing streaming, notifications, and presentation; and
+- decisions about when a run, task, approval, or interruption is allowed.
+
+Cayu owns runtime execution and the operational state recorded by the
+application's configured stores. Its optional dashboard is a control plane for
+developers and operators: inspect sessions,
+events, transcripts, tasks, usage, artifacts, pending actions, and recovery
+state. It is not intended to replace the product experience your users need.
+
+Start work through the API that matches the trigger:
+
+- `run` for an immediate new session;
+- `resume` for a deliberate continuation;
+- `dispatch` for placement through a dispatcher;
+- a task worker for durable queued work;
+- a subagent for model-selected bounded delegation; or
+- an event watcher for durable reactions to already-persisted events.
+
+See [Triggering runs](https://github.com/vertexkg/cayu/blob/main/docs/triggering-runs.md) for the decision guide and
+lifecycle responsibilities.
+
+## Providers and environments
+
+The base package includes the provider contracts and built-in OpenAI, Anthropic,
+and OpenAI-compatible HTTP adapters. Optional extras add integrations without
+forcing their dependencies into every deployment:
+
+| Extra | Adds |
+| --- | --- |
+| `cayu[server]` | FastAPI control plane and packaged dashboard |
+| `cayu[postgres]` | PostgreSQL session, task, knowledge, and related stores |
+| `cayu[aws]` | Amazon Bedrock and Lambda MicroVM support |
+| `cayu[vertex]` | Anthropic models through Google Cloud Vertex AI |
+| `cayu[e2b]` | E2B runner and workspace |
+| `cayu[microsandbox]` | Local microVM-backed untrusted-code runner |
+| `cayu[egress]` | Virtual egress and credential-broker primitives |
+| `cayu[files]` | Image and PDF inspection |
+| `cayu[console]` | Interactive application console |
+
+Providers normalize text, thinking, tool calls, usage, completion reasons, and
+typed failures behind one runtime contract. Cayu does not infer a provider from
+an arbitrary model name: applications register providers explicitly and may
+add deterministic model-pattern routing.
+
+The same agent can run in a local workspace, trusted Docker container, E2B,
+Microsandbox, Lambda MicroVM, or an application-owned runner without changing
+its identity or transcript contract.
+
+## Production boundaries
+
+Cayu makes safety boundaries explicit, but configuration still matters:
+
+- `LocalRunner` is trusted local execution, not a sandbox.
+- `DockerRunner` is useful for development and CI; ordinary Docker isolation
+  is not presented as a secure untrusted-code boundary.
+- Environment registration does not imply selection: mark a default explicitly
+  or name the environment on the request. Provider defaults and model-pattern
+  routing should likewise be configured deliberately and kept unambiguous.
+- Tool effects do not authorize themselves. Use policies, approvals, scoped
+  credentials, and destination controls where consequences require them.
+- SQLite is appropriate for local and single-writer deployments. Use PostgreSQL
+  or another conforming shared store for sustained multi-process concurrency.
+- The FastAPI control plane requires authentication outside explicit
+  `dev=True`; protect it as an operator surface, not an end-user endpoint.
+  Generated API documentation is a separate exposure decision.
+- Usage is derived from recorded events and survives restarts when those events
+  use a durable store; cost remains an estimate against the price book your
+  application selects.
+- Recovery never invents the outcome of an ambiguous external side effect.
+  Reconcile it through the typed recovery APIs.
+
+Read [Runtime contracts](https://github.com/vertexkg/cayu/blob/main/docs/runtime-contracts.md) before changing persistence,
+replay, approval, interruption, budget, provider, runner, or recovery behavior.
+
+## Documentation
+
+Start with the document that matches the job:
+
+| Goal | Guide |
+| --- | --- |
+| Build an application, by hand or with an AI coding agent | [Authoring guide](https://github.com/vertexkg/cayu/blob/main/src/cayu/guides/authoring.md) |
+| Classify tool mutation and replay behavior | [Tool effects](https://github.com/vertexkg/cayu/blob/main/src/cayu/guides/tool-effects.md) |
+| Understand factories, process roles, and lifecycle | [Application anatomy](https://github.com/vertexkg/cayu/blob/main/src/cayu/guides/application-anatomy.md) |
+| Choose how work starts | [Triggering runs](https://github.com/vertexkg/cayu/blob/main/docs/triggering-runs.md) |
+| Create per-session workspaces and runners | [Environment factories](https://github.com/vertexkg/cayu/blob/main/docs/environment-factories.md) |
+| Implement a runner for your platform | [Build a runner](https://github.com/vertexkg/cayu/blob/main/docs/build-a-runner.md) |
+| Configure network and credential boundaries | [Virtual egress](https://github.com/vertexkg/cayu/blob/main/docs/virtual-egress.md) |
+| Design assertions and trajectory evals | [Evals](https://github.com/vertexkg/cayu/blob/main/docs/evals.md) |
+| Estimate and govern cost | [Cost optimization](https://github.com/vertexkg/cayu/blob/main/docs/cost-optimization.md) |
+| Use the application console | [Console](https://github.com/vertexkg/cayu/blob/main/docs/console.md) |
+| Inspect supported model metadata | [Model catalog](https://github.com/vertexkg/cayu/blob/main/docs/model-catalog.md) |
+| Look up exact runtime behavior | [Runtime contracts](https://github.com/vertexkg/cayu/blob/main/docs/runtime-contracts.md) |
+| Track prerelease behavior and migrations | [Release notes](https://github.com/vertexkg/cayu/blob/main/docs/release-notes.md) |
+
+Maintainer-facing architecture is documented in
+[Architecture](https://github.com/vertexkg/cayu/blob/main/docs/architecture.md),
+[Project layout](https://github.com/vertexkg/cayu/blob/main/docs/project-layout.md),
+and the [Glossary](https://github.com/vertexkg/cayu/blob/main/docs/glossary.md).
+
+## Examples
+
+- [Echo tool runtime](https://github.com/vertexkg/cayu/blob/main/examples/echo_tool_runtime.py) — credential-free model/tool loop.
+- [Local environment runtime](https://github.com/vertexkg/cayu/blob/main/examples/local_environment_runtime.py) — files and commands.
+- [Server example](https://github.com/vertexkg/cayu/blob/main/examples/server_example.py) — protected API and control plane.
+- [Cloud PR reviewer](https://github.com/vertexkg/cayu/blob/main/docs/recipes/pr-reviewer.md) — durable task, isolated workspace,
+  QA, and an explicit external effect.
+- [Business approvals](https://github.com/vertexkg/cayu/blob/main/docs/recipes/business-approvals.md) — domain approval routing
+  over the binary runtime primitive.
+- [Advanced runtime examples](https://github.com/vertexkg/cayu/blob/main/examples/ADVANCED_RUNTIME_EXAMPLES.md) — forks,
+  compaction, taint isolation, speculative approval, and measured evidence.
+
+Advanced examples are executable runtime specifications, not claims that one
+strategy fits every workload. Their evidence boundaries and measured results
+are described in
+[Advanced runtime strategies](https://github.com/vertexkg/cayu/blob/main/docs/advanced-runtime-examples.md).
+
+## Contributing and security
+
+Framework contributors should read
+[CONTRIBUTING.md](https://github.com/vertexkg/cayu/blob/main/CONTRIBUTING.md) for
+placement policy, setup, validation commands, and pull-request requirements.
+New third-party integrations normally live in their own packages against
+Cayu's public extension contracts.
+
+Report suspected vulnerabilities privately as described in
+[SECURITY.md](https://github.com/vertexkg/cayu/blob/main/SECURITY.md). Do not open a public issue or pull request for a
+suspected security vulnerability.
+
+For questions and project discussion, join
+[Discord](https://discord.gg/jWa3kKJ7R8). Use
+[GitHub issues](https://github.com/vertexkg/cayu/issues) for actionable bugs and
+concrete feature proposals.
+
+## License
+
+Cayu is licensed under the
+[Apache License 2.0](https://github.com/vertexkg/cayu/blob/main/LICENSE).