CLI Reference

CLI Reference

propq [flags]
propq [command]

Main flags

SQL source (pick one)

Flag	Description
--sql QUERY	Inline SQL
-f, --file FILE	Read SQL from file (- for stdin)
-e, --edit	Open $EDITOR to write SQL

Priority: --sql → -f → -e → stdin pipe (echo 'SELECT 1' | propq).

Filtering

Flag	Description
-s, --server REGEX	Server name regex filter
-d, --dbfilter REGEX	Database name regex filter (include)
-D, --exclude-db REGEX	Database name regex filter (exclude)
-t, --tags TAGS	Filter by tags (comma-separated, OR)
-S, --select	Open editor to pick databases interactively

Note: -d or -D automatically enables -a (per-database) mode.

Execution

Flag	Description
--timeout SEC	Query timeout (default: 30)
--concurrency N	Global concurrency limit (default: per-server max_connections)
--retry N	Retry failed databases N times with exponential backoff
--force	Skip confirmation for destructive SQL
--dry-run	Show target databases without executing
-a, --all	Per-DB mode (default: once per server)
--no-transaction	Run in autocommit mode (no transaction)
--ask-for-commit	Show summary, ask before committing
--no-confirm	Skip confirmation prompt when no filter is set

Output

Flag	Description
--json	Output as JSON (default: table)
--csv	Output as CSV
-o, --output FILE	Save output to file (in addition to stdout)
--stream	Print results live as they complete
--history	Show recent queries
-N, --no-output	Suppress results, show only summary
--no-error	Hide error entries from output
--no-result	Hide data rows, show only ✓/✗ per target
--pager	Force pager output (less) even when stdout is piped
--no-pager	Disable auto-pager (default: auto when stdout is a TTY)
-q, --quiet	Suppress spinner and banners

Config & meta

Flag	Description
-c, --config FILE	Path to config file
--version	Show version
-h, --help	Show help

Subcommands

Command	Description
propq servers	List configured servers and their live DB counts
propq servers -s REGEX	Filter by server name
propq servers --json	JSON output
propq servers -t TAGS	Filter by tags
propq config check	Validate config + test all server connections (exit 0/1)
propq config validate	Validate config file syntax/structure only
propq config generate	Generate a default config file
propq completion SHELL	Generate completion (bash/zsh/fish/powershell)
propq skill install	Install/update the AI agent skill
propq skill show	Print the embedded skill content

propq servers

propq servers [flags]
  -c, --config string   Path to config file
      --json            JSON output
  -q, --quiet           Suppress banner
  -s, --server string   Regex filter for server names
  -t, --tags string     Filter by tags (comma-separated)
      --timeout int     Connection timeout in seconds (default 10)

propq config check

Validates the config and tests connectivity to all configured servers. Exits 0 if all servers are reachable, 1 otherwise — useful in CI.

propq skill install

Copies the embedded skill definition to ~/.hermes/skills/software-development/propq/SKILL.md so AI assistants (Hermes, Claude Code, etc.) can discover and use propq. Use --update (-u) to regenerate the embedded skill from the source SKILL.md first. See AI-Agents.

Next: Output-Formats · Safety