2018-02-24 17:15:45 +01:00
|
|
|
# gomuks
|
2018-03-18 21:57:07 +01:00
|
|
|
|
2018-03-16 15:33:33 +01:00
|
|
|
|
2018-03-15 20:53:50 +01:00
|
|
|
A terminal Matrix client written in Go using [gomatrix](https://github.com/matrix-org/gomatrix) and [tview](https://github.com/rivo/tview).
|
2018-03-13 22:02:19 +01:00
|
|
|
|
2018-03-18 21:57:07 +01:00
|
|
|
Basic usage is possible, but many of the features you'd expect from a Matrix
|
|
|
|
|
client (like proper chat history) haven't been implemented.
|
2018-03-15 20:53:50 +01:00
|
|
|
|
2018-03-16 15:46:05 +01:00
|
|
|
## Discussion
|
|
|
|
|
|
|
|
|
|
Matrix room: [#gomuks:maunium.net](https://matrix.to/#/#gomuks:maunium.net)
|
|
|
|
|
|
2018-03-15 20:53:50 +01:00
|
|
|
## Installation
|
|
|
|
|
Once the client becomes actually usable, I'll start making GitHub releases with
|
|
|
|
|
precompiled executables and maybe even some Linux packages.
|
|
|
|
|
|
|
|
|
|
For now, you'll have to compile from source:
|
|
|
|
|
|
|
|
|
|
0. Install [Go](https://golang.org/)
|
|
|
|
|
1. Run `go get -u maunium.net/go/gomuks`
|
|
|
|
|
2. gomuks should now be in `$GOPATH/bin/gomuks`
|
2018-03-16 15:35:52 +01:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Switch between rooms with ctrl + up/down arrow.
|
|
|
|
|
|
|
|
|
|
Scroll chat with page up/down
|
|
|
|
|
|
|
|
|
|
### Commands
|
|
|
|
|
* `/quit` - Close gomuks
|
|
|
|
|
* `/clearcache` - Clear room state cache and close gomuks
|
|
|
|
|
* `/leave` - Leave the current room
|
|
|
|
|
* `/join <room>` - Join the room with the given room ID or alias
|
