Agent-readable wiki

Emulate — Plain-Language Wiki

vercel-labs/emulate runs real, stateful local copies of external APIs (GitHub, Google, Slack, Stripe, and more) so your app can work offline, in CI, and in sandboxes without ever calling the real internet. Think of it as a recording studio that plays back exactly what each cloud service would say.

Pages

  1. Explain It Simply — What Emulate DoesPlain-language explanation of the problem emulate solves, the one analogy to hold in your head, and the three ideas you must not forget before reading anything else.
  2. Telling Emulate What World to Create — Seed ConfigHow the YAML/JSON seed file pre-populates users, repos, OAuth clients, messages, and tokens before any test runs, and why this makes tests deterministic without touching the real internet.
  3. The Engine Under the Hood — @emulators/coreWhat the shared core package actually provides: the in-memory Store (collections of entities), the Hono HTTP server, auth middleware, OAuth helpers, webhook dispatcher, and pagination — the pieces every service plugin relies on.
  4. The Registry — How Each Service Gets Wired InHow registry.ts acts as the master switchboard: each ServiceEntry knows how to lazy-load its plugin package, what endpoints it covers, what default auth fallback to use, and what starter config to generate with `emulate init`.
  5. Using Emulate in Code — The Programmatic APIHow `createEmulator()` in api.ts lets test suites spin up a single service, get its URL, call `reset()` between tests, and `close()` when done — without touching the CLI at all.
  6. OAuth & Identity Services — Google, Apple, Microsoft, Okta, ClerkThe five emulators that pretend to be identity providers: what OAuth/OIDC flows each one covers, how the auto-login fallback bypasses the browser consent screen in CI, and what each package lives in.
  7. Platform & Infrastructure Services — GitHub, Vercel, Slack, AWS, Stripe, Resend, MongoDB AtlasThe seven emulators covering developer platforms and cloud infrastructure: what REST surface area each one reproduces, how webhooks are dispatched in-process, and what the examples directory shows about wiring them into a Next.js app.
  8. The One Map to Keep — Core Ideas RecappedA single-page recap: the core idea in one sentence, the three moving parts every developer must know (Store, ServicePlugin, registry entry), the analogy that holds, important caveats about what emulate is NOT, and where to go next.

Complete Markdown

The complete agent-readable Markdown files are published separately from this HTML page.