> ## Documentation Index
> Fetch the complete documentation index at: https://supaschema.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# What's included

> The features included with supaschema out of the box: migration generation, safety checks, types, CI gates, corpus testing, and agent context.

Use this page to see the package surfaces at a glance.

supaschema is packaged as a PostgreSQL project workflow, not just a binary. Installing it gives your repo the generator, safety checks, generated outputs, staging/apply commands, and a public-safe agent enforcement bundle installed by `supaschema init`. The workflow keeps declarative schema changes repeatable across plain PostgreSQL, Neon, RDS/Aurora, Cloud SQL, AlloyDB, Azure PostgreSQL, and Supabase.

## Core workflow

<CardGroup cols={2}>
  <Card title="Migration generation" icon="wand-magic-sparkles" href="/docs/concepts/migration-pipeline">
    `supaschema diff` extracts, plans, renders, and writes the migration.
  </Card>

  <Card title="Replay-safety checker" icon="shield-check" href="/docs/commands/check">
    `supaschema check` validates generated migrations before they reach a
    database.
  </Card>

  <Card title="Apply-twice verification" icon="repeat-2" href="/docs/commands/verify">
    `supaschema verify` proves the newest pending migration is replay-safe
    against a disposable database.
  </Card>

  <Card title="Guarded apply" icon="cloud-upload" href="/docs/commands/apply">
    `supaschema apply` reconciles target history and applies pending migrations
    after replay, type, and RLS gates pass.
  </Card>
</CardGroup>

## Generated outputs

<CardGroup cols={2}>
  <Card title="TypeScript types" icon="file-code-2" href="/docs/guides/generate-supabase-types-without-database">
    Types are generated from the declarative schema tree, not a live database
    snapshot.
  </Card>

  <Card title="Zod validators" icon="braces" href="/docs/concepts/orm-free-applications">
    Runtime validators turn generated database types into an application
    boundary without an ORM schema layer.
  </Card>

  <Card title="Actionable diagnostics" icon="circle-alert" href="/docs/reference/diagnostics">
    `SUPA_*` diagnostics explain blocked or ambiguous schema changes and point
    to recovery steps.
  </Card>

  <Card title="Destructive hints" icon="triangle-alert" href="/docs/configuration/hints">
    Drops and incompatible changes require explicit object-level intent before
    SQL is generated.
  </Card>
</CardGroup>

## Project surfaces

<CardGroup cols={3}>
  <Card title="Coding-agent bundle" icon="bot" href="/docs/coding-agents/agent-bundle">
    Public-safe prompt, rule, skill, settings, and hooks installed by default
    for AI-agent enforcement in the consuming repo.
  </Card>

  <Card title="GitHub Actions" icon="github" href="/docs/guides/ci-github-actions">
    A ready CI lane for drift, safety, package, docs, corpus, and benchmark
    checks.
  </Card>

  <Card title="CI drift gate" icon="git-branch" href="/docs/guides/ci-gate">
    Fails pull requests when the declarative tree and generated migrations are
    out of sync.
  </Card>
</CardGroup>

<CardGroup cols={3}>
  <Card title="Schema safety scan" icon="shield-alert" href="/docs/commands/scan">
    Scores RLS, grant, hygiene, and generated-contract usage findings without
    connecting to a database.
  </Card>

  <Card title="Type-contract gate" icon="file-warning" href="/docs/commands/type-contract">
    Reports breaking generated TypeScript/Zod contract changes and can enforce
    them as a failing command.
  </Card>

  <Card title="Schema contracts" icon="archive" href="/docs/commands/contracts">
    Exports and diffs JSON contracts locally for cross-repository drift checks.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Corpus oracle" icon="database-zap" href="/docs/guides/corpus-oracle">
    Exercises real-world catalogs to prove reconvergence outside toy fixtures.
  </Card>

  <Card title="Provider-aware setup" icon="server-cog" href="/docs/setup#path-selection">
    Detects common PostgreSQL provider layouts while keeping `adapter: "auto"`
    provider-neutral.
  </Card>
</CardGroup>

## Evidence

<CardGroup cols={2}>
  <Card title="Benchmarks" icon="gauge" href="/docs/benchmarks">
    Large-schema benchmark results for diff performance, correctness, and
    workflow cost.
  </Card>

  <Card title="Case study" icon="chart-no-axes-combined" href="/docs/case-study-anilize">
    A production Supabase project used to validate the migration workflow at
    real project scale.
  </Card>

  <Card title="Support matrix" icon="table-properties" href="/docs/reference/support-matrix">
    Supported PostgreSQL object classes, failure modes, and current boundaries.
  </Card>

  <Card title="Package boundary" icon="package" href="/docs/reference/package-boundary">
    The exact public npm package contract and why internal maintainer tooling
    stays out.
  </Card>
</CardGroup>