Skip to content

Quick Start

Get up and running with query-cli in under a minute.

Launch

bash
query-cli

On first launch, you'll land on the connection selection screen.

query-cli — Connection Select
query-cli
Select a connection
↑/↓navigate·enterconfirm·ctrl+cquit
Production DB
postgres://admin@db.example.com:5432/app
Local Dev
postgres://postgres@localhost:5432/myapp
+ New connection
Create a new database connection
Quit
Exit query-cli

Add a Connection

  1. Select + New connection
  2. Choose your database driver (PostgreSQL, MySQL, or SQLite)
  3. Fill in the connection details
  4. Press Enter to connect
query-cli — Connection Form
New PostgreSQL connection
Name:My postgres db
Host:localhost
Port:5432
Database:postgres
User:postgres
Password:
tabmove·enternext / connect·escback

Start Querying

Once connected, the main interface appears:

  • Left panel: Schema explorer — browse tables, columns, and indexes
  • Top right: Query editor — write SQL with syntax highlighting
  • Bottom right: Result panel — view query output
query-cli — Main Screen
query-cli·docme(postgres)
▶ Run (F5/Ctrl+R)·Ctrl+Ssave·(F9/Ctrl+P)commands·ctrl+cquit
Explorer
DatabaseQueries
drizzle.__drizzle_migrations
pgboss.bam
pgboss.job
pgboss.job_common
pgboss.queue
pgboss.schedule
pgboss.subscription
New query
SELECT * FROM users WHERE active = true
FROM
WHERE
Result
No results yet.F5 / ctrl+r runs the statement.

Run a Query

  1. Type your SQL in the editor
  2. Press F5 or Ctrl+R to run
  3. Results appear in the bottom panel

Use Slash Commands

Type / in the editor to see available commands:

  • /run — Execute the current query
  • /save-query — Save the current query
  • /new-query — Start a new query
  • /ai-config — Configure AI assistant
  • /help — Show keyboard shortcuts
query-cli — Command Palette
Commands
Search by name or description...
↑/↓navigate·enterrun·escclose
Execute the current query
/run
Open the command palette
/commands
Show keyboard shortcuts
/help
Pick an AI adapter and model
/ai-config
Insert @ai: at the cursor
/ask-ai

Next Steps

Released under the MIT License.