Stoatmod / Documentation

Documentation & commands.

The settings, permissions, and commands behind your moderation setup.

Search commands

Start with a setup you understand.

Find the prerequisites, exact commands, and checks for each task. New to Stoatmod? The quickstart takes you through your first configuration.

Open the quickstart
  • 16 documentation pages
  • 50 command entries
  • Server-specific configuration

01 / DOCUMENTATION

Choose the task you need to complete

Find the prerequisites, commands and checks for your next task. These guides cover the hosted Stoatmod service.

16 of 16 documentation pages

01

Server applications

Reference for Stoatmod DM applications: form settings, visible channels, CAPTCHA checks, deadlines, review commands, roles and recovery.

Read guide 02

Stoatmod quickstart

Complete the first Stoatmod configuration, open the dashboard and verify a real moderation outcome after installation.

Read guide 03

Install Stoatmod

Invite the hosted Stoatmod bot, place its role correctly and prepare the server for its first configuration.

Read guide 04

Permissions and role hierarchy

Understand the 12 permissions Stoatmod audits and how Stoat role hierarchy affects moderation and automatic roles.

Read guide 05

Stoatmod command reference

Browse the supported Stoatmod member, moderation, automod, role, logging, appeal and Discovery commands.

Read guide 06

Configure automod and protection

Configure Stoatmod thresholds, categories, spam, links, images, join protection, nicknames and moderator exemptions.

Read guide 07

Warnings and moderation cases

Create, inspect and remove Stoatmod warnings and understand how cases interact with escalation and appeals.

Read guide 08

Mute, kick and ban actions

Use Stoatmod mute, unmute, kick and ban commands with permission, hierarchy and outcome-verification checks.

Read guide 09

Review and resolve appeals

Understand Stoatmod appeal eligibility, private member submissions, evidence and moderator accept or deny commands.

Read guide 10

Configure automatic roles

Add, list, test and remove Stoatmod automatic roles while respecting Assign Roles permission and role hierarchy.

Read guide 11

Logging, channels and exclusions

Choose a Stoatmod log channel and control which channels or categories are excluded from automatic moderation.

Read guide 12

Access and use the dashboard

Request a single-use Stoatmod dashboard code and understand server-owner, Manage Server and delegated access.

Read guide 13

List a server in Stoat Discovery

Meet Stoatmod Discovery eligibility, prepare a reviewed listing and use the two-hour bump after approval.

Read guide 14

Troubleshoot Stoatmod

Diagnose Stoatmod commands that do not respond, permission failures, role hierarchy and mismatched success records.

Read guide 15

Fix role hierarchy failures

Resolve Stoat role hierarchy problems that block moderation actions, nickname changes and automatic role assignment.

Read guide 16

Fix commands that do not respond

Check Stoatmod command syntax, channel visibility, service status and access when the bot does not respond.

Read guide

02 / PERMISSIONS

Required permissions

Run ~setup after installation and whenever the role or channel structure changes. The bot role must sit above every member it moderates and every role it assigns.

View ChannelsRead Message HistorySend MessagesSend EmbedsManage MessagesReactTimeout MembersKick MembersBan MembersAssign RolesManage RolesManage Nicknames
Read the complete permissions and hierarchy guide →

03 / COMMAND REFERENCE

Every public command

Copy server, channel, role, user and case IDs directly from Stoat. Toggle commands use enable, disable or status.

~help

Show the command guide.

~language English|French|Portuguese|Spanish

Choose the language used in bot responses.

~support

Show official support details.

~information

Show bot and server information; ~info is an alias.

~report

Open the private server-report workflow when reporting is enabled.

~global_report

Open a private global-safety report.

~setup

Audit permissions, role hierarchy, log access and dashboard readiness.

~dashboard

Request a single-use dashboard code when authorised.

~application [APPLICATION_ID]

Resume a server application in the bot DM or select one when several are open.

~approve USER_ID REASON

Approve a submitted member application inside its server; dashboard access is required.

~deny USER_ID REASON

Deny a submitted member application and kick with a reason; dashboard access is required.

~bump

Bump an eligible approved Discovery listing once every two hours.

~warnings USER_ID

List a member's active warnings.

~warn USER_ID REASON

Create a warning and apply the configured escalation policy.

~remove CASE_ID

Remove an eligible case from active warning counting.

~case CASE_ID

View one moderation case.

~cases USER_ID

List recent cases for a member.

~appeal CASE_ID accept REASON

Accept an eligible appeal and request reversal.

~appeal CASE_ID deny REASON

Deny an appeal and record the reason.

~mute USER_ID [DURATION] REASON

Mute with a reason; duration can come before or after it. Defaults to one hour.

~unmute USER_ID REASON

Remove a member's mute.

~kick USER_ID REASON

Kick a member and record the required reason.

~ban USER_ID REASON

Ban a member and record the required reason.

~unban USER_ID REASON

Remove a server ban and record the reason.

~policy show

Show the warning escalation policy.

~policy set TIMEOUT_COUNT KICK_COUNT BAN_COUNT

Set the legacy warning escalation counts.

~policy reset

Restore the default warning escalation.

~threshold

Show the current moderation threshold.

~threshold set PERCENT

Set the model score threshold from 0% to 100%.

~threshold reset

Restore the default 90% threshold.

~categories

View moderation-category state.

~categories enable CATEGORY

Enable a supported category.

~categories disable CATEGORY

Disable a supported category where permitted.

~categories reset

Restore default category state.

~join-protection enable|disable|status

Manage new-account verification.

~bypass USER_ID REASON

Release one pending verification restriction after review.

~nickname-protection enable|disable|status

Manage username and nickname checks.

~link-protection enable|disable|status

Manage the broad external-link filter.

~spam-detection enable|disable|status

Manage spam and mass-mention detection.

~image-scanning enable|disable|status [CHANNEL_ID]

Manage image scanning and channel overrides.

~moderator-exemption enable|disable|status

Manage moderator exemption; ~mod-exemption is an alias.

~auto-role [add] ROLE_ID

Add one automatic role.

~auto-role remove ROLE_ID

Remove one automatic role.

~auto-role list

List configured automatic roles.

~auto-role clear

Clear every automatic role.

~log CHANNEL_ID

Choose a moderation log channel.

~log-channel CHANNEL_ID

Alias for choosing the moderation log channel.

~log channel CHANNEL_ID

Expanded form for choosing the moderation log channel.

~exclude CHANNEL_OR_CATEGORY_ID

Exclude a channel or category from automatic moderation.

~include CHANNEL_OR_CATEGORY_ID

Return a channel or category to automatic-moderation scope.