-
Notifications
You must be signed in to change notification settings - Fork 58
/
help.help.txt
210 lines (207 loc) · 7.21 KB
/
help.help.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
Welcome to matrix-commander, a Matrix CLI client.
matrix-commander supports these arguments:
--usage
Print usage.
-h, --help
Print help.
--manual
Print manual.
--readme
Print README.md file.
-d, --debug
Print debug information.
--log-level DEBUG|INFO|WARNING|ERROR|CRITICAL [DEBUG|INFO|WARNING|ERROR|CRITICAL
...]
Set the log level(s).
--verbose
Set the verbosity level.
--login PASSWORD|SSO
Login to and authenticate with the Matrix homeserver.
--verify [EMOJI]
Perform verification.
--logout ME|ALL
Logout.
-c CREDENTIALS_FILE, --credentials CREDENTIALS_FILE
Specify location of credentials file.
-s STORE_DIRECTORY, --store STORE_DIRECTORY
Specify location of store directory.
-r ROOM [ROOM ...], --room ROOM [ROOM ...]
Specify one or multiple rooms.
--room-default DEFAULT_ROOM
Specify the default room at --login.
--room-create ROOM_ALIAS [ROOM_ALIAS ...]
Create one or multiple rooms for given alias(es).
--room-dm-create USER [USER ...]
Create one or multiple DM rooms with the specified users.
--room-dm-create-allow-duplicates
Allow creating duplicate DM rooms.
--room-join ROOM [ROOM ...]
Join one room or multiple rooms.
--room-leave ROOM [ROOM ...]
Leave one room or multiple rooms.
--room-forget ROOM [ROOM ...]
Forget one room or multiple rooms.
--room-invite ROOM [ROOM ...]
Invite one ore more users to join one or more rooms.
--room-ban ROOM [ROOM ...]
Ban one ore more users from one or more rooms.
--room-unban ROOM [ROOM ...]
Unban one ore more users from one or more rooms.
--room-kick ROOM [ROOM ...]
Kick one ore more users from one or more rooms.
-u USER [USER ...], --user USER [USER ...]
Specify one or multiple users.
--user-login USER
Specify user for --login.
--name ROOM_NAME [ROOM_NAME ...]
Specify one or multiple room names.
--topic ROOM_TOPIC [ROOM_TOPIC ...]
Specify one or multiple room topics.
--alias ROOM_ALIAS [ROOM_ALIAS ...]
Specify one or multiple room aliases.
-m TEXT [TEXT ...], --message TEXT [TEXT ...]
Send one or multiple text messages.
-i IMAGE_FILE [IMAGE_FILE ...], --image IMAGE_FILE [IMAGE_FILE ...]
Send one or multiple image files.
-a AUDIO_FILE [AUDIO_FILE ...], --audio AUDIO_FILE [AUDIO_FILE ...]
Send one or multiple audio files.
-f FILE [FILE ...], --file FILE [FILE ...]
Send one or multiple files (e.g. PDF, DOC, MP4).
-e MATRIX_JSON_OBJECT [MATRIX_JSON_OBJECT ...], --event MATRIX_JSON_OBJECT
[MATRIX_JSON_OBJECT ...]
Send a Matrix JSON event.
-w, --html
Send message as format "HTML".
-z, --markdown
Send message as format "MARKDOWN".
-k, --code
Send message as format "CODE".
-j, --emojize
Send message after emojizing.
-p SEPARATOR, --split SEPARATOR
Split message text into multiple Matrix messages.
--config CONFIG_FILE
Specify the location of a config file.
--proxy PROXY
Specify a proxy for connectivity.
-n, --notice
Send message as notice.
--encrypted
Send message end-to-end encrypted.
-l [NEVER|ONCE|FOREVER|TAIL|ALL], --listen [NEVER|ONCE|FOREVER|TAIL|ALL]
Print received messages and listen to messages.
-t [NUMBER], --tail [NUMBER]
Print last messages.
-y, --listen-self
Print your own messages as well.
--print-event-id
Print event ids of received messages.
--download-media [DOWNLOAD_DIRECTORY]
Download media files while listening.
--download-media-name SOURCE|CLEAN|EVENTID|TIME
Specify the method to derive the media filename.
--os-notify
Notify me of arriving messages.
--set-device-name DEVICE_NAME
Set or rename the current device.
--set-display-name DISPLAY_NAME
Set or rename the display name.
--get-display-name
Get the display name of yourself.
--set-presence ONLINE|OFFLINE|UNAVAILABLE
Set your presence.
--get-presence
Get your presence.
--upload FILE [FILE ...]
Upload one or multiple files to the content repository.
--download MXC_URI [MXC_URI ...]
Download one or multiple files from the content repository.
--delete-mxc MXC_URI [MXC_URI ...]
Delete one or multiple objects from the content repository.
--delete-mxc-before TIMESTAMP [TIMESTAMP ...]
Delete old objects from the content repository
--joined-rooms
Print the list of joined rooms.
--joined-members ROOM [ROOM ...]
Print the list of joined members for one or multiple rooms.
--joined-dm-rooms USER [USER ...]
Print the list of joined DM rooms for one or multiple users.
--mxc-to-http MXC_URI [MXC_URI ...]
Convert MXC URIs to HTTP URLs.
--devices, --get-devices
Print the list of devices.
--discovery-info
Print discovery information about current homeserver.
--login-info
Print login methods supported by the homeserver.
--content-repository-config
Print the content repository configuration.
--rest REST_METHOD DATA URL [REST_METHOD DATA URL ...]
Use the Matrix Client REST API.
--set-avatar AVATAR_MXC_URI
Set your avatar.
--get-avatar [USER ...]
Get an avatar.
--get-profile [USER ...]
Get a user profile.
--get-room-info [ROOM ...]
Get the room information.
--get-client-info
Print client information.
--has-permission ROOM BAN|INVITE|KICK|NOTIFICATIONS|REDACT|etc [ROOM
BAN|INVITE|KICK|NOTIFICATIONS|REDACT|etc ...]
Inquire about permissions.
--import-keys FILE PASSPHRASE FILE PASSPHRASE
Import Megolm decryption keys from a file.
--export-keys FILE PASSPHRASE FILE PASSPHRASE
Export all the Megolm decryption keys of this device.
--room-set-alias ROOM_ALIAS ROOM [ROOM_ALIAS ROOM ...], --room-put-alias
ROOM_ALIAS ROOM [ROOM_ALIAS ROOM ...]
Add aliases to rooms.
--room-resolve-alias ROOM_ALIAS [ROOM_ALIAS ...]
Show room ids corresponding to room aliases.
--room-delete-alias ROOM_ALIAS [ROOM_ALIAS ...]
Delete one or multiple rooms aliases.
--get-openid-token [USER ...]
Get an OpenID token.
--room-get-visibility [ROOM ...]
Get the visibility of one or more rooms.
--room-get-state [ROOM ...]
Get the state of one or more rooms.
--delete-device DEVICE [DEVICE ...]
Delete one or multiple devices.
--room-redact ROOM_ID EVENT_ID REASON [ROOM_ID EVENT_ID REASON ...], --room-
delete-content ROOM_ID EVENT_ID REASON [ROOM_ID EVENT_ID REASON ...]
Strip information out of one or several events.
--whoami
Print your user id.
--no-ssl
Skip SSL verification.
--ssl-certificate SSL_CERTIFICATE_FILE
Use your own SSL certificate.
--file-name FILE [FILE ...]
Specify one or multiple file names for some actions.
--key-dict KEY_DICTIONARY [KEY_DICTIONARY ...]
Specify one or multiple key dictionaries for decryption.
--plain
Disable encryption for a specific action.
--separator SEPARATOR
Set a custom separator used for certain print outs.
--access-token ACCESS_TOKEN
Set a custom access token for use by certain actions.
--password PASSWORD
Specify a password for use by certain actions.
--homeserver HOMESERVER_URL
Specify a homeserver for use by certain actions.
--device DEVICE_NAME
Specify a device name, for use by certain actions.
--sync FULL|OFF
Choose synchronization options.
-o TEXT|JSON|JSON-MAX|JSON-SPEC, --output TEXT|JSON|JSON-MAX|JSON-SPEC
Select an output format.
--room-invites [LIST|JOIN|LIST+JOIN]
List room invitations and/or join invited rooms.
-v [PRINT|CHECK], -V [PRINT|CHECK], --version [PRINT|CHECK]
Print version information or check for updates.
You are running version 7.6.0 2023-10-16. Enjoy, star on Github and contribute
by submitting a Pull Request. Also have a look at matrix-commander-tui.