Skip to main content

Global Options

These options are available to all PostKit commands.

Options

OptionDescription
-v, --verboseEnable verbose/debug output
--dry-runShow what would be done without making changes
--jsonOutput results as JSON (for scripting/CI)
-V, --versionOutput version number
-h, --helpDisplay help for command

Examples

# Verbose output
postkit db start --verbose

# Dry run
postkit db deploy --dry-run

# JSON output
postkit db remote list --json

# Get version
postkit --version

# Get help
postkit --help
postkit db --help
postkit db deploy --help

JSON Output Format

When using --json, commands output machine-readable JSON instead of formatted text. This is useful for:

  • CI/CD pipelines
  • Scripting
  • Parsing results programmatically

Example:

$ postkit db remote list --json
{
"remotes": [
{
"name": "dev",
"url": "postgres://user:pass@host:5432/db",
"default": true
},
{
"name": "staging",
"url": "postgres://user:pass@host:5432/db",
"default": false
}
]
}