Database administrators, backend engineers, and DevOps specialists frequently need to inspect database schemas, verify records, and test queries directly from remote terminal sessions. Traditional terminal clients (such as standard psql or mysql shells) lack interactive visual navigation, while graphical desktop clients (such as DBeaver or TablePlus) require heavy GUI runtimes or X11 forwarding over SSH. Gobang bridges this operational gap by delivering a lightweight, blazingly fast Terminal User Interface (TUI) written in Rust that supports MySQL, PostgreSQL, and SQLite out of the box.
Key Features of Gobang
Gobang provides an intuitive keyboard-driven workflow tailored for rapid database exploration and manipulation:
- Multi-Engine Support: Connect seamlessly to PostgreSQL, MySQL, and local SQLite database files through a unified interface.
- Interactive Data Table: Browse records with smooth columnar scrolling, cell inspection, sorting, and pagination.
- Schema Explorer: Quickly inspect table structures, column definitions, data types, and primary key constraints.
- Query Editor with Syntax Highlighting: Draft and execute arbitrary SQL queries directly within an integrated terminal editor.
- Secure Credential Storage: Save and organise multiple connection configurations locally with encrypted storage capabilities.
- Resource-Efficient: Engineered with minimal CPU and memory overhead, making it ideal for low-resource VPS nodes and cloud jump hosts.
Prerequisites and System Requirements
Before installing Gobang, ensure your Linux environment meets the following baseline requirements:
- Linux Distribution: Ubuntu 22.04/24.04 LTS, Debian 12, Fedora 39/40, or Arch Linux.
- Terminal Emulator: Modern terminal emulator supporting true colour (24-bit) and UTF-8 glyphs (e.g., Alacritty, Kitty, WezTerm, GNOME Terminal).
- Rust Toolchain (Optional): Required only if compiling from source via Cargo (Rust 1.70 or newer).
Step-by-Step: Installing Gobang on Linux
You can deploy Gobang using pre-compiled release binaries or build directly via the Rust package manager.
Method 1: Installing via Cargo (Recommended for Developers)
If you have Rust and Cargo configured on your machine, install Gobang with a single command:
cargo install gobang
Confirm that your Cargo binary path (~/.cargo/bin) is present in your shell’s PATH variable:
gobang --version
Method 2: Installing Pre-Compiled Release Binaries
For systems without the Rust compiler toolchain installed, fetch the compiled binary from GitHub releases:
- Navigate to your temporary download directory:
cd /tmp - Download the latest release tarball for Linux x86_64:
curl -LO https://github.com/TaKO8Ki/gobang/releases/latest/download/gobang-x86_64-unknown-linux-musl.tar.gz - Extract the archive:
tar -xzvf gobang-x86_64-unknown-linux-musl.tar.gz - Move the executable to your system binary directory:
sudo mv gobang /usr/local/bin/ - Verify installation:
gobang --version
Launching Gobang and Managing Database Connections
To start the application, launch the binary without arguments:
gobang
Upon launch, Gobang presents the Connections screen. To configure a new database profile:
- Press a to open the connection creation dialogue.
- Enter a descriptive Connection Name (for example,
production-postgresorlocal-sqlite). - Select your database engine type (
PostgreSQL,MySQL, orSQLite). - Populate the connection parameters:
- Host & Port: e.g.,
127.0.0.1:5432for PostgreSQL or127.0.0.1:3306for MySQL. - Database Name: The target database catalogue.
- Username & Password: Database authentication credentials.
- File Path (SQLite only): Absolute path to the
.dbor.sqlitefile.
- Host & Port: e.g.,
- Press Enter to validate and save the connection.
To connect immediately without configuring a saved profile, pass a standard database connection URI directly on the command line:
gobang "postgres://user:password@localhost:5432/app_db"
gobang "sqlite:///var/data/analytics.db"
Navigating the Gobang Interface and Keybindings
Gobang uses Vim-inspired keybindings for rapid, frictionless navigation:
- Tab / Shift+Tab: Switch between UI panels (Tables list, Query editor, Records view).
- j / k (or Arrow Keys): Scroll down and up through table records and schema items.
- h / l: Scroll horizontally across wide database columns.
- e: Open the integrated SQL query editor.
- Ctrl+r: Execute the current SQL query drafted in the editor.
- Esc: Close modals, return to the navigation panel, or dismiss overlays.
- q: Quit Gobang cleanly.
Configuring Gobang Configuration and Theme Files
Gobang stores user settings and saved connections in the standard XDG configuration path at ~/.config/gobang/:
cat ~/.config/gobang/config.toml
You can fine-tune query execution timeouts, adjust record pagination limits (default is 100 rows per fetch), and customise colour accents to match your terminal theme palette.