Updated
On this page
Reference for the pgdesign diff command — usage, flags, arguments, and examples for the diff subcommand of the pgdesign CLI.
#pgdesign diff
Compare schema file(s) or directory against another target
Effect: read_only
#Flags
| Name | Short | Type | Default | Env | Description |
|---|---|---|---|---|---|
--json | bool | Output the schema diff in machine-readable JSON format | |||
--live | str | PGDESIGN_DB | PostgreSQL connection URL for live database comparison | ||
--against | str | Path to TOML schema file or directory to compare against | |||
--base | str | Git ref to compare the current schema against (e.g., main) |
#Arguments
| Name | Required | Description |
|---|---|---|
path | yes | Path to TOML schema file(s) or directory containing them |