NAME¶

iamb — a terminal-based client for Matrix for the Vim addict

SYNOPSIS¶

DESCRIPTION¶

iamb is a client for the Matrix communication protocol. It provides a terminal user interface with familiar Vim keybindings, and includes support for multiple profiles, threads, spaces, notifications, reactions, custom keybindings, and more.

This manual page includes a quick rundown of the available commands in iamb. For example usage and a full description of each one and its arguments, please refer to the full documentation online.

OPTIONS¶

-P, --profile

The profile to start iamb with. If this flag is not specified, then it defaults to using default_profile (see iamb(5)).

-C, --config-directory

Path to the directory the configuration file is located in.

-h, --help

Show the help text and quit.

-V, --version

Show the current iamb version and quit.

GENERAL COMMANDS¶

:chats

View a list of joined rooms and direct messages.

:dms

View a list of direct messages.

:logout

Log out of iamb.

:rooms

View a list of joined rooms.

:spaces

View a list of joined spaces.

:welcome

View the startup Welcome window.

E2EE COMMANDS¶

:keys export [path] [passphrase]

Export and encrypt keys to path.

:keys import [path] [passphrase]

Import and decrypt keys from path.

:verify

View a list of ongoing E2EE verifications.

MESSAGE COMMANDS¶

:download

Download an attachment from the selected message.

:edit

Edit the selected message.

:editor

Open an external $EDITOR to compose a message.

:open

Download and then open an attachment, or open a link in a message.

:react [shortcode]

React to the selected message with an Emoji.

:redact [reason]

Redact the selected message.

:reply

Reply to the selected message.

:unreact [shortcode]

Remove your reaction from the selected message. When no arguments are given, remove all of your reactions from the message.

:upload

Upload an attachment and send it to the currently selected room.

ROOM COMMANDS¶

:create

Create a new room.

:invite accept

Accept an invitation to the currently focused room.

:invite reject

Reject an invitation to the currently focused room.

:invite send [user]

Send an invitation to a user to join the currently focused room.

:join [room]

Join a room.

:leave

Leave the currently focused room.

:members

View a list of members of the currently focused room.

:room name set [name]

Set the name of the currently focused room.

:room name unset

Unset the name of the currently focused room.

:room tag set [tag]

Add a tag to the currently focused room.

:room tag unset [tag]

Remove a tag from the currently focused room.

:room topic set [topic]

Set the topic of the currently focused room.

:room topic unset

Unset the topic of the currently focused room.

WINDOW COMMANDS¶

:horizontal [cmd]

Change the behaviour of the given command to be horizontal.

:leftabove [cmd]

Change the behaviour of the given command to open before the current window.

:only, :on

Quit all but one window in the current tab.

:quit, :q

Quit a window.

:quitall, :qa

Quit all windows in the current tab.

:resize

Resize a window.

:rightbelow [cmd]

Change the behaviour of the given command to open after the current window.

:split, :sp

Horizontally split a window.

:vertical [cmd]

Change the layout of the following command to be vertical.

:vsplit, :vsp

Vertically split a window.

TAB COMMANDS¶

:tab [cmd]

Run a command that opens a window in a new tab.

:tabclose, :tabc

Close a tab.

:tabedit [room], :tabe

Open a room in a new tab.

:tabrewind, :tabr

Go to the first tab.

:tablast, :tabl

Go to the last tab.

:tabnext, :tabn

Go to the next tab.

:tabonly, :tabo

Close all but one tab.

:tabprevious, :tabp

Go to the preview tab.

EXAMPLES¶

$ iamb -P personal

$ iamb -C ~/src/iamb-dev/dev-config/

REPORTING BUGS¶

Please report bugs in iamb or its manual pages at https://github.com/ulyssa/iamb/issues

SEE ALSO¶

iamb(5)

Extended documentation is available online at https://iamb.chat