IAMB(1)

📦
version 0.0.11 · 3 versions
, in alpine 3.24, nixos 26.05

🌸 IAMB(1) — General Commands Manual 🌸

ok so before we even start: this is the manual page for iamb, bestie. It lives in the General Commands Manual section, number 1, and honestly it's giving ✨terminal romance✨. Let's get into it 💅

💖 NAME 💖

iamb — a terminal-based client for Matrix, and like… it's for the Vim addict. You know who you are 🫶

🦋 SYNOPSIS 🦋

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

🌸 DESCRIPTION 🌸

iamb is a client for the Matrix communication protocol, no cap. It gives you a terminal user interface with familiar Vim keybindings, and it's lowkey stacked: support for multiple profiles, threads, spaces, notifications, reactions, custom keybindings, and more. Like?? it does everything 💀

This manual page right here is just a quick rundown of the available commands in iamb. If you want actual example usage and a full description of each command and its arguments, the full documentation is online — go look, it's iconic ⭐

🎀 OPTIONS 🎀

  • -P, --profile — the profile you want iamb to start with. If you don't pass this flag, it defaults to using default_profile (peep iamb(5) for that one 👀).
  • -C, --config-directory — path to the directory where the configuration file lives.
  • -h, --help — show the help text and quit. cute and quick ✨
  • -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 [user id] — log out of iamb.
  • :rooms — view a list of joined rooms.
  • :spaces — view a list of joined spaces.
  • :unreads — view a list of unread rooms.
  • :unreads clear — mark all rooms as read.
  • :welcome — view the startup Welcome window.
  • :forget — remove all left rooms from the internal database. spring cleaning era 🧚

🔐 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.
  • :verify accept [key] — accept a verification request.
  • :verify cancel [key] — cancel an in-progress verification.
  • :verify confirm [key] — confirm an in-progress verification.
  • :verify mismatch [key] — reject an in-progress verification due to mismatched Emoji 😭
  • :verify request [user id] — request a new verification with the specified user.

💌 MESSAGE COMMANDS 💌

  • :download [path] — download an attachment from the selected message and save it to the optional path.
  • :open [path] — download and then open an attachment, or open a link in a message.
  • :edit — edit the selected message.
  • :editor — open an external $EDITOR to compose a message. yes, your editor, your rules 👑
  • :react [shortcode] — react to the selected message with an Emoji.
  • :unreact [shortcode] — remove your reaction from the selected message. When no arguments are given, remove all of your reactions from the message.
  • :redact [reason] — redact the selected message with the optional reason.
  • :reply — reply to the selected message.
  • :cancel — cancel the currently drafted message, including replies.
  • :replied — go to the message the current message replied to.
  • :upload [path] — upload an attachment and send it to the currently selected room.

🏠 ROOM COMMANDS 🏠

  • :create [arguments] — create a new room. Arguments can be ++alias=[alias], ++public, ++space, and ++encrypted.
  • :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 or open it if you're already joined.
  • :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 dm set — mark the currently focused room as a direct message.
  • :room dm unset — mark the currently focused room as a normal room.
  • :room notify set [level] — 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 (iykyk, they're twins).
  • :room notify unset — unset any room-level notification configuration.
  • :room notify show — show the current room-level notification configuration. If the room is using the account-level default, then this will print default.
  • :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.
  • :room topic show — show the topic of the currently focused room.
  • :room alias set [alias] — create and point the given alias to the room.
  • :room alias unset [alias] — delete the provided alias from the room's alternative alias list.
  • :room alias show — show alternative aliases to the room, if any are set.
  • :room id show — show the Matrix identifier for the room.
  • :room canon set [alias] — set the room's canonical alias to the one provided, and make the previous one an alternative alias.
  • :room canon unset [alias] — delete the room's canonical alias.
  • :room canon show — show the room's canonical alias, if any is set.
  • :room ban [user] [reason] — ban a user from this room with an optional reason.
  • :room unban [user] [reason] — unban a user from this room with an optional reason.
  • :room kick [user] [reason] — kick a user from this room with an optional reason.

🪐 SPACE COMMANDS 🪐

  • :space child set [room_id] [arguments] — add a room to the currently focused space. ++suggested marks the room as a suggested child. ++order=[string] specifies a string by which children are lexicographically ordered.
  • :space child remove — remove the selected room from the currently focused space.

🪟 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.

💬 SLASH COMMANDS 💬

  • /markdown, /md — interpret the message body as Markdown markup. This is the default behaviour, so it's basically the main character ✨
  • /html, /h — send the message body as literal HTML.
  • /plaintext, /plain, /p — do not interpret any markup in the message body and send it as it is.
  • /me — send an emote message.
  • /confetti — produces no effect in iamb, but will display confetti in Matrix clients that support doing so. 🎉
  • /fireworks — produces no effect in iamb, but will display fireworks in Matrix clients that support doing so.
  • /hearts — produces no effect in iamb, but will display floating hearts in Matrix clients that support doing so. 💖
  • /rainfall — produces no effect in iamb, but will display rainfall in Matrix clients that support doing so.
  • /snowfall — produces no effect in iamb, but will display snowfall in Matrix clients that support doing so. 🌨️
  • /spaceinvaders — 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

So you wanna start with a profile named personal instead of whatever default_profile is set to? Say less:

$ iamb -P personal

Example 2: Using an alternate configuration directory

By default, iamb will use the XDG directories — but sometimes you wanna store your configuration somewhere else entirely, and that's valid:

$ 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 — do it, the maintainers wanna know, fr fr 🙏

👀 SEE ALSO 👀

Extended documentation is available online at https://iamb.chat — go read it, it's giving study date 📚

ngl this page is from the Debian packaging, dated Mar 24, 2024, section 1 of the General Commands Manual. mwah, go forth and chat 💅💖✨
📦 where this page comes from