1NHEKO(1) General Commands Manual NHEKO(1)
2
6 nheko - Desktop client for Matrix using Qt and C++17
7
9 nheko [OPTIONS]
10
12 The motivation behind the project is to provide a native desktop app
13 for Matrix that feels more like a mainstream chat app (Element,
14 Telegram etc) and less like an IRC client.
15
17 -h, --help
18 Displays help on commandline options.
19 --help-all
21 Displays help including Qt specific options.
22 -v, --version
24 Displays version information.
25 --debug
27 Alias for --log-level trace.
28 -l, --log-level <level>
30 Set the global log level, or a comma-separated list of
31 <component>=<level> pairs, or both. For example, to set the default
32 log level to warn but disable logging for the ui component, pass
33 warn,ui=off.
34 levels: trace debug info warning error critical off
36 components: crypto db mtx net qml ui
38 Log levels can also be set in the NHEKO_LOG_LEVEL environment
40 variable, using the same syntax. It will be overridden by this
41 command line option.
42 -L, --log-type <type>
44 Set the log output type. A comma-separated list is allowed. The
45 default is file,stderr.
46 types: file stderr none
48 The log type can also be set in the NHEKO_LOG_TYPE environment
50 variable, which will be overridden by this command line option.
51 -p <profile>, --profile <profile>
53 Creates a unique profile, which allows you to log into several
54 accounts at the same time and start multiple instances of nheko.
55 Use default to start with the default profile.
56
58 How do I add stickers and custom emojis?
59 Stickers and custom emojis are organized in image packs. There is one
60 user image pack that only your account has access to and there are room
61 image packs that are accessible by everyone in the room they are
62 defined in. You can activate a room image pack globally to use it in
63 any room.
64 To manage image packs in nheko, go to the room settings and enter the
66 Sticker & Emote Settings. You will see the Private pack (your user
67 image pack) and can edit it there. The Shortcode is a unique identifier
68 you use to select the image with and the Body is the alternate text
69 that is displayed on clients that don’t support images (like the alt
70 tag in HTML images).
71 If you have the necessary permissions you can create new room packs
73 with the button at the bottom of the image pack list. They are the same
74 as the user pack but you can create as many as you want and everyone in
75 the room can use them. It might be a good idea to create an extra room
76 just for your image packs to make sharing easier.
77
79 Completers spawn a popup with completion candidates when you type them
80 in the input line.
81 @
83 Open username completer.
84 #
86 Open room completer.
87 :
89 Open unicode emoji picker.
90 ~
92 Open custom emoji picker. Requires an image pack with custom
93 emojis. Selecting an emoji will add HTML code for the inline image
94 into the input line.
95
97 Room list
98 Ctrl-Up/Ctrl-Down
99 Navigate within the room list.
100 Ctrl-W
102 Close the currently open room.
103 Ctrl-K
105 Search and select rooms from the room list.
106 Alt-A, Ctrl-Shift-A
108 Select next room with activity.
109 Timeline/Messaging
111 PgUp/PgDn
112 Scroll timeline per page.
113 Alt-Up/Alt-Down
115 Reply to a message.
116 Up/Down
118 Edit a message.
119 Ctrl-E
121 Edit message currently selected as reply.
122 Alt-F
124 Forward message currently selected as reply.
125 Ctrl-P/Ctrl-N
127 Reenter previous/next message.
128 Ctrl-U
130 Delete everything in the input line.
131 Ctrl-Left/Ctrl-Right
133 Jump one word left/right in the input line.
134 Shift-Enter
136 Insert line break.
137 Enter
139 Submit message.
140
142 Commands only work when they are used at the beginning of text.
143 Custom messages
145 /me <message>
146 Send a message as an emote, where your username is prefixed.
147 /react <text>
149 Send a message as a reaction when you’re replying to a message.
150 /md <message>
152 Force Markdown when sending the current message.
153 /cmark <message>
155 Disables most of our extensions to cmark (CommonMark), including
156 the newline-in-input = newline-in-output behaviour, strikethrough
157 and spoilers. You may still force newlines with 2 spaces or a
158 backslash before the line ending or insert HTML elements.
159 /plain <message>
161 Force plain text when sending the current message.
162 /rainbow <message>
164 Send a message in rainbow colors.
165 /rainbowme <message>
167 Send a message as a rainbow-colored emote, where your username is
168 prefixed.
169 /notice <message>
171 Send a message as a notice.
172 /rainbownotice <notice>
174 Send a message as a rainbow-colored notice.
175 Room management
177 /join <roomname> [reason]
178 Join a room. reason is optional.
179 /knock <roomname> [reason]
181 Ask to join a room. reason is optional.
182 /part, /leave [reason]
184 Leave the current room. reason is optional.
185 /invite <username> [reason]
187 Invite a user into the current room. reason is optional.
188 /kick <username> [reason]
190 Kick a user from the current room. reason is optional.
191 /ban <username> [reason]
193 Ban a user from the current room. reason is optional.
194 /unban <username> [reason]
196 Unban a user. reason is optional.
197 /redact <username> [reason]
199 Redacts all visible messages of the specified user. You will run
200 into rate limits quickly.
201 /redact <eventid> [reason]
203 Redacts a specific event.
204 /roomnick <roomname>
206 Change your nickname in a single room.
207 Emoticons
209 /shrug [message]
210 Inserts ¯\_(ツ)_/¯ followed by an optional message.
211 /fliptable
213 Inserts (╯°□°)╯︵ ┻━┻
214 /unfliptable
216 Inserts ┯━┯╭( º _ º╭)
217 /sovietflip
219 Inserts ノ┬─┬ノ ︵ ( \\o°o)\\
220 Advanced
222 /clear-timeline
223 Removes all but the most recent messages from the currently
224 rendered timeline and then refetches it from the server; can be
225 used to fix some cache issues.
226 /reset-state
228 Fetches all the state events in the current room again; can be used
229 to fix some cache issues.
230 /rotate-megolm-session
232 Rotates the encryption key used to send encrypted messages in a
233 room.
234 /goto <address>
236 address can be one of:
237 <event ID>
239 Jumps to event with the specified ID and highlights it.
240 <message index>
242 Jumps to the message with the specified index and highlights
243 it.
244 <Matrix URI>
246 Handles Matrix URI as if you clicked on it.
247 /converttodm
249 Converts a room to a direct conversation.
250 /converttoroom
252 Converts a direct conversation to a normal room.
253
255 newline (\n)
256 A single newline will be turned into <br> instead of a space.
257 ~text~
259 Make text strikethrough. HTML putput: <del>text</del>
260 ||spoiler warning|text||
262 Hide text and set an optional spoiler warning. Note that Nheko does
263 not display the spoiler warning currently. HTML output: <span
264 data-mx-spoiler="spoiler">text</span>
265
267 Configuration file
268 ${XDG_CONFIG_HOME:-~/.config}/nheko/nheko.conf
269 Log file
271 ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/nheko.log
272 Database
274 ${XDG_DATA_HOME:-~/.local/share}/nheko/nheko/*/data.mdb
275 Media cache
277 ${XDG_CACHE_HOME:-~/.cache}/nheko/nheko/media_cache
278
280 Please report issues on our bug tracker at
281 https://github.com/Nheko-Reborn/nheko/issues.
282nheko 0.11.3 2022-01-27 NHEKO(1)