• Stars
    star
    534
  • Rank 83,095 (Top 2 %)
  • Language
    Rust
  • License
    Apache License 2.0
  • Created over 3 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Matrix client for Vim addicts

iamb

Build Status License: Apache 2.0 #iamb:0x.badd.cafe 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 (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.