Quick Start

Quick Start

Install the CLI:

npm install -g dbgov-cli
dbgov version
dbgov doctor config -o json

Create and select a database context:

dbgov ctx set prod --engine mysql \
  --host 127.0.0.1 --port 3306 --database app --username appuser --env prod --protected --dry-run -o json
dbgov ctx set prod --engine mysql \
  --host 127.0.0.1 --port 3306 --database app --username appuser --env prod --protected \
  --ticket <human-ticket> --allow-context-change --yes
dbgov ctx use prod --dry-run -o json
dbgov ctx use prod --ticket <human-ticket> --allow-context-change --yes
export DBGOV_PASSWORD='***'

Run safe reads and previews:

dbgov query --sql "SELECT id, name FROM users LIMIT 10" -o json
dbgov explain --sql "UPDATE users SET active = 0 WHERE last_seen < '2025-01-01'" -o json
dbgov data exec --sql "UPDATE users SET active = 0 WHERE id = 42" --dry-run -o json

Query JSON keeps SQL NULL as null and distinct from ""; table output displays it as NULL.

Apply a small governed write:

dbgov data exec --sql "UPDATE users SET active = 0 WHERE id = 42" --yes -o json
dbgov audit query --since 1h -o json

For destructive or high-impact work, use dry-run output to learn the required approval. Human operators provide --ticket, --allow-*, and high-risk --yes.