Sqlit – A lazygit-style TUI for SQL Databases

Sqlit is a lightweight, terminal user interface (TUI) tool for interacting with SQL databases, taking significant inspiration from the workflow and keyboard-driven nature of lazygit. It is designed for developers, DBAs, and power users who prefer command-line environments over graphical clients for database management.

Core Concept & Philosophy

Sqlit adopts a "lazy" workflow, providing a quick, visual overview of database components like tables, rows, and schemas with minimal keystrokes. It aims for a single-pane focus, meaning all interactions—data display, query execution, and row editing—occur within one terminal window, eliminating the need for separate editors or consoles. This approach emphasizes keyboard-driven navigation and actions, with every function mapped to a mnemonic keybinding to reduce context switching.

Key Features

• Database Navigation & Schema Exploration: Users can browse databases, schemas, tables, indexes, and views in a hierarchical, intuitive manner.
• Row Viewer / Editor: Allows selection of a table to view a paginated list of rows, with the ability to edit cell values inline.
• Query Interface & Editor: Provides a simple split-view environment to type, run, and inspect SQL statements, often with syntax highlighting.
• Result Visualization: Query results are displayed in pretty-printed tabular output, supporting pagination and copy-to-clipboard functionality.
• History & Undo: Maintains a history of executed queries and edits, offering the option to undo changes before committing them.
• Export: Supports exporting query results directly from the UI to formats like CSV, JSON, or TSV.
• Connection Management: Can connect to various relational databases, including PostgreSQL, MySQL, SQLite, and MariaDB, typically via DSN strings or configuration files.
• Keyboard Shortcuts: Features numerous mnemonic keybindings (e.g., s for schema, t for tables, e to edit, r to run query, q to quit) for efficient, keyboard-centric operation.
• Underlying Technology: Built using reactive TUI frameworks like tui-rs (Rust) for high-performance rendering.

Use Cases

Sqlit is particularly useful for:

• Rapid prototyping: Quickly inspecting tables and testing SQL queries without switching to a different client.
• Ad-hoc debugging: Directly identifying data anomalies or testing fixes within the terminal.
• Learning SQL: Providing visual feedback that aids beginners in understanding table relationships and query results.
• Remote/Headless environments: Ideal for working on servers or within Docker containers where a graphical user interface is unavailable.

Quick Start Example

To get started, you would typically install it via a package manager (e.g., cargo install sqlit if built with Rust). Then, connect to a database using a DSN string:

bash sqlit "postgres://user:pass@localhost:5432/mydb"

Once inside Sqlit, common keybindings include:

• s to view schemas
• t to list tables
• Enter on a table to view rows
• e on a row to edit a cell
• r to run a query from the editor pane

Comparison to Other Tools & Limitations

While Sqlit shares characteristics with other TUI/CLI SQL tools like pgcli/mycli (which focus more on command-line query prompts) or usql (a universal SQL CLI with TUI elements), its distinct "lazygit-style" interactive interface differentiates it. Full-featured GUI IDEs like DataGrip or DBeaver offer broader capabilities but lack the lightweight, terminal-native experience of Sqlit.

It's important to note some limitations:

• Database Type: Primarily limited to relational databases, lacking support for NoSQL stores.
• Editing Workflow: Editing is often optimistic; changes are staged and typically require manual commitment (e.g., via UPDATE statements).
• Performance: For very large tables, pagination might experience lag; filtering queries initially is recommended.

Overall, Sqlit aims to provide an efficient, keyboard-driven alternative for database interaction, bridging the gap between basic command-line clients and heavy GUI applications.