tui-syntax

Tree-sitter based syntax highlighting for TUI applications.

This crate provides syntax highlighting that integrates with ratatui, returning styled Line and Span types ready for rendering.

Features

• Tree-sitter based highlighting (accurate, fast)
• Helix-compatible TOML theme format
• Built-in themes (One Dark, GitHub Light)
• SQL language support built-in
• Extensible to other languages via tree-sitter grammars

Example

use tui_syntax::{Highlighter, themes, sql};

// Create highlighter with default dark theme
let mut highlighter = Highlighter::new(themes::one_dark());

// Register SQL language
highlighter.register_language(sql()).unwrap();

// Highlight some SQL
let lines = highlighter.highlight("sql", "SELECT * FROM users WHERE id = 1;").unwrap();

// `lines` is Vec<ratatui::text::Line> ready to render

tsql

A modern, keyboard-first PostgreSQL CLI with a TUI interface.

If you like this crate show some support by following fcoury (me) on X

Join us on Discord

Features

• Full-screen TUI - Split-pane interface with query editor and results grid
• Vim-style keybindings - Navigate and edit with familiar modal commands
• Syntax highlighting - SQL and JSON highlighting powered by tree-sitter
• Smart completion - Schema-aware autocomplete for tables, columns, and keywords
• Results grid - Scrollable, searchable data grid with column resizing
• Inline editing - Edit cells directly in the grid with automatic SQL generation
• JSON support - Detect, format, and edit JSON/JSONB columns with syntax highlighting
• psql compatibility - Familiar commands like \dt, \d, \dn, \l, and more
• Query history - Persistent history with fuzzy search
• Configurable - Customize keybindings and appearance via config file

Installation

Homebrew (macOS/Linux)

brew tap fcoury/tap
brew install tsql

Cargo (from source)

cargo install tsql

Binary Download

Download pre-built binaries from the GitHub Releases page.

Quick Start

# Connect with a connection URL
tsql postgres://user:password@localhost:5432/mydb

# Or set DATABASE_URL environment variable
export DATABASE_URL=postgres://user:password@localhost:5432/mydb
tsql

# Or configure a default connection in ~/.config/tsql/config.toml
tsql

Once connected:

1. Type a SQL query in the editor pane
2. Press Enter to execute
3. Use Tab to switch between editor and results grid
4. Press ? for help with all keybindings

Keybindings

Global

Query Editor (Normal Mode)

Results Grid

Troubleshooting keybindings

If a key combo isn't working in your terminal, you can inspect what tsql is actually receiving:

tsql --debug-keys

To also print mouse events:

tsql --debug-keys --mouse

Commands

Configuration

tsql looks for configuration at ~/.config/tsql/config.toml.

[connection]
# Default connection URL (can be overridden by CLI arg or DATABASE_URL)
default_url = "postgres://localhost/mydb"

[keybindings]
# Custom keybindings (see config.example.toml for options)

See config.example.toml for all available options.

Requirements

• PostgreSQL 12 or later
• Terminal with 256-color support recommended

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.