Skip to main content
Use inspect when you need to see what supaschema read from a source. The output is the extracted schema model as JSON, including diagnostics for unsupported or unparseable input.

​
Use this when

  • A diff result is surprising.
  • You need to confirm source resolution.
  • Unsupported DDL should be visible before planning.
  • Tooling needs the model JSON directly.

​
Run it

npx supaschema inspect
npx supaschema inspect --from dir:database/schemas
npx supaschema inspect --from "database:$DATABASE_URL"
npx supaschema inspect --from git:HEAD~1 --schema public,auth

​
Flags

​
--from
source
Source to inspect. Defaults to the configured schema tree.
​
--schema
names
Include only the comma-separated PostgreSQL schema names.

​
Exit codes

CodeMeaning
0Model printed
1Runtime failure
2Extraction diagnostics contained an error

Plan

Compare two extracted models.

Fingerprint

Print the model equality hash.

Audit

Summarize supported and unsupported coverage.

Support matrix

Check modeled PostgreSQL object support.
Last modified on June 16, 2026