Commands

July 20, 2026 ยท View on GitHub

Connection Management

CommandDescriptionExample
init <name> <type> <conn-string> [schema]Create new database connectionsquix create mydb postgres "postgresql://..."
use/switch <name>Switch to a different connectionsquix use production
statusShow current active connectionsquix status
list connectionsList all configured connectionssquix list connections

Query Operations

CommandDescriptionExample
add <name> [sql]Add a new saved querysquix add users "SELECT * FROM users"
remove <name|id>Remove a saved querysquix remove users or squix remove 3
list queriesList all saved queriessquix list queries
list queries --onelinelists each query in one linesquix list -o
list queries <searchterm>lists queries containing search termsquix list employees
run <name|id|sql>Execute a querysquix run users or squix run 2
runCreate and run a new querysquix run
run --editEdit query before runningsquix run users --edit
run --last, -lRe-run last executed querysquix run --last
run --paramrun with named paramssquix run --name Squix
shellInteractive query REPL (alias: repl)squix shell

Database Exploration

CommandDescriptionExample
exploreList all tables and views in multi-column formatsquix explore
explore <table> [-l N]Query a table with optional row limitsquix explore employees --limit 100
explore <file.csv>View a local CSV file in the results view (read-only)squix explore sales.csv
explain <table> [-d N] [-c]Visualize foreign key relationshipssquix explain employees --depth 2
tablesList all tables in using the results view, access with Entersquix tables
example [path] [--force]Create a sample office-themed SQLite database to try squixsquix example

Configuration

CommandDescriptionExample
configEdit main configuration filesquix config
editEdit all queries for current connectionsquix edit
edit <name|id>Edit a single named querysquix edit 3
remove --connection <name>Remove a db connection`squix remove --conection dev4``
help [command]Show help informationsquix help run