# gobang
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
## 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 | Scroll left |
| j | Scroll down |
| k | Scroll up |
| l | Scroll right |
| Ctrl + d | Scroll down multiple lines |
| Ctrl + u | Scroll up multiple lines |
| y | Copy a cell value |
| → | Move focus to right |
| ← | Move focus to left |
| / | Filter |
## 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"
```