-
Notifications
You must be signed in to change notification settings - Fork 61
Admin Room Commands overview
Peter Gervai edited this page Nov 18, 2025
·
3 revisions
Just the collection of the main admin commands.
appservices - Commands for managing appservices
users - Commands for managing local users
rooms - Commands for managing rooms
federation - Commands for managing federation
server - Commands for managing the server
media - Commands for managing media
check - Commands for checking integrity
debug - Commands for debugging things
query - Low-level queries for database getters and iterators
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
register - Register an appservice using its registration YAML
unregister - Unregister an appservice using its ID
show-appservice-config - Show an appservice's config using its ID
list-registered - List all the currently registered appservices
create-user - Create a new user
reset-password - Reset user password
deactivate - Deactivate a user
deactivate-all - Deactivate a list of users
list-users - List local users in the database
list-joined-rooms - Lists all the rooms (local and remote) that the specified user is joined in
force-join-room - Manually join a local user to a room
force-leave-room - Manually leave a local user from a room
force-demote - Forces the specified user to drop their power levels to the room default, if their permissions allow and the auth check permits
make-user-admin - Grant server-admin privileges to a user
put-room-tag - Puts a room tag for the specified user and room ID
delete-room-tag - Deletes the room tag for the specified user and room ID
get-room-tags - Gets all the room tags for the specified user and room ID
redact-event - Attempts to forcefully redact the specified event ID from the sender user
force-join-list-of-local-users - Force joins a specified list of local users to join the specified room
force-join-all-local-users - Force joins all local users to the specified room
list-rooms - List all rooms the server knows about
info - View information about a room we know about
moderation - Manage moderation of remote or local rooms
alias - Manage rooms' aliases
directory - Manage the room directory
exists - Check if we know about a room
incoming-federation - List all rooms we are currently handling an incoming pdu from
disable-room - Disables incoming federation handling for a room
enable-room - Enables incoming federation handling for a room again
fetch-support-well-known - Fetch `/.well-known/matrix/support` from the specified server
remote-user-in-rooms - Lists all the rooms we share/track with the specified *remote* user
show-config - Show configuration values
reload-config - Reload configuration values
list-features - List the features built into the server
memory-usage - Print database memory usage statistics
clear-caches - Clears all of Tuwunel's caches
backup-database - Performs an online backup of the database (only available for RocksDB at the moment)
list-backups - List database backups
admin-notice - Send a message to the admin room
reload-mods - Hot-reload the server
restart - Restart the server
shutdown - Shutdown the server
delete - Deletes a single media file from our database and on the filesystem via a single MXC URL or event ID (not redacted)
delete-list - Deletes a codeblock list of MXC URLs from our database and on the filesystem. This will always ignore errors
delete-past-remote-media - Deletes all remote (and optionally local) media created before or after [duration] time using filesystem metadata first created at date, or fallback to last modified date. This will always ignore errors by default
delete-all-from-user - Deletes all the local media from a local user on our server. This will always ignore errors by default
delete-all-from-server - Deletes all remote media from the specified remote server. This will always ignore errors by default
get-file-info
get-remote-file
get-remote-thumbnail
check-all-users
echo - Echo input of admin command
get-auth-chain - Get the auth_chain of a PDU
parse-pdu - Parse and print a PDU from a JSON
get-pdu - Retrieve and print a PDU by EventID from the tuwunel database
get-short-pdu - Retrieve and print a PDU by PduId from the tuwunel database
get-remote-pdu - Attempts to retrieve a PDU from a remote server. Inserts it into our database/timeline if found and we do not have this PDU already (following normal event auth rules, handles it as an incoming PDU)
get-remote-pdu-list - Same as `get-remote-pdu` but accepts a codeblock newline delimited list of PDUs and a single server to fetch from
get-room-state - Gets all the room state events for the specified room
get-signing-keys - Get and display signing keys from local cache or remote server
get-verify-keys - Get and display signing keys from local cache or remote server
ping - Sends a federation request to the remote server's `/_matrix/federation/v1/version` endpoint and measures the latency it took for the server to respond
force-device-list-updates - Forces device lists for all local and remote users to be updated (as having new keys available)
change-log-level - Change tracing log level/filter on the fly
sign-json - Verify json signatures
verify-json - Verify json signatures
verify-pdu - Verify PDU
first-pdu-in-room - Prints the very first PDU in the specified room (typically m.room.create)
latest-pdu-in-room - Prints the latest ("last") PDU in the specified room (typically a message)
force-set-room-state-from-server - Forcefully replaces the room state of our local copy of the specified room, with the copy (auth chain and room state events) the specified remote server says
resolve-true-destination - Runs a server name through tuwunel's true destination resolution process
memory-stats - Print extended memory usage
runtime-metrics - Print general tokio runtime metric totals
runtime-interval - Print detailed tokio runtime metrics accumulated since last command invocation
time - Print the current time
list-dependencies - List dependencies
database-stats - Get database statistics
trim-memory - Trim memory usage
database-files - List database files
create-jwt - Create a JWT token for login
account-data - account_data.rs iterators and getters
appservice - appservice.rs iterators and getters
presence - presence.rs iterators and getters
room-alias - rooms/alias.rs iterators and getters
room-state-cache - rooms/state_cache iterators and getters
room-timeline - rooms/timeline iterators and getters
globals - globals.rs iterators and getters
sending - sending.rs iterators and getters
users - users.rs iterators and getters
resolver - resolver service
pusher - pusher service
short - short service
raw - raw service
!admin query raw compact
Options:
-m, --map <MAP>
--start <START>
--stop <STOP>
--from <FROM>
--into <INTO>
--parallelism <PARALLELISM> There is one compaction job per column; then this controls how many columns are compacted in parallel. If zero, one compaction job is still run at a time here, but in exclusive-mode blocking any other automatic compaction jobs until complete
--exhaustive
!admin query raw compact ...
-
!admin query room-timeline pdus --limit 1 #tuwunel:grin.hu 0- where 0 is the sequence number of the event, and for backfilled events it's negative