How-to Guides
Task-oriented instructions for accomplishing specific goals with Roost.
Guides assume you already know the basics. Each one addresses a specific goal — how to configure something, how to integrate a feature, how to solve a particular problem.
Cross-cutting
Guides that span multiple packages or apply to the full application lifecycle.
- Migrations — create, run, rollback, and define columns
- Deployment — deploy to Cloudflare Workers, custom domains, previews
- Environment — .dev.vars, production secrets, per-environment config
- Error Handling — routes, jobs, logging, custom error responses
Core
Guides for the foundational packages every Roost app uses.
- @roostjs/core — service providers, DI bindings, middleware, config
- @roostjs/cloudflare — D1, R2, KV, Queues, Workers AI, Vectorize
- @roostjs/start — routes, server functions, SSR
Features
Guides for feature packages you add as your application grows.
- @roostjs/auth — authentication, roles, multi-tenancy, sessions, CSRF
- @roostjs/orm — models, migrations, queries, relationships, factories
- @roostjs/ai — agents, tools, streaming, conversation memory
- @roostjs/mcp — MCP servers, tools, resources, prompts
- @roostjs/billing — Stripe, subscriptions, webhooks, metered billing
- @roostjs/queue — jobs, dispatch, chains, batches, retries
Tooling
Guides for the development and testing tools.