gobang/README.md

gobang is currently in alpha

A cross-platform TUI database management tool written in Rust

Features

• Cross-platform support (macOS, Windows, Linux)
• Multiple Database support (MySQL, PostgreSQL, SQLite)
• Intuitive keyboard only control

TODOs

• Query widget
• Custom key bindings
• Custom theme settings
• Support the other databases

Installation

Homebrew (Linux/macOS)

If you’re using Homebrew or Linuxbrew, install the gobang formula:

$ brew install tako8ki/tap/gobang

Cargo (Linux/macOS/Windows)

If you already have a Rust environment set up, you can use the cargo install command:

$ cargo install --version 0.1.0-alpha.2 gobang

Using a release binary (Linux/macOS/Windows)

• Download the latest release binary for your system
• Set the PATH environment variable

Usage

$ gobang

USAGE:
    gobang [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --config-path <config-path>    Set the config file

If you want to add connections, you need to edit your config file. For more information, please see Configuration.

Keymap

Key	Description
h, j, k, l	Scroll left/down/up/right
Ctrl + u, Ctrl + d	Scroll up/down multiple lines
g , G	Scroll to top/bottom
H, J, K, L	Extend selection by one cell left/down/up/right
y	Copy a cell value
←, →	Move focus to left/right
c	Move focus to connections
/	Filter
?	Help
1, 2, 3, 4, 5	Switch to records/columns/constraints/foreign keys/indexes tab

Configuration

The location of the file depends on your OS:

• macOS: $HOME/.config/gobang/config.toml
• Linux: $HOME/.config/gobang/config.toml
• Windows: %APPDATA%/gobang/config.toml

The following is a sample config.toml file:

[[conn]]
type = "mysql"
user = "root"
host = "localhost"
port = 3306

[[conn]]
type = "mysql"
user = "root"
host = "localhost"
port = 3306
database = "foo"

[[conn]]
type = "postgres"
user = "root"
host = "localhost"
port = 5432
database = "bar"

[[conn]]
type = "sqlite"
path = "/path/to/baz.db"