Documentation menu

Docs/Plugins/Admin

Admin

Role management, persistence, join roles, welcomes, and moderator utilities.

The admin plugin covers "managing members and roles" - everything from !role add to persisting a member's roles across a rejoin.

plugins:
  admin:
    persist:
      roles: true
      nickname: true
      voice: true

Highlights

  • Persistence - put a member's roles, nickname, and voice state back when they rejoin. This is what makes mute roles rejoin-proof.
  • Join roles - onjoin_roles grants roles automatically on join, with an optional onjoin_role_delay so lurker bots that leave instantly never get them.
  • Role aliases - role_aliases gives friendly names to roles for the role commands.
  • Locked roles - locked_roles can never be granted through the bot, as a safety rail.
  • Welcomes - welcomes posts configurable welcome messages.
  • Archives - purge-style commands produce a web archive of the removed messages; archives expire automatically after 7 days. clean and nuke archive what they delete and reply with the link, so a purge is never unreviewable.
  • Big-red-button safety - nuke, role spray, role nuke, and noroles purge all show how many messages or members they are about to touch and wait for a button confirmation. A running nuke can be stopped mid-run with nuke cancel, and a running role op with role cancel.
  • Nuke cleans out the channel - a bare !nuke deletes everything it can reach, up to 10,000 messages per run; run it again for the next 10,000. Pass a number to delete fewer. Discord only allows bulk deletion of messages younger than 14 days, so older history stays.
  • Targeted sprays - role spray <role> [target-role] can hand a role to just the members of another role instead of the whole server.
  • Role announcements - give a role an announce_channel plus announce_add_msg / announce_rmv_msg and the bot posts there whenever a member gains or loses it.
  • Targeted persistence - persist.role_ids restores only the roles you list instead of everything a member had, which is the usual way to make persistence safe on a big server.

Commands

Command What it does
/blacklist add Blacklist a user from using the bot in this server (full ignore).
/blacklist remove Remove a user from the bot blacklist.
/blacklist list List blacklisted users.
/archive here Archive the most recent N messages in this channel for later replay.
/archive all Archive every message in this channel up to N entries.
/archive user Archive a single user's recent messages in this channel.
/archive channel Archive recent messages in a different channel.
/clean all Bulk-delete the most recent N messages in this channel.
/clean bots Bulk-delete the most recent N bot-author messages in this channel.
/clean user Bulk-delete a specific user's most recent N messages in this channel.
/nick change Set a user's nickname.
/nick remove Clear a user's nickname back to their username.
/noroles show Show members with zero roles.
/noroles purge Kick every member with zero roles (admin).
/nuke Clean out THIS channel - everything, up to 10,000 messages per run (bare form).
/nuke here Clean out THIS channel - everything, up to 10,000 messages per run.
/nuke channel Clean out a different channel (up to 10,000 messages per run).
/nuke cancel Cancel an in-flight nuke (admin).
/invites prune Delete invites with at most N uses created over an hour ago.
/reactions clean Strip a user's reactions off recent messages in this channel.
/role add Grant a role to a user.
/role remove Revoke a role from a user.
/role list List members who currently have a role.
/role spray Bulk-add a role to every member in the guild (admin).
/role nuke Bulk-remove a role from every member who has it (admin).
/role cancel Cancel a running role spray/nuke.
/roles List roles whose names match a search pattern.
/roleinfo Show a role's id, color, position, and member count.
/cease Lock send-messages for @everyone in this channel (or cease guild to lock the whole guild).
/uncease Undo a cease.
/shut Revoke SPEAK + USE_VAD on your current voice channel.
/unshut Undo a shut.
/mention Temporarily flip a role mentionable, ping it with a message, flip it back.
/mention here Ping an unmentionable role in this channel (explicit form of mention).
/mention channel Ping an unmentionable role in another channel.
/mention enable Set a role permanently mentionable.
/mention disable Set a role permanently unmentionable.
/slowmode Set this channel's slowmode cooldown.
/slowmode here Set slowmode here (alias for slowmode).
/slowmode channel Set slowmode on a different channel.
/stats Show a user's message stats.
/v-log Voice-activity log for a user (joins/leaves/duration).
/v-snap Live roll call of everyone in your current voice channel.
/webconfig show Dump (or slice) the guild's web-access config block (admin).