Commands
| Command | Purpose | Writes? |
|---|---|---|
pgdba check |
Run read-only health checks; print ranked findings; write pgdba-report.md/.json |
reports only (with --state-dir) |
pgdba check --apply |
Execute remediation SQL you approve, per action | yes, gated |
pgdba migrate |
Server-to-server migration: preflight → confirm → copy → verify | yes, gated |
pgdba migrate --plan-only |
Dry-run: preflight + planning, zero target writes | no (report only) |
pgdba why <finding-id> |
Plain-language explainer for one finding from the last report | no |
pgdba verify-restore |
Verify a backup repository; --restore rehearses into scratch scratch |
scratch only, fenced |
pgdba config |
Print personalized config proposals from live signals | no |
pgdba config init |
Probe a connection and write a starter pgdba-run.toml |
writes the config file |
pgdba config doctor |
Validate the config and probe every profile | no |
pgdba check --explain-term <term> |
Print a glossary entry and exit | no |
pgdba check --explain-flag <name> |
Print a flag/config-key entry (with its safe default) and exit | no |
Flag lookup from the terminal
pgdba check --explain-flag pooled # what/when/safe default
pgdba check --explain-term "duty group" # report vocabulary
Misspellings suggest the closest match (--explain-flag state-dir →
did you mean: state_dir?) and exit 3 without printing a wrong entry.
Full option listings live in pgdba <command> --help; the
flags & config keys reference documents
the high-traffic set with safe defaults.