Main Command¶
synadm¶
the Matrix-Synapse admin CLI
synadm [OPTIONS] COMMAND [ARGS]...
Options
-
-v
,
--verbose
¶
enable INFO (-v) or DEBUG (-vv) logging on console
-
--batch
,
--no-batch
¶
enable batch behavior (no interactive prompts)
-
-o
,
--output
<output>
¶ override default output format.
- Options
yaml | json | human | pprint | y | j | h | p |
-
-c
,
--config-file
<config_file>
¶ configuration file path
- Default
~/.config/synadm.yaml
Commands
-
config
Modify synadm’s configuration.
-
group
Manage groups (communities)
-
history
purge historic events from Synapse database
-
matrix
Execute Matrix API calls.
-
media
Manage local and remote media
-
regtok
Manage registration tokens
-
room
Manipulate rooms and room membership
-
user
list, add, modify, deactivate/erase users,…
-
version
Get the synapse server version