NHEKO(1)

🌸 NAME 🌸

hey bestie, welcome to NHEKO(1), straight out of the General Commands Manual 💖

nheko — Desktop client for Matrix using Qt and C++17 ✨

---

🎀 SYNOPSIS 🎀

nheko [OPTIONS]

---

💅 DESCRIPTION 💅

okay so the whole motivation behind this project? it's to give you a native desktop app for Matrix that feels more like a mainstream chat app (Element, Telegram etc) and less like an IRC client. periodt. 🦋

---

✨ OPTIONS ✨

• -h, --help — shows you the help for the commandline options 🫶
• --help-all — same vibe but it also includes the Qt specific options 💜
• -v, --version — spills the version info 👑
• --debug — literally just an alias for --log-level trace 🙈
• -l, --log-level <level> — sets the global log level, or a comma-separated list of <component>=<level> pairs, or both. for example, if you wanna set the default log level to warn but turn logging off for the ui component, you pass warn,ui=off.
  • levels: trace debug info warning error critical off
  • components: crypto db mtx net qml ui
  • you can also set log levels in the NHEKO_LOG_LEVEL environment variable, same syntax, no cap. but this command line option overrides it. 💀
• -L, --log-type <type> — sets the log output type. a comma-separated list is allowed, she's flexible like that. the default is file,stderr.
  • types: file stderr none
  • the log type can also live in the NHEKO_LOG_TYPE environment variable, and again this command line option overrides it.
• -p <profile>, --profile <profile> — makes a unique profile, which lets you log into several accounts at the same time and start multiple instances of nheko. use default to start with the default profile 🌈
• -C, --compact — lets the database shrink, because LMDB databases don't automatically shrink when data is deleted (rude of them honestly). it might also possibly allow some recovery on database corruption 🤞

---

🧚 FAQ 🧚

How do I add stickers and custom emojis?

okay so stickers and custom emojis are organized in image packs 📦 there's one user image pack that only your account has access to, and there are room image packs that everyone in the room they're defined in can access. and get this — you can activate a room image pack globally to use it in any room. slay.

to manage image packs in nheko, go to the room settings and enter the Sticker & Emote Settings. you'll see the Private pack (that's your user image pack) and you can edit it right there. the Shortcode is the unique identifier you use to select the image with, and the Body is the alternate text that shows up on clients that don't support images (like the alt tag in HTML images, iykyk).

if you have the necessary permissions you can create new room packs with the button at the bottom of the image pack list 💅 they're the same as the user pack except you can create as many as you want and everyone in the room can use them. pro tip from the manpage itself: it might be a good idea to create an extra room just for your image packs to make sharing easier 🎀

---

🦋 COMPLETERS 🦋

completers spawn a popup with completion candidates when you type them in the input line. it's giving autocomplete but make it cute ✨

• @ — opens the username completer 💜
• # — opens the room completer 🏠
• : — opens the emoji picker. Unicode emoji get inserted directly. Custom emoji will insert the HTML code for them into the input line. you can configure custom emoji in the room settings 🍓

---

💖 KEYBOARD SHORTCUTS 💖

Room list

• Ctrl-Up/Ctrl-Down — navigate within the room list 🧭
• Ctrl-W — close the currently open room 🚪
• Ctrl-K — search and select rooms from the room list 🔍
• Alt-A, Ctrl-Shift-A — select the next room with activity 🔥

Timeline/Messaging

• PgUp/PgDn — scroll the timeline per page 📜
• Alt-Up/Alt-Down — reply to a message 💬
• Up/Down — edit a message ✏️
• Ctrl-E — edit the message currently selected as reply
• Alt-F — forward the message currently selected as reply
• Ctrl-P/Ctrl-N — reenter previous/next message ⏮️⏭️
• Ctrl-U — delete everything in the input line 🧹
• Ctrl-Left/Ctrl-Right — jump one word left/right in the input line
• Shift-Enter — insert a line break
• Enter — submit the message 🚀

---

👑 COMMANDS 👑

commands only work when they're used at the beginning of text. no sneaking them in mid-sentence bestie.

Custom messages

• /me <message> — send a message as an emote, where your username is prefixed 💃
• /react <text> — send a message as a reaction when you're replying to a message
• /md <message> — force Markdown when sending the current message
• /cmark <message> — disables most of our extensions to cmark (CommonMark), including the newline-in-input = newline-in-output behaviour, strikethrough and spoilers. you may still force newlines with 2 spaces or a backslash before the line ending, or insert HTML elements 🧐
• /plain <message> — force plain text when sending the current message
• /rainbow <message> — send a message in rainbow colors 🌈
• /rainbowme <message> — send a message as a rainbow-colored emote, where your username is prefixed 🌈💃
• /notice <message> — send a message as a notice 📢
• /rainbownotice <notice> — send a message as a rainbow-colored notice 🌈📢

