RumaTui
A command-line Matrix client.
Work In Progress. A Matrix client written using tui.rs and matrix-rust-sdk to provide a clickable cli to chat.
This project is still very much a work in progress. Please file issues, but I will preemptively say the error messages need work, and the code needs to be refactored to be a little more reader-friendly. Thanks for giving it a go!
Install
For the latest and greatest
cargo install --git https://github.com/DevinR528/rumatuiOr the slightly safer approach but with fewer features (see CHANGELOG)
cargo install rumatui --version 0.1.13-alphaRun
rumatui [HOMESERVER | OPTIONS]It can be run torified with torsocks:
torsocks rumatui [HOMESERVER | OPTIONS]Options
- -h or --help Prints help information
- -v or -verbose Will create a log of the session at '~/.rumatui/logs.json'
If no homeserver is specified, matrix.org is used.
Use
Most of rumatui is click-able however, there are a few buttons that can be used (this is a terminal after all).
- Esc will exit
rumatui - Up/down arrow toggles login/register selected text box
- Enter still works for all buttons except the decline/accept invite
- Ctrl-s sends a message
- Delete leaves and forgets the selected room
- Left/right arrows, while at the login window, toggles login/register window
- Left arrow, while at the main chat window, brings up the room search window
- Enter, while in the room search window, starts the search
- Ctrl-d, while a room is selected in the room search window, joins the room
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.