Skip to content

Core Commands

The core_commands plugin provides essential bot lifecycle management, help system, alias registration, and command history. These commands are always loaded and form the backbone of bot administration.

Command Description Roles Aliases
stopplugin <name> Stop a running plugin admin —
startplugin <name> Start a stopped plugin admin —
restartplugin <name> Restart a plugin admin —
restartplugins Restart all plugins admin —
plugins Display all loaded plugins moderator —
sleep <seconds> Sleep the command thread user —
version Show bot version user —
uptime Show bot uptime user —
exit Shut down the bot admin quit
restart Restart the bot admin —
saferestart Restart in safe mode admin —
setcomment <text> Set the bot’s user comment admin —
resetcomment Reset the bot’s user comment admin —
pguistresstest [lines] PGUI stress test admin —
help [plugin] List plugins, or list a plugin’s commands user —
refreshaliases Refresh aliases (auto-persisted, rarely needed) admin —
setalias <name> <command> Register an alias admin —
aliases List registered aliases user —
removealias <name> Remove an alias admin —
clearaliases Clear all aliases admin —
clearhistory Clear command history moderator —
history Show command history moderator —
  • Plugin management: stopplugin, startplugin, and restartplugin operate on individual plugins by name. restartplugins restarts all controllable plugins at once (non-controllable plugins are skipped and the skip count is reported). plugins lists all loaded plugins and their running state (available to moderators).
  • Stopped plugins refuse commands: When a plugin is stopped, the command router blocks dispatch of any of its commands and sends a GUI error telling the caller to use !startplugin to resume it.
  • Controllable plugins: Plugins declare controllable = true|false in their plugin.toml [plugin] section. Non-controllable plugins (like core_commands and bot_commands) cannot be stopped, started, or restarted via chat commands — this prevents bricking chat-based management by stopping the plugin that provides those very commands.
  • Lifecycle: exit shuts down the bot gracefully. restart restarts it normally. saferestart restarts with only the plugins listed in safe_mode_plugins from the config.
  • Help: help with no arguments lists all loaded plugins. help <plugin> lists all commands registered by that plugin.
  • Aliases: Aliases are automatically persisted to the database. refreshaliases forces a reload from the database and is rarely needed.
  • History: history displays recent command usage. clearhistory wipes the history buffer. Both are gated to moderator.
  • Roles: admin commands require the admin role. moderator commands require moderator or higher. Commands with no role restriction are available to all non-blacklisted users.