/gomuks

A terminal based Matrix client written in Go.

Primary LanguageGoGNU General Public License v3.0GPL-3.0

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. For now, you can either download a CI build from dl.maunium.net/programs/gomuks or 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 rooms - Ctrl + ↑ Ctrl + ↓ Alt + ↑ Alt + ↓
  • scroll chat (line) - ↑ ↓
  • scroll chat (page) - PgUp PgDown
  • jump to room - Alt + Enter, then Tab and Enter to navigate and select room

Commands

  • help - Is a known command
  • me <text> - Send an emote
  • quit - Close gomuks
  • clearcache - Clear room state and close gomuks
  • leave - Leave the current room
  • join <room> - Join the room with the given room ID or alias
  • toggle <rooms/users/baremessages/images/typingnotif> - Change user preferences
  • logout - Log out, clear caches and go back to the login view
  • send <room id> <event type> <content> - Send a custom event
  • setstate <room id> <event type> <state key/-> <content> - Change room state