Skip to main content
Use onboard to assess a repo’s migration tooling and Postgres safety in one pass. onboard detects the incumbent migration system from marker files, scores the declarative schema, and reports a readiness verdict. It does not connect to a database.

Use this when

  • Adopting supaschema in a repo with existing migration tooling.
  • A quick “are we ready?” check with an ordered remediation list.

Run it

npx supaschema onboard
npx supaschema onboard --from dir:database/schemas
Detection runs against the current working directory; --from selects the schema source to score. Output is credential-redacted.

Flags

--from
source
Schema source to score. Defaults to the declarative tree (config.sources.to).

What it reports

  • the detected migration system(s), and whether the workflow is mixed;
  • the Postgres safety score and grade;
  • a READY / needs work verdict;
  • when not ready, an ordered Remediate in order list (errors before warnings).

Exit codes

CodeMeaning
0Readiness report printed.
Last modified on June 18, 2026