Skip to content

Error Codes & CLI Reference ​

Exit Codes ​

CodeMeaningWhen
0SuccessNormal exit
1Runtime errorStartup failure, config error
2Database errorPostgreSQL init failure
3Config validation errorInvalid server_config.yml
101PanicUnrecoverable internal error

CLI Command Reference ​

Core Commands ​

CommandDescription
help [cmd]Show help for command or group
exitShut down server
statusShow server version, port, room count
check-configValidate loaded config with redacted output
doctorRun system diagnostics (DB/rooms/sessions)

Room Management ​

CommandDescription
room listList active rooms
room info <id>Show room details
room close <id>Force-close a room
room kick <id> <user>Kick user from room
room lock <id>Lock/unlock room
room cycle <id>Toggle auto-cycle

Plugin Management ​

CommandDescription
plugin listList loaded plugins
plugin info <name>Show plugin metadata
plugin enable <name>Enable a disabled plugin
plugin disable <name>Disable a plugin
plugin reload [name]Reload all or specific plugin
plugin remove <name>Unregister plugin (keep files)
plugin purge <name>Delete plugin files + data

Runtime Diagnostics ​

CommandDescription
runtime statusRuntime diagnostics summary
runtime eventsEventBus stats
runtime persistenceWAL + DB stats
runtime commandsCommand registry stats

Operations ​

CommandDescription
wal inspectWAL path and size
dead-letter list [n]Show recent dead-letter entries
dead-letter replayRe-queue dead-letter events
backup create [path]Archive config + data + WAL
restore verify <path>Verify backup integrity
config reloadHot-reload YAML config

Security ​

CommandDescription
ban <user_id> <reason>Ban a user
unban <user_id>Unban a user
banlistList banned users

Error Message Format ​

  ✗ <error description>
  ◆ <info message>
  ✓ <success message>
  ○ <neutral/status message>

Last modified byFireflyF09on2026-08-04 22:44

Built with VitePress