Room management

• /join <roomname> [reason] — join a room. reason is optional 🚪✨
• /knock <roomname> [reason] — ask to join a room. reason is optional 🚪👀
• /part, /leave [reason] — leave the current room. reason is optional 👋
• /invite <username> [reason] — invite a user into the current room. reason is optional 💌
• /kick <username> [reason] — kick a user from the current room. reason is optional. you can alternatively kick the user you're replying to by leaving out the username 🥾
• /ban <username> [reason] — ban a user from the current room. reason is optional. you can alternatively ban the user you're replying to by leaving out the username ⛔
• /unban <username> [reason] — unban a user. reason is optional. you can alternatively unban the user you're replying to by leaving out the username 🔓
• /redact <username> [reason] — redacts all visible messages of the specified user. heads up: you will run into rate limits quickly 💀
• /redact <eventid> [reason] — redacts a specific event. you can alternatively redact the event you're replying to by specifying neither an eventid nor username
• /roomnick <roomname> — change your nickname in a single room 📛
• /glitch <message> — applies a glitch effect to the given message. beware that this will break mentions, HTML, and some Markdown in your message 😭
• /gradualglitch <message> — applies a progressively more severe glitch effect to the message. again, this will break mentions, HTML, and some Markdown 🌀

Emoticons

• /shrug [message] — inserts ¯\_(ツ)_/¯ followed by an optional message 🤷
• /fliptable — inserts (╯°□°)╯︵ ┻━┻ 😤
• /unfliptable — inserts ┯━┯╭( º _ º╭) 🥺
• /sovietflip — inserts ノ┬─┬ノ ︵ ( \\o°o)\\ ☭

User management

• /ignore <username> — ignore a user, invites from them are also rejected 🙅
• /unignore <username> — stops ignoring a user 🫶

Invite permission management

• /blockinvites <username>|<roomid>|<servername>|all — block all invites either by default ("all") or from a specific user or server or to a specific room 🚫
• /allowinvites <username>|<roomid>|<servername>|all — allow all invites either by default ("all") or from a specific user or server or to a specific room ✅

Advanced

• /clear-timeline — removes all but the most recent messages from the currently rendered timeline and then refetches it from the server; can be used to fix some cache issues 🧼
• /reset-state — fetches all the state events in the current room again; can be used to fix some cache issues 🔄
• /rotate-megolm-session — rotates the encryption key used to send encrypted messages in a room 🔐
• /goto <address> — address can be one of:
  • <event ID> — jumps to the event with the specified ID and highlights it ✨
  • <message index> — jumps to the message with the specified index and highlights it ✨
  • <Matrix URI> — handles Matrix URI as if you clicked on it 🖱️
• /converttodm — converts a room to a direct conversation 💞
• /converttoroom — converts a direct conversation to a normal room 🏠

---

🌈 MARKDOWN EXTENSIONS 🌈

• newline (\n) — a single newline will be turned into <br> instead of a space ↩️
• ~text~ — make text strikethrough. HTML putput: <del>text</del> ~~like this~~
• ||spoiler warning|text|| — hide text and set an optional spoiler warning. note that Nheko does not display the spoiler warning currently. HTML output: <span data-mx-spoiler="spoiler">text</span> 🙈

---

🍓 ENVIRONMENT 🍓

• NHEKO_ALLOW_QML_DISK_CACHE — Nheko by default disables the qml disk cache to prevent crashes. this allows you to reenable it at your own risk 💀

---

🎀 FILES 🎀

• Configuration file — ${XDG_CONFIG_HOME:-~/.config}/nheko/nheko.conf ⚙️
• Log file — ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/nheko.log 📝
• Database — ${XDG_DATA_HOME:-~/.local/share}/nheko/nheko/*/data.mdb 🗄️
• Media cache — ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/media_cache 🖼️

---

🫶 REPORTING BUGS 🫶

please report issues on our bug tracker at https://github.com/Nheko-Reborn/nheko/issues. we wanna hear it, fr fr 💜

---

and that's the whole page bestie ✨ this was nheko 0.12.1, dated 2022-01-27, and it lives in the NHEKO(1) manual. go forth and chat, you're the main character now 👑💖