Getting Started
Embed Yoke in your product, then learn the internal actor package and local CLI workflow.
Yoke is an embeddable runtime for always-on agentic systems. You build a product — a coding harness, an assistant, a pipeline — and your server runs Yoke. End users never see Yoke.
This section covers that host model, then the local tools you use while writing the internal actor package.
Embed Yoke in your product
The intended use — your server embeds yoke-runtime. Users talk to you.
Installation
Rust, Deno 2, Postgres 16, Docker Compose, and environment variables.
Quick start
Build a minimal package and see stream fan-out via the authoring CLI.
Your first package
Internal yoke.ts — defineRuntime, actors, portals, events.
What you are building
Two layers, one product:
Your product server (Rust) ← public HTTP, CLI, workspaces, auth
embeds yoke-runtime
→ Postgres (stream, instances, queues, conversations)
→ Deno worker
→ your internal package (defineRuntime / process)The internal package is a folder of TypeScript that exports defineRuntime(). The kernel loads it in an embedded Deno worker. That package is implementation detail. The yoke CLI (yoke dev ./your-package) is how you iterate on it — not how customers run your product.
Yoke is not an LLM framework and not a coding harness. An actor is any stateful async event processor. Your product decides what users see; Yoke runs the event-driven mesh underneath.
Recommended path
Read Embed Yoke in your product — host vs internal package, embed API vs @yoke/sdk.
Complete Installation — Postgres, Rust toolchain, Deno 2, and YOKE_STORAGE.
Follow Quick start to build a minimal package and see stream fan-out locally.
Read Your first package to structure the TypeScript the kernel loads.
Learn the mental model, then put YokeRuntime::start in your server.
Minimal package shape
A typical learning package is a Slack portal, a router actor, and a coder actor — enough to see ingress, fan-out, and egress without building a full product host. Real products wrap a package like this (or a full agent mesh) inside their own server. See Quick start for inline code you can copy into ./your-package.