# Documentation

- [Documentation](/docs): One law. Eight elements. Ten exports.
- Get Started
  - [Introduction](/docs/get-started/introduction): Learn the one idea behind okengine — then the eight elements and ten exports.
  - [Comparison](/docs/get-started/comparison): How OKE compares to Hono, Elysia, Encore.ts, and iii — and when to pick it.
  - [Installation](/docs/get-started/installation): Install okengine, scaffold an app with create-oke, and open the Console.
  - [Basic Usage](/docs/get-started/basic-usage): Your first flows, typed client, and tests — using the Notes example.
- Elements
  - [Flow](/docs/elements/flow): behavior — Endpoints, jobs, consumers, and workflows are one species. You bind a typed trigger with `on`, declare contracts, and implement `do` through `fx`.
  - [Signal](/docs/elements/signal): data in motion — Queues, pub/sub, and streams collapse into one Signal. Delivery physics (`once` · `broadcast` · `live`) is mandatory — no silent default.
  - [Store](/docs/elements/store): data at rest (sql · kv · files · index) — SQL, KV, files, and search index are facets of one Store surface. Drivers are named after protocols, not vendors.
  - [Clock](/docs/elements/clock): time — Cron, delay, timeout, durable sleep, and TTL — time as an element, not a bolted-on scheduler library.
  - [Gate](/docs/elements/gate): permission to act — Auth, session, ABAC, rate limits, quotas, and feature flags sit at the trigger — permission to act before effects run.
  - [Vault](/docs/elements/vault): protected knowledge — Secrets, config, and environment with typed contracts — protected knowledge, not a loose bag of env vars.
  - [Channel](/docs/elements/channel): reaching humans — Email, SMS, WhatsApp, and push have physics Signal cannot express: consent, locale, receipts, and fallback chains.
  - [AI](/docs/elements/ai): reaching machine intelligence — Models, prompts, agents, and RAG earn an element slot: non-determinism, cost, versioned prompts, egress privacy, and different test physics.
- Console
  - [Overview](/docs/console/overview): Is the system healthy right now?
  - [Flows](/docs/console/flows): What exists; call it; read its contract.
  - [Signals](/docs/console/signals): Queue depth, in-flight, DLQ, live monitors.
  - [Store](/docs/console/store): Browse sql/kv/files/index; cache keys; replica lag.
  - [Clock](/docs/console/clock): Upcoming crons, sleeping durable flows, journal.
  - [Gates](/docs/console/gates): Permission matrix, rate counters, MFA map.
  - [Vault](/docs/console/vault): Secret contracts, who can read each, rotation due.
  - [Channels](/docs/console/channels): Templates, delivery receipts, bounces, opt-outs.
  - [AI](/docs/console/ai): Prompt versions, eval scores, cost, agent runs.
  - [Architecture](/docs/console/architecture): How it all connects — the diagram that is the code.
  - [Traces](/docs/console/traces): One timeline across http → store → signal → durable steps.
  - [Runs](/docs/console/runs): Wide events — one record per flow execution.
  - [Manifest Diff](/docs/console/manifest-diff): Blast radius of a deploy: new effects, widened permissions.
  - [Access](/docs/console/access): Identities, roles, API keys.
  - [Plugins](/docs/console/plugins): Installed plugins and their contributed panels.
  - [Privacy](/docs/console/privacy): Where PII lives, who touches it, export/erase (conditional).
  - [Tenancy](/docs/console/tenancy): Per-tenant usage, limits, isolation checks (conditional).
- Learn
  - [Notes](/docs/learn/notes): Basic — the one law, contracts, typed errors, the client.
  - [Linkly](/docs/learn/linkly): Intermediate — Signal, Clock, Gate, delivery physics.
  - [Provisions](/docs/learn/provisions): Advanced — durability, Vault, Channel, plugins.
  - [Skyport](/docs/learn/skyport): Complex — AI, tenancy, SLOs, distributed topology.
- [Plugins](/docs/plugins): The extensibility law — public plugin API only.
- [CLI Reference](/docs/cli): oke and create-oke — everyday commands and flags.
- [Security](/docs/security): Console security posture — DNS rebinding, XSS, MCP.
- AI Resources
  - [AI Resources](/docs/ai/resources): AGENTS.md, MCP :6535, and machine-readable docs surfaces.