Go to file
2021-09-08 00:23:01 +09:00
.github create FUNDING.yml 2021-09-08 00:23:01 +09:00
database-tree v0.1.0-alpha.2 release (#65) 2021-09-07 19:51:49 +09:00
resources update gobang.gif 2021-09-06 22:31:27 +09:00
src Bump up dependency versions (#62) 2021-09-07 19:10:27 +09:00
.gitignore Refactor components (#12) 2021-07-08 23:08:04 +09:00
Cargo.lock v0.1.0-alpha.2 release (#65) 2021-09-07 19:51:49 +09:00
Cargo.toml exclude images (#66) 2021-09-07 22:12:44 +09:00
LICENSE Create LICENSE (#64) 2021-09-07 19:30:38 +09:00
README.md add key for connections (#70) 2021-09-07 23:17:32 +09:00
sample.toml move table_status under table 2021-09-05 22:50:38 +09:00

gobang

gobang is currently in alpha

A cross-platform TUI database management tool written in Rust

github workflow status crates

gobang

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 youre 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)

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"