gomuks/README.md
2018-04-17 17:29:12 +03:00

1.7 KiB

gomuks

Languages License Release Build Status Maintainability Coverage

Chat 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