![gobang](./resources/logo.png) gobang is currently in alpha A cross-platform terminal database tool written in Rust [![github workflow status](https://img.shields.io/github/workflow/status/TaKO8Ki/gobang/CI/main)](https://github.com/TaKO8Ki/gobang/actions) [![crates](https://img.shields.io/crates/v/gobang.svg?logo=rust)](https://crates.io/crates/gobang) ![gobang](./resources/gobang.gif)
## 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 ### Cargo If you already have a Rust environment set up, you can use the `cargo install` command: ``` $ cargo install --version 0.1.0-alpha.1 gobang ``` ## 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 | | / | 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: ```toml [[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" ```