mirror of
https://github.com/TaKO8Ki/gobang
synced 2024-11-15 18:13:50 +00:00
7b1b5f7eba
hi, thought it would be worth using `name` in a couple of the example config fields This would require a new release though, since the [latest release](https://github.com/TaKO8Ki/gobang/tree/v0.1.0-alpha.5) predates #105 Thanks for the cool project :)
165 lines
4.0 KiB
Markdown
165 lines
4.0 KiB
Markdown
<div align="center">
|
||
|
||
|
||
|
||
gobang is currently in alpha
|
||
|
||
A cross-platform TUI database management tool written in Rust
|
||
|
||
[](https://github.com/TaKO8Ki/gobang/actions) [](https://crates.io/crates/gobang)
|
||
|
||
|
||
|
||
</div>
|
||
|
||
## Features
|
||
|
||
- Cross-platform support (macOS, Windows, Linux)
|
||
- Multiple Database support (MySQL, PostgreSQL, SQLite)
|
||
- Intuitive keyboard only control
|
||
|
||
## TODOs
|
||
|
||
- [ ] SQL editor
|
||
- [ ] Custom key bindings
|
||
- [ ] Custom theme settings
|
||
- [ ] Support the other databases
|
||
|
||
## What does "gobang" come from?
|
||
|
||
gobang means a Japanese game played on goban, a go board. The appearance of goban looks like table structure. And I live in Kyoto, Japan. In Kyoto city, streets are laid out on a grid (We call it “goban no me no youna (碁盤の目のような)”). They are why I named this project "gobang".
|
||
|
||
## Installation
|
||
|
||
### With Homebrew (Linux, macOS)
|
||
|
||
If you’re using Homebrew or Linuxbrew, install the gobang formula:
|
||
|
||
```
|
||
brew install tako8ki/tap/gobang
|
||
```
|
||
|
||
### On Windows
|
||
|
||
If you're a Windows Scoop user, then you can install gobang from the [official bucket](https://github.com/ScoopInstaller/Main/blob/master/bucket/gobang.json):
|
||
|
||
```
|
||
scoop install gobang
|
||
```
|
||
### On NixOS
|
||
|
||
If you're a Nix user, you can install [gobang](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/database/gobang/default.nix) from nixpkgs:
|
||
|
||
```
|
||
$ nix-env --install gobang
|
||
```
|
||
|
||
### On Archlinux
|
||
|
||
If you're an Archlinux user, you can install [gobang](https://aur.archlinux.org/packages/gobang-bin) from AUR:
|
||
|
||
```
|
||
paru -S gobang-bin
|
||
```
|
||
|
||
### On NetBSD
|
||
|
||
If you're a NetBSD user, then you can install gobang from [pkgsrc](https://pkgsrc.se/databases/gobang):
|
||
|
||
```
|
||
pkgin install gobang
|
||
```
|
||
|
||
### With 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.5 gobang
|
||
```
|
||
|
||
### From binaries (Linux, macOS, Windows)
|
||
|
||
- Download the [latest release binary](https://github.com/TaKO8Ki/gobang/releases) for your system
|
||
- Set the `PATH` environment variable
|
||
|
||
## Usage
|
||
|
||
```
|
||
$ gobang
|
||
```
|
||
|
||
```
|
||
$ gobang -h
|
||
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](#Configuration).
|
||
|
||
## Keymap
|
||
|
||
| Key | Description |
|
||
| ---- | ---- |
|
||
| <kbd>h</kbd>, <kbd>j</kbd>, <kbd>k</kbd>, <kbd>l</kbd> | Scroll left/down/up/right |
|
||
| <kbd>Ctrl</kbd> + <kbd>u</kbd>, <kbd>Ctrl</kbd> + <kbd>d</kbd> | Scroll up/down multiple lines |
|
||
| <kbd>g</kbd> , <kbd>G</kbd> | Scroll to top/bottom |
|
||
| <kbd>H</kbd>, <kbd>J</kbd>, <kbd>K</kbd>, <kbd>L</kbd> | Extend selection by one cell left/down/up/right |
|
||
| <kbd>y</kbd> | Copy a cell value |
|
||
| <kbd>←</kbd>, <kbd>→</kbd> | Move focus to left/right |
|
||
| <kbd>c</kbd> | Move focus to connections |
|
||
| <kbd>/</kbd> | Filter |
|
||
| <kbd>?</kbd> | Help |
|
||
| <kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd>, <kbd>4</kbd>, <kbd>5</kbd> | Switch to records/columns/constraints/foreign keys/indexes tab |
|
||
| <kbd>Esc</kbd> | Hide pop up |
|
||
|
||
## 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
|
||
password = "password"
|
||
database = "foo"
|
||
name = "mysql Foo DB"
|
||
|
||
[[conn]]
|
||
type = "postgres"
|
||
user = "root"
|
||
host = "localhost"
|
||
port = 5432
|
||
database = "bar"
|
||
name = "postgres Bar DB"
|
||
|
||
[[conn]]
|
||
type = "sqlite"
|
||
path = "/path/to/baz.db"
|
||
```
|
||
|
||
## Contribution
|
||
|
||
Contributions, issues and pull requests are welcome!
|