vi-sql documentation

vi-sql is a terminal UI client for SQL Databases. It ships two keybinding profiles — normal and vim — along with themes, CSV import/export, and an MCP server for AI tool integration. Single binary, no runtime dependencies.

New here? Install the binary, then follow the Getting Started guide.

Setup

Installation

Install via script, pin a version, or build from source.

Getting Started

Run vi-sql for the first time and connect to a database.

Configuration

Full reference for config.yaml — all fields and defaults.

Features

Vim Mode

Enable vim-style keybindings and learn the full key map.

Keybindings

The default (normal mode) key map for every view.

Themes

Switch between built-in themes or build your own.

Import & Export

Import CSV and export results in multiple formats.

MCP Server

Expose your database to AI tools via the Model Context Protocol.

Integrations

Neovim Plugin

Open vi-sql in a floating Neovim window with background session persistence.