Main Command#
synadm#
the Matrix-Synapse admin CLI
synadm [OPTIONS] COMMAND [ARGS]...
Options
- --version#
Show the version and exit.
- -v, --verbose#
Enable INFO (-v) or DEBUG (-vv) logging on console.
- --no-confirm, --batch, --yes, --non-interactive, --scripting#
Enable non-interactive 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. The ‘human’ mode gives a tabular or list view depending on the fetched data, but often needs a lot of horizontal space to display correctly. ‘json’ returns formatted json. ‘minified’ is minified json, suitable for scripting purposes. ‘pprint’ shows a formatted output with the help of Python’s built-in pprint module. ‘yaml’ is a compromise between human- and machine-readable output, it doesn’t need as much terminal width as ‘human’ does and is the default on fresh installations.
- Options:
yaml | json | minified | human | pprint | y | j | m | 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.
- raw
Issue a custom request to the Synapse…
- regtok
Manage registration tokens.
- room
Manipulate rooms and room membership.
- user
List, add, modify, deactivate/erase users,…
- version
Get the Synapse server version.