# Farm.js Docs

> Complete Farm.js framework documentation.

## Agent Discovery

- [Agent manifest](/.well-known/agent.json): Farming Labs discovery manifest
- [API catalog](/.well-known/api-catalog): RFC 9727 API catalog
- [Agent Skills index](/.well-known/agent-skills/index.json): Hashed Agent Skills discovery

## Pages

- [Post-response Work](/docs/after.md): Schedule short server work with after() without delaying the response.
- [API Client](/docs/api-client.md): Call app API routes with api.hello.get style inference, cache policies, invalidation, retries, callbacks, and optimistic updates.
- [API Routes](/docs/api-routes.md): Expose HTTP handlers from src/app/api and validate input with schemas before handler code runs.
- [Built-in Authentication](/docs/auth.md): Enable Farm's built-in email/password authentication with one config key, server helpers, and a React hook.
- [Cache and PPR](/docs/cache-ppr.md): Use shared runtime cache helpers, tag/path invalidation, ISR-style revalidation, and static shell caching for PPR pages.
- [CLI](/docs/cli.md): Use the Farm CLI to run, build, generate types, migrate apps, deploy output, and add integrations.
- [Configuration](/docs/configuration.md): Use farm.config.ts as the single project control plane for source paths, integrations, docs, KV storage, database clients, deployment, and framework behavior.
- [Cron](/docs/cron.md): Map portable UTC schedules to ordinary Farm API routes, run them locally, and compile them to deployment-native cron triggers.
- [Deployment](/docs/deployment.md): Build deployable output with Farm's deploy config and Nitro presets, from first-class targets to custom Nitro output.
- [DevTools and Doctor](/docs/devtools.md): Inspect Farm's resolved routes, APIs, integrations, KV storage, schedules, deployment settings, and diagnostics in the browser or terminal.
- [Docs Engine](/docs/docs-engine.md): Serve a @farming-labs/docs-powered docs runtime from Farm config, including human pages and agent-readable API routes.
- [Environment Functions](/docs/environment-functions.md): Keep server-only and client-only implementations out of the wrong Farm bundle.
- [Examples](/docs/examples.md): Use the examples folder as executable docs for routing, RSC, agents, docs, markdown, auth, billing, email, jobs, and API keys.
- [Fonts](/docs/fonts.md): Load local and remote fonts as self-hosted, hashed Farm assets without runtime loader code.
- [Getting Started](/docs/getting-started.md): Create a Farm.js app, understand the files that matter, and run the development server.
- [Images](/docs/images.md): Render responsive images with static dimensions, blur placeholders, secure remote optimization, and deployment-native providers.
- [Auth0 Integration](/docs/integrations/auth/auth0.md): Add Auth0 login, callback, logout, profile, and protected-route flows to Farm.
- [Auth.js Integration](/docs/integrations/auth/authjs.md): Mount an Auth.js handler at Farm's catch-all auth route and keep using Auth.js native helpers.
- [Better Auth Integration](/docs/integrations/auth/better-auth.md): Mount a Better Auth instance in Farm and use its native client, database adapter, methods, and plugins.
- [Clerk Integration](/docs/integrations/auth/clerk.md): Register ClerkProvider and protect Farm routes with Clerk request authentication.
- [Auth Integrations](/docs/integrations/auth.md): Choose and configure Better Auth, Auth.js, Clerk, Auth0, WorkOS, or Supabase in a Farm app.
- [Supabase Integration](/docs/integrations/auth/supabase.md): Use Supabase email/password auth, OAuth, SSR sessions, custom pages, and protected Farm routes.
- [WorkOS Integration](/docs/integrations/auth/workos.md): Add WorkOS AuthKit login, sealed sessions, logout, and protected routes to Farm.
- [Autumn Integration](/docs/integrations/autumn.md): Add subscription and usage billing with Autumn while keeping Farm's integration and database APIs stable.
- [Cloudflare Agents Integration](/docs/integrations/cf-agent.md): Run Cloudflare Agents beside Farm and deploy the UI, Agent classes, WebSockets, and Durable Objects as one Worker.
- [Custom Integrations](/docs/integrations/custom.md): Build a first-class Farm integration with typed APIs, route handlers, lifecycle hooks, config validation, middleware, providers, database schemas, and runtime logs.
- [Resend Integration](/docs/integrations/email.md): Render React Email templates, send with Resend, schedule messages, preview templates, and receive webhooks.
- [Eve Integration](/docs/integrations/eve.md): Run a filesystem-first Eve agent beside Farm with same-origin routes and automatic Vercel composition.
- [Inngest Integration](/docs/integrations/inngest.md): Send typed events to existing Inngest functions, batch them, and inspect runs from Farm.
- [Jobs Integration](/docs/integrations/jobs.md): Define typed job contracts and call existing Trigger.dev tasks or Inngest functions through one Farm API.
- [Database and ORM Clients](/docs/integrations/orm-storage.md): Use relational models through @farming-labs/orm, schema-backed Farm integrations, or an integration's own database adapter.
- [Integrations](/docs/integrations.md): Register services once, get owned routes, typed callers, agent runtimes, providers, middleware, database models, lifecycle hooks, and validation.
- [Polar Integration](/docs/integrations/polar.md): Use Polar for products, checkout, customer portals, subscriptions, webhooks, and entitlement-aware app flows.
- [Stripe Integration](/docs/integrations/stripe.md): Add checkout, portal sessions, billing status, webhooks, product catalogs, metering, and database-backed billing snapshots.
- [Trigger.dev Integration](/docs/integrations/trigger.md): Trigger, schedule, batch, inspect, and cancel existing Trigger.dev tasks through typed Farm callers.
- [UI Registry](/docs/integrations/ui-registry.md): Opt into shadcn-style UI scaffolds for built-in integrations when you want working screens with the integration setup.
- [Unkey Integration](/docs/integrations/unkey.md): Create, verify, revoke, update, and delete API keys, plus protect routes with key verification and rate-limit checks.
- [Internationalization](/docs/internationalization.md): Build localized Farm apps with typed ICU messages, locale-aware routing, request detection, formatting, caching, and RTL from one config.
- [Layers](/docs/layers.md): Compose reusable Farm application directories and packages with predictable project overrides.
- [Layouts and Route Boundaries](/docs/layouts.md): Wrap routes with root and nested layouts, then use loading, error, and not-found files for route-level UX.
- [Markdown Mirrors](/docs/markdown.md): Expose markdown versions of app pages so agents, crawlers, docs tools, and support workflows can read rendered content as text.
- [Middleware](/docs/middleware.md): Run request behavior before routes, pass request-scoped data to pages, and short-circuit with redirects or responses.
- [Migrate from Next.js](/docs/migrations/nextjs.md): Move a Next.js App Router project to Farm with the built-in dry-run-first migrator.
- [Migrate from Nuxt](/docs/migrations/nuxt.md): Move a Nuxt application to Farm by mapping Vue pages, layouts, server routes, middleware, data, and runtime configuration.
- [Migrations](/docs/migrations.md): Move apps from the frameworks featured on the homepage with source-specific automated and manual guides.
- [Migrate from SvelteKit](/docs/migrations/sveltekit.md): Move a SvelteKit application to Farm by mapping routes, layouts, load functions, endpoints, hooks, environment variables, and adapters.
- [Migrate from TanStack Start](/docs/migrations/tanstack.md): Move TanStack Start or TanStack Router file routes to Farm with the built-in migrator.
- [Observability and tracing](/docs/observability.md): Export OpenTelemetry traces and listen to correlated Farm runtime events in development and production.
- [OpenAPI Reference](/docs/openapi.md): Generate and publish API reference docs from Farm API route metadata, with Scalar-style presentation.
- [Farm.js Documentation](/docs.md): The complete Farm.js framework guide, powered by @farming-labs/docs.
- [Bundle Analyzer](/docs/plugins/analyzer.md): Understand the client and server weight of a Farm production build, connect initial assets to emitted pages, and enforce size limits in CI.
- [Client Plugin API](/docs/plugins/client.md): Define typed hydration, navigation, error, performance, and cleanup hooks directly inside a Farm plugin.
- [Create a Plugin](/docs/plugins/create-plugin.md): Build a typed Farm plugin with private state, request context, Web Request transforms, and framework lifecycle hooks.
- [Plugin Ecosystem](/docs/plugins.md): Extend Farm's server and browser lifecycle with typed runtime, router, render, build, navigation, and development hooks.
- [PWA Plugin](/docs/plugins/pwa.md): Generate a route-aware service worker with safe offline navigation, update prompts, and concise SWR image caching.
- [Sentry](/docs/plugins/sentry.md): Report Farm server errors with route context, trace requests, and flush pending Sentry events safely.
- [Instant Preview](/docs/preview.md): Expose a running local Farm app through a public URL for sharing, webhook testing, OAuth callbacks, mobile QA, and browser automation.
- [Project Structure](/docs/project-structure.md): The compact file layout Farm expects, plus the optional files you add only when the app needs them.
- [Query and Params](/docs/query.md): Parse search params and route params with typed helpers on the server and synchronized state on the client.
- [Reference](/docs/reference.md): A compact map of the main package exports and where to learn more.
- [Renderers](/docs/renderers.md): Choose React, Preact, Solid, Vue, or Svelte for application UI while keeping FARMJS routing, server APIs, middleware, observability, and deployment.
- [Preact Renderer](/docs/renderers/preact.md): Use Preact components, hooks, SSR, streaming, hydration, and typed FARMJS server calls through the @farm.js/preact adapter.
- [React Renderer](/docs/renderers/react.md): Use FARMJS with the default React renderer, including client hooks, streaming SSR, and the experimental AOT compiler.
- [Solid Renderer](/docs/renderers/solid.md): Use Solid components, signals, SSR, and hydration with FARMJS routing and renderer-neutral server primitives.
- [Svelte Renderer](/docs/renderers/svelte.md): Use Svelte 5 components, runes, SSR, hydration, and typed FARMJS server calls through the @farm.js/svelte adapter.
- [Vue Renderer](/docs/renderers/vue.md): Use Vue Single-File Components, SSR, hydration, and typed FARMJS server calls through the @farm.js/vue adapter.
- [Route Runtime](/docs/route-runtime.md): Choose where dynamic pages and API routes execute, inherit deployment defaults from layouts, and set provider duration and region hints.
- [Routing](/docs/routing.md): Farm uses an app directory routing model with static routes, dynamic segments, catch-all routes, and typed navigation.
- [Server Queries](/docs/server-queries.md): Define typed server reads once, deduplicate requests, prefetch browser data, use stale-while-revalidate, and invalidate route, API, and query consumers with one key.
- [Rendering Model](/docs/server-rendering.md): Choose dynamic rendering, static rendering, ISR, or PPR with route-level exports and config.
- [KV Storage](/docs/storage.md): Use Farm's key/value API for caches, settings, counters, idempotency records, and object-backed values.
- [Product telemetry](/docs/telemetry.md): Understand and control Farm.js CLI and production-site telemetry.
- [Testing](/docs/testing.md): Test Farm requests, programmatic routes, API endpoints, and server functions with the real framework runtimes.
- [Themes](/docs/themes.md): Configure light, dark, and system color modes with a pre-paint selector, Tailwind variants, and typed client and server APIs.