Updated
On this page
Reference for the pgdesign fmt command — usage, flags, arguments, and examples for the fmt subcommand of the pgdesign CLI.
#pgdesign fmt
Format a pgdesign TOML schema file or directory in place
Effect: mutating
#Flags
| Name | Short | Type | Default | Env | Description |
|---|---|---|---|---|---|
--check | bool | Check if file is already formatted (exit 1 if not) | |||
--table-order | str | dependency | Table ordering strategy: dependency-based or alphabetical | ||
--column-order | str | pk_fk_alpha | Column ordering: pk_fk_alpha, alphabetical, fk_last, or preserve |
#Arguments
| Name | Required | Description |
|---|---|---|
path | yes | Path to the TOML schema file or directory to format |