2026-01-12 10:03:13 -05:00
<!-- This file is generated by `cargo xtask generate-docs` . Do not edit. -->
2026-01-09 17:05:34 -05:00
# `!admin rooms`
2026-01-12 10:47:19 -05:00
Commands for managing rooms
2026-01-09 17:05:34 -05:00
## `!admin rooms list-rooms`
2026-01-12 10:47:19 -05:00
List all rooms the server knows about
2026-01-09 17:05:34 -05:00
## `!admin rooms info`
2026-01-12 10:47:19 -05:00
View information about a room we know about
2026-01-09 17:05:34 -05:00
### `!admin rooms info list-joined-members`
2026-01-12 10:47:19 -05:00
List joined members in a room
2026-01-09 17:05:34 -05:00
### `!admin rooms info view-room-topic`
2026-01-12 10:47:19 -05:00
Displays room topic
2026-01-09 17:05:34 -05:00
Room topics can be huge, so this is in its own separate command
## `!admin rooms moderation`
2026-01-12 10:47:19 -05:00
Manage moderation of remote or local rooms
2026-01-09 17:05:34 -05:00
### `!admin rooms moderation ban-room`
2026-01-12 10:47:19 -05:00
Bans a room from local users joining and evicts all our local users (including server admins) from the room. Also blocks any invites (local and remote) for the banned room, and disables federation entirely with it
2026-01-09 17:05:34 -05:00
### `!admin rooms moderation ban-list-of-rooms`
2026-01-12 10:47:19 -05:00
Bans a list of rooms (room IDs and room aliases) from a newline delimited codeblock similar to `user deactivate-all` . Applies the same steps as ban-room
2026-01-09 17:05:34 -05:00
### `!admin rooms moderation unban-room`
2026-01-12 10:47:19 -05:00
Unbans a room to allow local users to join again
2026-01-09 17:05:34 -05:00
### `!admin rooms moderation list-banned-rooms`
2026-01-12 10:47:19 -05:00
List of all rooms we have banned
2026-01-09 17:05:34 -05:00
## `!admin rooms alias`
2026-01-12 10:47:19 -05:00
Manage rooms' aliases
2026-01-09 17:05:34 -05:00
### `!admin rooms alias set`
2026-01-12 10:47:19 -05:00
Make an alias point to a room
2026-01-09 17:05:34 -05:00
### `!admin rooms alias remove`
2026-01-12 10:47:19 -05:00
Remove a local alias
2026-01-09 17:05:34 -05:00
### `!admin rooms alias which`
2026-01-12 10:47:19 -05:00
Show which room is using an alias
2026-01-09 17:05:34 -05:00
### `!admin rooms alias list`
2026-01-12 10:47:19 -05:00
List aliases currently being used
2026-01-09 17:05:34 -05:00
## `!admin rooms directory`
2026-01-12 10:47:19 -05:00
Manage the room directory
2026-01-09 17:05:34 -05:00
### `!admin rooms directory publish`
2026-01-12 10:47:19 -05:00
Publish a room to the room directory
2026-01-09 17:05:34 -05:00
### `!admin rooms directory unpublish`
2026-01-12 10:47:19 -05:00
Unpublish a room to the room directory
2026-01-09 17:05:34 -05:00
### `!admin rooms directory list`
2026-01-12 10:47:19 -05:00
List rooms that are published
2026-01-09 17:05:34 -05:00
## `!admin rooms exists`
2026-01-12 10:47:19 -05:00
Check if we know about a room