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, --yes, --non-interactive, --scripting
Enable batch processing mode. Use with caution! This will:
- Disable all interactive prompts.- Disable automatic translation of unix timestamps to human readableformats.
- -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
- notice
Send messages to users with the help of…
- regtok
Manage registration tokens
- room
Manipulate rooms and room membership
- user
List, add, modify, deactivate/erase users,…
- version
Get the Synapse server version.