{
  "name": "zigbase",
  "version": "0.13.0",
  "site": "https://valthon.github.io/zigbase",
  "llms_txt": "https://valthon.github.io/zigbase/llms.txt",
  "generated_from": "site/scripts/docs-registry.json",
  "groups": {
    "getting-started": "Getting started",
    "guides": "Guides",
    "features": "Feature guides",
    "reference": "Reference"
  },
  "docs": [
    {
      "slug": "postgres",
      "title": "PostgreSQL backend",
      "description": "Run ZigBase on PostgreSQL — the -Dpostgres build, ZIGBASE_DB_URL, multi-instance realtime, migrating from SQLite with migrate-db, and pgvector.",
      "group": "features",
      "order": 1,
      "canonical": "docs/postgres.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/postgres.md",
      "url": "https://valthon.github.io/zigbase/docs/postgres/"
    },
    {
      "slug": "tenancy",
      "title": "Multi-tenancy",
      "description": "Account-scoped collections — enabling tenancy, tenant_field, accounts/memberships/invitations, roles, and the @request.account rule macros.",
      "group": "features",
      "order": 2,
      "canonical": "docs/tenancy.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/tenancy.md",
      "url": "https://valthon.github.io/zigbase/docs/tenancy/"
    },
    {
      "slug": "abilities",
      "title": "Relationship abilities",
      "description": "Per-collection, per-action authorization by the principal's relationship to the row — declaring abilities, ctx.can, and the abilities endpoint.",
      "group": "features",
      "order": 3,
      "canonical": "docs/abilities.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/abilities.md",
      "url": "https://valthon.github.io/zigbase/docs/abilities/"
    },
    {
      "slug": "search",
      "title": "Full-text & vector search",
      "description": "Ranked ?search= queries on searchable fields, operators, how search composes with filters and rules, and opt-in -Dvector KNN.",
      "group": "features",
      "order": 4,
      "canonical": "docs/search.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/search.md",
      "url": "https://valthon.github.io/zigbase/docs/search/"
    },
    {
      "slug": "analytics",
      "title": "Product analytics",
      "description": "Capturing immutable events with ctx.track, declarative rollups, and the tenant-scoped analytics read API.",
      "group": "features",
      "order": 5,
      "canonical": "docs/analytics.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/analytics.md",
      "url": "https://valthon.github.io/zigbase/docs/analytics/"
    },
    {
      "slug": "email",
      "title": "Email",
      "description": "Sending application mail — templates, SES/Postmark/SMTP providers, verified senders, bounce suppression, and asserting mail in tests.",
      "group": "features",
      "order": 6,
      "canonical": "docs/email.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/email.md",
      "url": "https://valthon.github.io/zigbase/docs/email/"
    },
    {
      "slug": "jobs-and-webhooks",
      "title": "Jobs & webhooks",
      "description": "Background queues, workers, and job kinds — plus signed outbound webhooks with retry, backoff, and idempotency keys.",
      "group": "features",
      "order": 7,
      "canonical": "docs/jobs-and-webhooks.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/jobs-and-webhooks.md",
      "url": "https://valthon.github.io/zigbase/docs/jobs-and-webhooks/"
    },
    {
      "slug": "realtime-broadcast",
      "title": "Realtime broadcast",
      "description": "Pushing to custom WebSocket channels from routes and jobs — signal vs broadcast, and gating subscriptions with canSubscribe.",
      "group": "features",
      "order": 8,
      "canonical": "docs/realtime-broadcast.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/realtime-broadcast.md",
      "url": "https://valthon.github.io/zigbase/docs/realtime-broadcast/"
    },
    {
      "slug": "two-factor-design",
      "title": "Two-factor authentication",
      "description": "Compile-time factor selection, user and group requirements, TOTP and WebAuthn enrollment, recovery, and shared session enforcement.",
      "group": "features",
      "order": 9,
      "canonical": "docs/two-factor-design.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/two-factor-design.md",
      "url": "https://valthon.github.io/zigbase/docs/two-factor-design/"
    },
    {
      "slug": "resumable-uploads",
      "title": "Resumable uploads",
      "description": "Bounded, opt-in client file transfers with current commit authorization. Default process-local RAM or SQLite/local restart persistence; neither mode is streaming or cross-instance recovery.",
      "group": "features",
      "order": 10,
      "canonical": "docs/resumable-uploads.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/resumable-uploads.md",
      "url": "https://valthon.github.io/zigbase/docs/resumable-uploads/"
    },
    {
      "slug": "thumbnails",
      "title": "Image thumbnails",
      "description": "Named PNG, JPEG and WebP derivatives using opt-in ImageMagick with deployment resource controls.",
      "group": "features",
      "order": 11,
      "canonical": "docs/thumbnails.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/thumbnails.md",
      "url": "https://valthon.github.io/zigbase/docs/thumbnails/"
    },
    {
      "slug": "why-zigbase",
      "title": "Why ZigBase",
      "description": "Application leverage and systems control for small teams: why Zig, two development workflows, and the evidence behind the ambition.",
      "group": "getting-started",
      "order": 0,
      "canonical": "docs/why-zigbase.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/why-zigbase.md",
      "url": "https://valthon.github.io/zigbase/docs/why-zigbase/"
    },
    {
      "slug": "overview",
      "title": "Overview",
      "description": "An extensible Zig backend for ambitious applications, small teams, and development with or without coding agents.",
      "group": "getting-started",
      "order": 1,
      "canonical": null,
      "raw_url": null,
      "url": "https://valthon.github.io/zigbase/docs/overview/"
    },
    {
      "slug": "quick-start",
      "title": "Quick start",
      "description": "Install ZigBase, create a superuser, start the server, hit the health endpoint, and open the admin UI.",
      "group": "getting-started",
      "order": 2,
      "canonical": null,
      "raw_url": null,
      "url": "https://valthon.github.io/zigbase/docs/quick-start/"
    },
    {
      "slug": "tutorial",
      "title": "Tutorial",
      "description": "Build a backend end to end through the embedded admin UI or the terminal: collections, rules, auth, files, OAuth2, a route, and a cron job.",
      "group": "getting-started",
      "order": 3,
      "canonical": null,
      "raw_url": null,
      "url": "https://valthon.github.io/zigbase/docs/tutorial/"
    },
    {
      "slug": "agents",
      "title": "For coding agents",
      "description": "The ~2k-token entry point for AI agents working with ZigBase — what it is, the traps that bite, the response shapes you can rely on, and which guide to load next.",
      "group": "getting-started",
      "order": 4,
      "canonical": "docs/agents.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/agents.md",
      "url": "https://valthon.github.io/zigbase/docs/agents/"
    },
    {
      "slug": "app-genesis",
      "title": "Designing an app",
      "description": "Turn a product idea into a rules-first ZigBase design: trust boundaries, schema shape, relations, hooks and routes, cursor pagination, realtime, and test placement.",
      "group": "getting-started",
      "order": 5,
      "canonical": "docs/app-genesis.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/app-genesis.md",
      "url": "https://valthon.github.io/zigbase/docs/app-genesis/"
    },
    {
      "slug": "recipes",
      "title": "Recipes",
      "description": "Copy-pasteable recipes — provisioning a schema, signup, owner-scoped access rules, validation hooks, custom routes, and DB access in cron jobs.",
      "group": "guides",
      "order": 1,
      "canonical": "docs/recipes.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/recipes.md",
      "url": "https://valthon.github.io/zigbase/docs/recipes/"
    },
    {
      "slug": "framework",
      "title": "Framework",
      "description": "Embed ZigBase as a Zig library — comptime record hooks, custom routes, scheduled jobs, a comptime schema with additive auto-migration, pluggable storage/mailer backends, and footprint levers.",
      "group": "guides",
      "order": 2,
      "canonical": "docs/framework.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/framework.md",
      "url": "https://valthon.github.io/zigbase/docs/framework/"
    },
    {
      "slug": "testing",
      "title": "Testing",
      "description": "Test a ZigBase app in-process with zigbase.testing — the build wiring, a worked test, the auth seams, and what an in-process test structurally cannot cover.",
      "group": "guides",
      "order": 3,
      "canonical": "docs/testing.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/testing.md",
      "url": "https://valthon.github.io/zigbase/docs/testing/"
    },
    {
      "slug": "configuration",
      "title": "Configuration",
      "description": "The full environment-variable reference, CLI commands, and configuration precedence rules for the ZigBase server.",
      "group": "guides",
      "order": 3,
      "canonical": null,
      "raw_url": null,
      "url": "https://valthon.github.io/zigbase/docs/configuration/"
    },
    {
      "slug": "typescript-sdk",
      "title": "TypeScript SDK",
      "description": "The official @zigbase/client TypeScript SDK — auth, records, offset + cursor pagination, files, realtime, and the live store.",
      "group": "guides",
      "order": 4,
      "canonical": "docs/typescript-sdk.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/typescript-sdk.md",
      "url": "https://valthon.github.io/zigbase/docs/typescript-sdk/"
    },
    {
      "slug": "docker",
      "title": "Docker",
      "description": "The official ghcr.io/valthon/zigbase image — quick start, data-volume ownership, non-root user, network bind, healthchecks, and tags.",
      "group": "guides",
      "order": 5,
      "canonical": "docs/docker.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/docker.md",
      "url": "https://valthon.github.io/zigbase/docs/docker/"
    },
    {
      "slug": "zigapagos-pairing",
      "title": "Zigapagos + ZigBase full stack",
      "description": "Pair a ZigBase framework backend with a same-origin Zigapagos frontend, with explicit ownership, dev, test, OpenAPI, public-signup, and deployment contracts.",
      "group": "guides",
      "order": 5,
      "canonical": "docs/zigapagos-pairing.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/zigapagos-pairing.md",
      "url": "https://valthon.github.io/zigbase/docs/zigapagos-pairing/"
    },
    {
      "slug": "dart-sdk",
      "title": "Dart SDK",
      "description": "The official zigbase_client Dart SDK — auth, records, offset + cursor pagination, files, and realtime, for the Dart VM, Flutter, and Flutter web.",
      "group": "guides",
      "order": 6,
      "canonical": "docs/dart-sdk.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/dart-sdk.md",
      "url": "https://valthon.github.io/zigbase/docs/dart-sdk/"
    },
    {
      "slug": "python-sdk",
      "title": "Python SDK",
      "description": "The official zigbase Python SDK — sync and async clients for auth, records, offset + cursor pagination, files, realtime, and a generated typed tier.",
      "group": "guides",
      "order": 7,
      "canonical": "docs/python-sdk.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/python-sdk.md",
      "url": "https://valthon.github.io/zigbase/docs/python-sdk/"
    },
    {
      "slug": "kotlin-sdk",
      "title": "Kotlin SDK",
      "description": "The official zigbase Kotlin client — a coroutine-first ZigbaseClient over Ktor for auth, records, offset + cursor pagination, and files. Realtime and a typed tier follow.",
      "group": "guides",
      "order": 8,
      "canonical": "docs/kotlin-sdk.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/kotlin-sdk.md",
      "url": "https://valthon.github.io/zigbase/docs/kotlin-sdk/"
    },
    {
      "slug": "serve",
      "title": "Running the server",
      "description": "Foreground and background serve sessions, the stop/status/logs control verbs, ephemeral instances, and the doctor preflight.",
      "group": "guides",
      "order": 9,
      "canonical": "docs/serve.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/serve.md",
      "url": "https://valthon.github.io/zigbase/docs/serve/"
    },
    {
      "slug": "migration-tools",
      "title": "Migrate an existing backend to ZigBase",
      "description": "Re-platform an existing Rails, Express, PocketBase, or other backend onto ZigBase with schema transplant, data and password import, and parity replay.",
      "group": "guides",
      "order": 10,
      "canonical": "docs/migration-tools.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migration-tools.md",
      "url": "https://valthon.github.io/zigbase/docs/migration-tools/"
    },
    {
      "slug": "deployment",
      "title": "Deployment",
      "description": "Run ZigBase in production with systemd, Docker Compose, Fly, or Railway — TLS, durable state, backups, upgrades, rollback, and the doctor ship gate.",
      "group": "guides",
      "order": 11,
      "canonical": "docs/deployment.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/deployment.md",
      "url": "https://valthon.github.io/zigbase/docs/deployment/"
    },
    {
      "slug": "migrate-pocketbase",
      "title": "Migrate PocketBase to ZigBase",
      "description": "Migrate a stopped PocketBase 0.39.11 application with durable decisions, preserved users and timestamps, verified files, parity replay, and rollback evidence.",
      "group": "guides",
      "order": 11,
      "canonical": "docs/migrate-pocketbase.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-pocketbase.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-pocketbase/"
    },
    {
      "slug": "migrate-express",
      "title": "Migrate Express to ZigBase",
      "description": "Re-platform a Node.js Express service through route, middleware, data, auth, and side-effect discovery; deterministic import; parity replay; and rehearsed cutover.",
      "group": "guides",
      "order": 12,
      "canonical": "docs/migrate-express.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-express.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-express/"
    },
    {
      "slug": "migrate-laravel",
      "title": "Migrate Laravel to ZigBase",
      "description": "Re-platform a Laravel backend through route, middleware, Eloquent, policy, auth, queue, and file discovery; deterministic import; parity; and cutover rehearsal.",
      "group": "guides",
      "order": 13,
      "canonical": "docs/migrate-laravel.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-laravel.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-laravel/"
    },
    {
      "slug": "migrate-go",
      "title": "Migrate a Go service to ZigBase",
      "description": "Re-platform a Go web service through router, middleware, data, transaction, auth, worker, and wire discovery; deterministic import; parity; and cutover rehearsal.",
      "group": "guides",
      "order": 14,
      "canonical": "docs/migrate-go.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-go.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-go/"
    },
    {
      "slug": "migrate-rails-api",
      "title": "Migrate a Rails API to ZigBase",
      "description": "Re-platform a Rails API-only backend through observed route, Active Record, authorization, job, and storage discovery; deterministic import; parity; and cutover rehearsal.",
      "group": "guides",
      "order": 15,
      "canonical": "docs/migrate-rails-api.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-rails-api.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-rails-api/"
    },
    {
      "slug": "migrate-rails-fullstack",
      "title": "Migrate a complete Rails application",
      "description": "Coordinate Rails backend and Zigapagos presentation migration through versioned handoffs, a reconciled route map, backend and browser parity, and rehearsed cutover.",
      "group": "guides",
      "order": 16,
      "canonical": "docs/migrate-rails-fullstack.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/migrate-rails-fullstack.md",
      "url": "https://valthon.github.io/zigbase/docs/migrate-rails-fullstack/"
    },
    {
      "slug": "roadmap",
      "title": "Engineering backlog",
      "description": "Priorities, implemented foundations, and acceptance criteria for resource efficiency, developer leverage, and measured growth.",
      "group": "guides",
      "order": 20,
      "canonical": "BACKLOG.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/BACKLOG.md",
      "url": "https://valthon.github.io/zigbase/docs/roadmap/"
    },
    {
      "slug": "api",
      "title": "API",
      "description": "The ZigBase HTTP REST and realtime WebSocket reference — collections, records, query grammar, access rules, auth, OAuth2, files, and realtime.",
      "group": "reference",
      "order": 1,
      "canonical": "docs/api.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/api.md",
      "url": "https://valthon.github.io/zigbase/docs/api/"
    },
    {
      "slug": "fields",
      "title": "Fields",
      "description": "The complete catalog of ZigBase field types and their options — text, email, url, editor, date, autodate, bool, number, json, select, relation, and file.",
      "group": "reference",
      "order": 2,
      "canonical": "docs/fields.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/fields.md",
      "url": "https://valthon.github.io/zigbase/docs/fields/"
    },
    {
      "slug": "known-limitations",
      "title": "Known limitations",
      "description": "Current caveats in ZigBase — auth/email, framework hooks, schema migrations, fields, the scheduler, platform/UI gaps, and deferred work.",
      "group": "reference",
      "order": 3,
      "canonical": "KNOWN_LIMITATIONS.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/KNOWN_LIMITATIONS.md",
      "url": "https://valthon.github.io/zigbase/docs/known-limitations/"
    },
    {
      "slug": "changelog",
      "title": "Changelog",
      "description": "Release history for ZigBase, following Keep a Changelog and Semantic Versioning.",
      "group": "reference",
      "order": 4,
      "canonical": "CHANGELOG.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/CHANGELOG.md",
      "url": "https://valthon.github.io/zigbase/docs/changelog/"
    },
    {
      "slug": "observability",
      "title": "Observability & machine-readable output",
      "description": "Structured logging, the frozen error-code registry, JSON CLI output, and capability discovery — the contracts tools and agents build on.",
      "group": "reference",
      "order": 5,
      "canonical": "docs/observability.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/observability.md",
      "url": "https://valthon.github.io/zigbase/docs/observability/"
    },
    {
      "slug": "agent-evals",
      "title": "Agent evaluations",
      "description": "Run ZigBase's provider-neutral Genesis evaluation, understand deterministic grades, and preserve three-run release evidence without committing transcripts.",
      "group": "reference",
      "order": 6,
      "canonical": "docs/agent-evals.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/agent-evals.md",
      "url": "https://valthon.github.io/zigbase/docs/agent-evals/"
    },
    {
      "slug": "openapi",
      "title": "OpenAPI export",
      "description": "Export deterministic OpenAPI 3.1.2 JSON for live collection CRUD and framework-declared consumer routes, with honest access and redacted secret metadata.",
      "group": "reference",
      "order": 6,
      "canonical": "docs/openapi.md",
      "raw_url": "https://raw.githubusercontent.com/valthon/zigbase/main/docs/openapi.md",
      "url": "https://valthon.github.io/zigbase/docs/openapi/"
    }
  ]
}