Alexander/gomuks
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A personal build of the TUI matrix client including image-pasting and notifications for all rooms
95 Commits 1 Branch 0 Tags 5.1 MiB
Go 100%
ee67c1446c
Go to file
Tulir Asokan ee67c1446c Convert message buffer to use custom colorable strings
2018-04-10 16:07:16 +03:00
config Refactor UI to use interfaces everywhere 2018-04-09 23:45:54 +03:00
debug Include error in pretty panic log 2018-04-10 16:01:01 +03:00
interface Convert message buffer to use custom colorable strings 2018-04-10 16:07:16 +03:00
matrix Refactor UI to use interfaces everywhere 2018-04-09 23:45:54 +03:00
notification Add sounds to notifications 2018-03-26 18:04:10 +03:00
ui Convert message buffer to use custom colorable strings 2018-04-10 16:07:16 +03:00
.editorconfig Update README and other files 2018-03-20 23:49:37 +02:00
.gitignore Update README and other files 2018-03-20 23:49:37 +02:00
gomuks.go Include error in pretty panic log 2018-04-10 16:01:01 +03:00
LICENSE Initial commit 2018-02-24 18:15:45 +02:00
README.md Document needed go version (#17) 2018-04-02 13:39:18 +03:00

README.md

gomuks

Languages License Release Maintainability Coverage

Preview

A terminal Matrix client written in Go using gomatrix and tview.

Basic usage is possible, but expect bugs and missing features.

Discussion

Matrix room: #gomuks:maunium.net

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:

  1. Install Go 1.10 or higher
  2. Run go get -u maunium.net/go/gomuks
  3. gomuks should now be in $GOPATH/bin/gomuks

Usage

Switch between rooms with ctrl + up/down arrow (alt+arrows works too).

Scroll chat with page up/down (half of height per click) or up/down arrow (1 row per click)

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
  • /panic - Trigger a test panic