> ## 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.
# plan
> Print the object-level schema diff plan as JSON without rendering SQL.
Use `plan` when you need to inspect schema operations before SQL is rendered.
`plan` runs the same comparison and migration-corpus extraction as `diff`, prints the `MigrationPlan` JSON, and leaves the filesystem untouched.
## Use this when
* Review automation needs operation data.
* A migration looks surprising and you want the planner view.
* You want destructive or blocked operations before rendering SQL.
* Downstream tooling should summarize schema impact.
* You need to confirm whether existing migrations supplied the source intent for backfills, Vault references, or workload-derived indexes.
## Run it
```bash theme={null}
npx supaschema plan
npx supaschema plan --from "git:origin/main" --to dir:database/schemas
npx supaschema plan --schema public,auth
npx supaschema plan | jq '.operations'
```
## Flags
Before-state source. Defaults to `config.sources.from`. A `migrations:` value
must match the configured migrations directory.
Desired-state source. Defaults to `dir:`. Migration
replay is not supported here.
Plan only the comma-separated PostgreSQL schema names.
Print extract and plan timings to stderr.
## Exit codes
| Code | Meaning |
| ---- | ----------------------------------- |
| `0` | Plan printed |
| `1` | Runtime failure |
| `2` | Plan diagnostics contained an error |
## Related
Render the plan as replay-safe SQL.
See the extracted model behind a source.
Pick source specifiers for `--from` and `--to`.
Approve blocked destructive changes.