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.
Documentation
You can find documentation for installing, configuring, and using iamb on its website, iamb.chat.
Installation
Install Rust (1.66.0 or above) and Cargo, and then run:
cargo install --locked iamb
NetBSD
On NetBSD a package is available from the official repositories. To install it simply run:
pkgin install iamb
Arch Linux
On Arch Linux a package is available in the Arch User Repositories (AUR). To install it simply run with your favorite AUR helper:
paru iamb-git
Nix / NixOS (flake)
nix profile install "github:ulyssa/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 | βοΈ | βοΈ | β | βοΈ |
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.