# supaschema

> From declarative PostgreSQL schema to replay-safe migrations, generated types, Zod validators, and guarded sync in seconds. No ORM schema layer, no Docker, no shadow database.

## Docs

- [Benchmarks](https://supaschema.com/docs/benchmarks.md): Latency, accuracy, and replay-safety results for supaschema compared with Supabase CLI diff engines.
- [Case study](https://supaschema.com/docs/case-study-anilize.md): supaschema measured against a production multi-tenant Supabase platform: ~30 schemas, ~8,300 objects, hundreds of RLS policies.
- [Coding agents](https://supaschema.com/docs/coding-agents.md): How AI coding agents should install, configure, and use supaschema without cloning the source repository.
- [Agent Bundle](https://supaschema.com/docs/coding-agents/agent-bundle.md): What the optional raw supaschema agent bundle provides for Claude, Codex, and AGENTS-compatible tools.
- [Commands](https://supaschema.com/docs/commands.md): Choose the supaschema CLI command for migration generation, validation, verification, inspection, configuration, and diagnostics.
- [audit](https://supaschema.com/docs/commands/audit.md): Report support-matrix coverage for one schema source.
- [check](https://supaschema.com/docs/commands/check.md): Statically validate migration SQL for replay safety, lock hazards, parser issues, and blocked patterns.
- [completion](https://supaschema.com/docs/commands/completion.md): Print a shell completion script for supaschema commands.
- [config validate](https://supaschema.com/docs/commands/config-validate.md): Validate supaschema config paths, sources, and credential references.
- [contracts](https://supaschema.com/docs/commands/contracts.md): Export, diff, push, and pull JSON schema contracts for cross-repository drift checks.
- [corpus](https://supaschema.com/docs/commands/corpus.md): Run the dirty-real regression oracle against a disposable PostgreSQL database.
- [diff](https://supaschema.com/docs/commands/diff.md): Compare two schema sources and emit a replay-safe SQL migration.
- [doctor](https://supaschema.com/docs/commands/doctor.md): Diagnose local setup, config, parser loading, database reachability, and migrations history.
- [explain](https://supaschema.com/docs/commands/explain.md): Look up a supaschema diagnostic code offline.
- [fingerprint](https://supaschema.com/docs/commands/fingerprint.md): Print the canonical model equality hash for one schema source.
- [init](https://supaschema.com/docs/commands/init.md): Scaffold or repair supaschema config and optionally install the reviewed agent bundle.
- [inspect](https://supaschema.com/docs/commands/inspect.md): Extract and print the deterministic schema model for one source.
- [migrations](https://supaschema.com/docs/commands/migrations.md): Compare SQL files on disk against a database's applied migration history.
- [onboard](https://supaschema.com/docs/commands/onboard.md): Detect the current migration system and report onboarding readiness with a safety score and ordered fixes.
- [plan](https://supaschema.com/docs/commands/plan.md): Print the object-level schema diff plan as JSON without rendering SQL.
- [scan](https://supaschema.com/docs/commands/scan.md): Score a declarative schema for Postgres safety with the rule packs and report findings.
- [selfcheck](https://supaschema.com/docs/commands/selfcheck.md): Compare live-catalog extraction against the database engine representation.
- [sync](https://supaschema.com/docs/commands/sync.md): Gate pending migrations, reconcile configured targets, and apply through the selected runner.
- [type-contract](https://supaschema.com/docs/commands/type-contract.md): Gate breaking changes in the generated TypeScript/Zod type contract between two schema sources.
- [types](https://supaschema.com/docs/commands/types.md): Generate TypeScript interfaces and Zod validators directly from PostgreSQL schema files.
- [verify](https://supaschema.com/docs/commands/verify.md): Apply a migration twice in throwaway databases and compare catalog fingerprints against the declared target.
- [Atlas migrate lint is now paid: free Postgres alternatives](https://supaschema.com/docs/comparisons/atlas-migrate-lint-paid-alternatives.md): Atlas made `atlas migrate lint` an Atlas Pro feature in v0.38 (October 2025). Here are free, Postgres-native migration-safety alternatives, including supaschema's free diff/check and scan.
- [Atlas comparison](https://supaschema.com/docs/comparisons/supaschema-vs-atlas.md): Compare supaschema with Atlas for Postgres migration generation and safety. Atlas migrate lint moved to the paid Atlas Pro tier in v0.38; supaschema keeps declarative diff and replay/lock-safety checks in the free core.
- [Drizzle comparison](https://supaschema.com/docs/comparisons/supaschema-vs-drizzle.md): Compare supaschema with Drizzle ORM and drizzle-kit for PostgreSQL: declarative SQL versus a TypeScript schema, migration generation, replay and lock safety, RLS policies, and where each tool fits.
- [Flyway comparison](https://supaschema.com/docs/comparisons/supaschema-vs-flyway.md): Compare supaschema with Redgate Flyway for PostgreSQL. Flyway is a multi-database migration runner that applies versioned SQL; its auto-generation is a paid Enterprise feature. supaschema generates, checks, and can sync migrations from declarative SQL for free.
- [Liquibase comparison](https://supaschema.com/docs/comparisons/supaschema-vs-liquibase.md): Compare supaschema with Liquibase for PostgreSQL. Liquibase is a multi-database, changelog-driven migration runner whose diff compares two databases. supaschema generates, checks, and can sync migrations from declarative SQL with no database needed for generation.
- [pgfence comparison](https://supaschema.com/docs/comparisons/supaschema-vs-pgfence.md): Compare supaschema with pgfence for PostgreSQL migration safety. Both use libpg_query AST analysis; pgfence scores existing migrations and ORM migration files, while supaschema generates migrations from declarative SQL and checks them.
- [Prisma comparison](https://supaschema.com/docs/comparisons/supaschema-vs-prisma.md): Compare supaschema with Prisma ORM and Prisma Migrate for PostgreSQL: declarative SQL versus the Prisma schema DSL, shadow-database-free migration generation, replay and lock safety, RLS, and where each tool fits.
- [Squawk comparison](https://supaschema.com/docs/comparisons/supaschema-vs-squawk.md): Compare supaschema with Squawk for PostgreSQL migration safety. Squawk lints migration SQL you already wrote; supaschema generates the migration from declarative SQL and then checks it.
- [Supabase CLI comparison](https://supaschema.com/docs/comparisons/supaschema-vs-supabase-cli.md): Compare supaschema with Supabase CLI db diff for declarative schemas, Docker-free migration generation, RLS policy changes, replay safety, and types.
- [Declarative schema](https://supaschema.com/docs/concepts/declarative-schema.md): Learn how supaschema's declarative approach keeps your PostgreSQL schema in SQL files and auto-generates safe, idempotent migrations on every change.
- [Migration pipeline](https://supaschema.com/docs/concepts/migration-pipeline.md): How supaschema turns one diff command into a deterministic, replay-safe PostgreSQL migration.
- [ORM-free applications](https://supaschema.com/docs/concepts/orm-free-applications.md): A directive for using supaschema-generated PostgreSQL types, Zod validators, migrations, sync, and safety gates without making an ORM the schema owner.
- [Sources](https://supaschema.com/docs/concepts/sources.md): supaschema reads schemas from SQL files on disk, Git refs, a live database, SQL dump files, or saved catalog snapshots. No Docker or shadow database required.
- [Configuration](https://supaschema.com/docs/configuration/config-file.md): Configuration options, defaults, environments, validators, and examples for supaschema.
- [Environments](https://supaschema.com/docs/configuration/environments.md): How supaschema resolves PostgreSQL database URLs through named environments, $ENV indirection, SUPASCHEMA_DATABASE_URL, and provider-specific fallbacks.
- [Hints](https://supaschema.com/docs/configuration/hints.md): How to approve reviewed destructive changes and renames without weakening fail-closed planning.
- [FAQ](https://supaschema.com/docs/faq.md): Direct answers about supaschema, declarative PostgreSQL migrations, provider support, replay safety, RLS policies, and type generation.
- [CI gate](https://supaschema.com/docs/guides/ci-gate.md): Use supaschema as a drift, replay-safety, and policy-isolation gate before schema changes merge.
- [CI recipe](https://supaschema.com/docs/guides/ci-github-actions.md): GitHub Actions examples for drift checks, replay-safety checks, and apply-twice verification.
- [Corpus oracle](https://supaschema.com/docs/guides/corpus-oracle.md): Run dirty-real catalog regression tests for cross-lane schema diff correctness.
- [Declarative management](https://supaschema.com/docs/guides/declarative-postgres-schema-management.md): Manage PostgreSQL schemas from versioned SQL files with deterministic diffs, replay-safe migrations, explicit destructive hints, and CI drift checks.
- [Type generation](https://supaschema.com/docs/guides/generate-supabase-types-without-database.md): Generate PostgreSQL TypeScript types and Zod validators from declarative SQL files before applying a migration.
- [Idempotent migrations](https://supaschema.com/docs/guides/idempotent-postgres-migrations.md): Generate and check replay-safe PostgreSQL migrations that can run more than once without failing on existing objects.
- [RLS policy safety](https://supaschema.com/docs/guides/rls-policy-migration-safety.md): Detect PostgreSQL Row Level Security policy changes by comparing policy expressions, not just policy names.
- [Docker-free diff](https://supaschema.com/docs/guides/supabase-db-diff-without-docker.md): Generate Supabase-compatible PostgreSQL migrations from declarative SQL files without Docker, a local Supabase stack, or a shadow database.
- [Supabase integration](https://supaschema.com/docs/guides/supabase-integration.md): Use supaschema with Supabase paths, managed schemas, guarded sync targets, and the optional Supabase CLI runner adapter.
- [Installation](https://supaschema.com/docs/installation.md): Install supaschema in a PostgreSQL project and give coding agents the correct setup prompt.
- [Introduction](https://supaschema.com/docs/introduction.md): supaschema turns legacy declarative schema drift into an automated, replay-safe PostgreSQL schema management loop for any provider.
- [Quickstart](https://supaschema.com/docs/quickstart.md): Install supaschema, write a declarative schema file, generate a replay-safe PostgreSQL migration from configured sources, and validate it.
- [Brand assets](https://supaschema.com/docs/reference/branding.md): Where supaschema logo and brand images live, and how to use them across Mintlify, GitHub, README, and generated visuals.
- [Diagnostics](https://supaschema.com/docs/reference/diagnostics.md): SUPA diagnostic codes, severities, meanings, and recovery entry points.
- [Library API](https://supaschema.com/docs/reference/library-api.md): Every CLI capability as an exported, typed function — the supaschema Node.js library surface.
- [Package Boundary](https://supaschema.com/docs/reference/package-boundary.md): How supaschema decides what belongs in the npm package, consumer setup, and maintainer workspace.
- [Privacy and data handling](https://supaschema.com/docs/reference/privacy.md): What supaschema stores, sends, and avoids collecting across the CLI, GitHub Action, support intake, and hosted commercial surfaces.
- [Commercial support](https://supaschema.com/docs/reference/support.md): Commercial license and support intake for proprietary, hosted, and supported supaschema use.
- [Support matrix](https://supaschema.com/docs/reference/support-matrix.md): The PostgreSQL object types supaschema extracts, renders, checks, and intentionally blocks.
- [Setup](https://supaschema.com/docs/setup.md): Review install-time setup, verify the environment, and find detailed configuration options.
- [What's included](https://supaschema.com/docs/whats-included.md): The features included with supaschema out of the box: migration generation, safety checks, types, CI gates, corpus testing, and agent context.