Skip to main content
Use doctor when setup behaves unexpectedly or before adding supaschema to CI. The command checks the local environment and prints pass/fail results with remediation hints.

​
Use this when

  • The config file was edited.
  • Database URL resolution is unclear.
  • A local or CI database should be checked for reachability.
  • verify, migrations, or sync cannot find the expected target.

​
Run it

npx supaschema doctor
npx supaschema doctor --database-url "$DATABASE_URL"
npx supaschema doctor --json

​
Flags

​
--database-url
url
Database URL to probe. Defaults to normal database URL resolution.
​
--json
boolean
Print the doctor report as JSON.

​
What it checks

  • Node.js version and parser loading;
  • config presence and validation;
  • pending install path confirmation;
  • database URL resolution;
  • reachability, authentication, and CREATEDB;
  • migration history table access;
  • declarative schema tree presence.

Config validate

Check config relationships directly.

Setup

Confirm install-time paths and generated output.

Environments

Configure named database URL resolution.

Verify

Use a checked database for apply-twice proof.
Last modified on June 17, 2026