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
251 Commits 1 Branch 0 Tags 5.1 MiB
Go 100%
b9079e22d2
Go to file
Tulir Asokan b9079e22d2 Gofmt
2018-06-02 00:44:21 +03:00
config Gofmt 2018-06-02 00:44:21 +03:00
deb/DEBIAN Add debian packaging and some build scripts 2018-05-03 10:03:25 +03:00
debug Gofmt 2018-04-19 11:10:34 +03:00
interface Add UI preferences and simplify config save/load (ref #43) 2018-05-24 23:27:12 +03:00
lib Rewrite HTML parser 2018-05-31 16:59:40 +03:00
matrix Gofmt 2018-06-02 00:44:21 +03:00
scripts Update tcell and include tcell database in debian package 2018-05-26 00:07:01 +03:00
ui Gofmt 2018-06-02 00:44:21 +03:00
vendor Update tcell and include tcell database in debian package 2018-05-26 00:07:01 +03:00
.codeclimate.yml Add .codeclimate.yml 2018-04-19 11:33:59 +03:00
.editorconfig Update README and other files 2018-03-20 23:49:37 +02:00
.gh-deployer.yaml Add gh-deployer 2018-05-15 19:56:43 +03:00
.gitignore Add .tmp to .gitignore 2018-05-15 19:59:17 +03:00
.travis.yml Enable travis for codeclimate coverage reports 2018-04-10 21:27:57 +03:00
chat-preview.png Update preview image 2018-05-24 10:34:31 +03:00
gomuks.go Move all cache to ~/.cache/gomuks 2018-05-17 16:29:18 +03:00
Gopkg.lock Update tcell and include tcell database in debian package 2018-05-26 00:07:01 +03:00
Gopkg.toml switch fuzzysearch to upstream 2018-05-23 10:21:08 -05:00
LICENSE Initial commit 2018-02-24 18:15:45 +02:00
main.go Disconnect UI from main Gomuks struct. Fixes #21 2018-04-18 18:35:54 +03:00
README.md fuzzy search prototype 2018-05-21 11:00:21 -05:00

README.md

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 compile from source or 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

  • /quit - Close gomuks
  • /logout - Log out, clear caches and go back to the login view
  • /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