1. Manuals
  2. Tumbleweed
  3. iamb
  4. iamb(1)

Scroll to navigation

IAMB(1) General Commands Manual IAMB(1)

NAME

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

SYNOPSIS

iamb [-hV] [-P profile] [-C dir]

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

, --profile
The profile to start iamb with. If this flag is not specified, then it defaults to using default_profile (see iamb(5)).
, --config-directory
Path to the directory the configuration file is located in.
, --help
Show the help text and quit.
, --version
Show the current iamb version and quit.

GENERAL COMMANDS

View a list of joined rooms and direct messages.
View a list of direct messages.
Log out of iamb.
View a list of joined rooms.
View a list of joined spaces.
View a list of unread rooms.
View the startup Welcome window.

E2EE COMMANDS

Export and encrypt keys to path.
Import and decrypt keys from path.
View a list of ongoing E2EE verifications.

MESSAGE COMMANDS

Download an attachment from the selected message.
Edit the selected message.
Open an external $EDITOR to compose a message.
Download and then open an attachment, or open a link in a message.
React to the selected message with an Emoji.
Redact the selected message.
Reply to the selected message.
:unreads clear
Mark all unread rooms as read.
Remove your reaction from the selected message. When no arguments are given, remove all of your reactions from the message.
Upload an attachment and send it to the currently selected room.

ROOM COMMANDS

Create a new room.
Accept an invitation to the currently focused room.
Reject an invitation to the currently focused room.
Send an invitation to a user to join the currently focused room.
Join a room.
Leave the currently focused room.
View a list of members of the currently focused room.
Set the name of the currently focused room.
Unset the name of the currently focused room.
Set a notification level for the currently focused room. Valid levels are “mute”, “mentions”, “keywords”, and “all”. Note that “mentions” and “keywords” are aliases for the same behaviour.
Unset any room-level notification configuration.
Show the current room-level notification configuration. If the room is using the account-level default, then this will print “default”.
Add a tag to the currently focused room.
Remove a tag from the currently focused room.
Set the topic of the currently focused room.
Unset the topic of the currently focused room.
Create and point the given alias to the room.
Delete the provided alias from the room's alternative alias list.
Show alternative aliases to the room, if any are set.
Set the room's canonical alias to the one provided, and make the previous one an alternative alias.
Delete the room's canonical alias.
Show the room's canonical alias, if any is set.
Ban a user from this room with an optional reason.
Unban a user from this room with an optional reason.
Kick a user from this room with an optional reason.

WINDOW COMMANDS

Change the behaviour of the given command to be horizontal.
Change the behaviour of the given command to open before the current window.
,
Quit all but one window in the current tab.
,
Quit a window.
,
Quit all windows in the current tab.
Resize a window.
Change the behaviour of the given command to open after the current window.
,
Horizontally split a window.
Change the layout of the following command to be vertical.
,
Vertically split a window.

TAB COMMANDS

Run a command that opens a window in a new tab.
,
Close a tab.
,
Open a room in a new tab.
,
Go to the first tab.
,
Go to the last tab.
,
Go to the next tab.
,
Close all but one tab.
,
Go to the preview tab.

SLASH COMMANDS

,
Interpret the message body as Markdown markup. This is the default behaviour.
,
Send the message body as literal HTML.
, ,
Do not interpret any markup in the message body and send it as it is.
Send an emote message.
Produces no effect in iamb, but will display confetti in Matrix clients that support doing so.
Produces no effect in iamb, but will display fireworks in Matrix clients that support doing so.
Produces no effect in iamb, but will display floating hearts in Matrix clients that support doing so.
Produces no effect in iamb, but will display rainfall in Matrix clients that support doing so.
Produces no effect in iamb, but will display snowfall in Matrix clients that support doing so.
Produces no effect in iamb, but will display aliens from Space Invaders in Matrix clients that support doing so.

EXAMPLES

Example 1: Starting with a specific profile

To start with a profile named instead of the default_profile value:

$ iamb -P personal

Example 2: Using an alternate configuration directory

By default, iamb will use the XDG directories, but you may sometimes want to store your configuration elsewhere.

$ 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

March 24, 2024 Linux 6.4.0-150600.23.25-default