iamb

About

iamb is a Matrix client for the terminal that uses Vim keybindings.

This project is a work-in-progress, and there's still a lot to be implemented, but much of the basic client functionality is already present.

Installation

Install Rust and Cargo, and then run:

cargo install iamb

Configuration

You can create a basic configuration in $CONFIG_DIR/iamb/config.json that looks like:

{
    "profiles": {
        "example.com": {
            "url": "https://example.com",
            "user_id": "@user:example.com"
        }
    }
}

Comparison With Other Clients

To get an idea of what is and isn't yet implemented, here is a subset of the Matrix website's features comparison table, showing two other TUI clients and Element Web:

	iamb	gomuks	weechat-matrix	Element Web/Desktop
Room directory	❌ (#14)	❌	✔️	✔️
Room tag showing	❌ (#15)	✔️	❌	✔️
Room tag editing	❌ (#15)	✔️	❌	✔️
Search joined rooms	❌ (#16)	✔️	❌	✔️
Room user list	✔️	✔️	✔️	✔️
Display Room Description	✔️	✔️	✔️	✔️
Edit Room Description	✔️	❌	✔️	✔️
Highlights	❌ (#8)	✔️	✔️	✔️
Pushrules	❌	✔️	❌	✔️
Send read markers	❌ (#11)	✔️	✔️	✔️
Display read markers	❌ (#11)	❌	❌	✔️
Sending Invites	❌ (#7)	✔️	✔️	✔️
Accepting Invites	❌ (#7)	✔️	✔️	✔️
Typing Notification	✔️	✔️	✔️	✔️
E2E	✔️	✔️	✔️	✔️
Replies	❌ (#3)	✔️	❌	✔️
Attachment uploading	❌ (#13)	❌	✔️	✔️
Attachment downloading	❌ (#13)	✔️	✔️	✔️
Send stickers	❌	❌	❌	✔️
Send formatted messages (markdown)	❌ (#10)	✔️	✔️	✔️
Rich Text Editor for formatted messages	❌	❌	❌	✔️
Display formatted messages	❌ (#10)	✔️	✔️	✔️
Redacting	❌ (#5)	✔️	✔️	✔️
Multiple Matrix Accounts	✔️	❌	✔️	❌
New user registration	❌	❌	❌	✔️
VOIP	❌	❌	❌	✔️
Reactions	❌ (#2)	✔️	❌	✔️
Message editing	❌ (#4)	✔️	❌	✔️
Room upgrades	❌	✔️	❌	✔️
Localisations	❌	1	❌	44
SSO Support	❌	✔️	✔️	✔️

License

iamb is released under the Apache License, Version 2.0.

6.0 KiB Raw Blame History