How diogoaalmeida/dbcli works
dbcli is a read-only SQL CLI for AI agents. The main workflow dispatches a command, resolves a connection, runs the requested query or database-introspection operation through the driver, then emits a stable JSON or table result. Database discovery proceeds from schemas to tables to table details; query, explain, and sample are separate operations. README capabilities are retained, though the command implementations for schema listings and profile storage were not excerpted.
Main entry points: common.go Connect and route · main.go Command dispatch · json.go JSON and table output · schema.go Schema and table metadata
Components 18
CLI commands
- Command dispatch
main.go - Query
cmd/query.go - Explain
cmd/explain.go - List schemas
cmd/schemas.go - List tables
cmd/schema.go - Describe table
cmd/describe.go - Sample rows
cmd/sample.go - Manage profiles
cmd/profiles.go
Connection setup
- Connect and route
cmd/common.go - Profile configuration
internal/config/config.go - Driver interface
internal/driver/driver.go
Postgres operations
- Postgres connection
internal/postgres/driver.go - Query execution
internal/postgres/exec.go - Read-only safeguards
internal/postgres/dbsafety.go - Schema and table metadata
internal/postgres/schema.go
Result formatting
- JSON and table output
internal/output/json.go
Other components
- AI agent or user
- Postgres database
Connections 35
- AI agent or user → Command dispatch: invokes
main.go - Command dispatch → Query: dispatches
main.go - Command dispatch → Explain: dispatches
main.go - Command dispatch → List schemas: dispatches
main.go - Command dispatch → List tables: dispatches
main.go - Command dispatch → Describe table: dispatches
main.go - Command dispatch → Sample rows: dispatches
main.go - Command dispatch → Manage profiles: dispatches
main.go - Query → Connect and route: connects via
cmd/common.go - Explain → Connect and route: connects via
cmd/common.go - List schemas → Connect and route: connects via
cmd/common.go - List tables → Connect and route: connects via
cmd/common.go - Describe table → Connect and route: connects via
cmd/common.go - Sample rows → Connect and route: connects via
cmd/common.go - Connect and route → Profile configuration: resolves DSN
cmd/common.go - Manage profiles → Profile configuration: manages profiles
cmd/profiles.go - Connect and route → Driver interface: looks up driver
cmd/common.go - Connect and route → Postgres connection: registers driver
cmd/common.go - Postgres connection → Driver interface: implements
internal/postgres/driver.go - Postgres connection → Postgres database: connects
internal/postgres/driver.go - Query → Query execution: calls Query
cmd/query.go - Explain → Query execution: calls Explain
cmd/explain.go - List schemas → Schema and table metadata: lists schemas
README.md - List tables → Schema and table metadata: lists tables
README.md - Describe table → Schema and table metadata: describes table
cmd/describe.go - Sample rows → Schema and table metadata: samples table
README.md - Query execution → Read-only safeguards: validates query
internal/postgres/exec.go - Query execution → Postgres database: queries in read-only tx
internal/postgres/exec.go - Schema and table metadata → Postgres database: reads metadata
internal/postgres/schema.go - Query → JSON and table output: writes result
cmd/query.go - Explain → JSON and table output: writes result
cmd/explain.go - Sample rows → JSON and table output: writes result
cmd/sample.go - Describe table → JSON and table output: writes data
cmd/describe.go - List schemas → JSON and table output: writes data
README.md - List tables → JSON and table output: writes data
README.md