iamb

Build Status License: Apache 2.0 Latest Version

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.

Example Usage

Documentation

You can find documentation for installing, configuring, and using iamb on its website, [iamb.chat].

Installation

Install Rust and Cargo, and then run:

cargo install --locked iamb

Configuration

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

json { "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 | ✔️ | ✔️ | ❌ | ✔️ | | Room tag editing | ✔️ | ✔️ | ❌ | ✔️ | | Search joined rooms | ❌ ([#16]) | ✔️ | ❌ | ✔️ | | Room user list | ✔️ | ✔️ | ✔️ | ✔️ | | Display Room Description | ✔️ | ✔️ | ✔️ | ✔️ | | Edit Room Description | ✔️ | ❌ | ✔️ | ✔️ | | Highlights | ❌ ([#8]) | ✔️ | ✔️ | ✔️ | | Pushrules | ❌ | ✔️ | ❌ | ✔️ | | Send read markers | ✔️ | ✔️ | ✔️ | ✔️ | | Display read markers | ✔️ | ❌ | ❌ | ✔️ | | Sending Invites | ✔️ | ✔️ | ✔️ | ✔️ | | Accepting Invites | ✔️ | ✔️ | ✔️ | ✔️ | | Typing Notification | ✔️ | ✔️ | ✔️ | ✔️ | | E2E | ✔️ | ✔️ | ✔️ | ✔️ | | Replies | ✔️ | ✔️ | ❌ | ✔️ | | Attachment uploading | ✔️ | ❌ | ✔️ | ✔️ | | Attachment downloading | ✔️ | ✔️ | ✔️ | ✔️ | | Send stickers | ❌ | ❌ | ❌ | ✔️ | | Send formatted messages (markdown) | ✔️ | ✔️ | ✔️ | ✔️ | | Rich Text Editor for formatted messages | ❌ | ❌ | ❌ | ✔️ | | Display formatted messages | ✔️ | ✔️ | ✔️ | ✔️ | | Redacting | ✔️ | ✔️ | ✔️ | ✔️ | | Multiple Matrix Accounts | ✔️ | ❌ | ✔️ | ❌ | | New user registration | ❌ | ❌ | ❌ | ✔️ | | VOIP | ❌ | ❌ | ❌ | ✔️ | | Reactions | ✔️ | ✔️ | ❌ | ✔️ | | Message editing | ✔️ | ✔️ | ❌ | ✔️ | | Room upgrades | ❌ ([#41]) | ✔️ | ❌ | ✔️ | | Localisations | ❌ | 1 | ❌ | 44 | | SSO Support | ❌ | ✔️ | ✔️ | ✔️ |

License

iamb is released under the [Apache License, Version 2.0].