Sonnet

Default Command Reference

The same information on this page can be found using the help command. Commands are listed here without the prefix, the default prefix is !. Example: !help

Command options in <inequality symbols> are required to use the command. Options in [square brackets] are optional.

Administration

Command Syntax Description Aliases Permission Level
set-show-mutetime <bool> Set whether to show the mute time to a user who has been muted None Administrator
list-infraction-modifiers [page] list all infraction modifiers None Moderator
rm-infraction-modifier <key> <title> <value> Delete an infraction modifier with the given key None Administrator
add-infraction-modifier <key> <title> <value> Add a new infraction modifier with the given key, title, and value None Administrator
set-filelog-behavior [text|gzip|none] Set the message to file log behavior to store text, gzip, or not store set-filelog-behaviour Administrator
message-edit-log <channel> Change message edit log, overloads message-log None Administrator
message-log <channel> Change message log None Administrator
leave-log <channel> Change leave log, overloads join-log None Administrator
join-log <channel> Change join log None Administrator
infraction-log <channel> Change infraction log None Administrator
notifier-log <channel> Change notifier log None Administrator
username-log <channel> Change username log None Administrator
gdpr Enforce your GDPR rights, Server Owner only None Owner
set-viewinfractions <bool> Set whether members of the guild can view their own infraction count viewinfractions Administrator
set-prefix <prefix> Set the Guild prefix None Administrator
set-muterole <role> Set the mute role None Administrator
set-adminrole <role> Set the administrator role None Owner
set-modrole <role> Set the moderator role None Administrator
set-moderator-protect <bool> Set whether to disallow infractions being given to moderator+ members, disabled by default None Administrator
set-leave-log-is-join-log <bool> Set whether the leave-log config should fallback to join-log if it doesn't exist None Administrator
set-edit-log-is-message-log <bool> Set whether the message-edit-log config should fallback to message-log if it doesn't exist None Administrator
set-unmute-on-ban <bool> Set whether to unmute a user upon banning them None Administrator

Automod

Command Syntax Description Aliases Permission Level
set-joinrule <type> <parameter> set joinrules to notify for None Administrator
wb-change <csv list> [rm|remove] Change word blacklist, use `wb-change - rm` to reset None Administrator
add-regexblacklist <regex> Add an item to regex blacklist None Administrator
wiwb-change <csv list> [rm|remove] Change the WordInWord blacklist, use `wiwb-change - rm` to reset None Administrator
remove-regexblacklist <<regex> | -i INDEX> Remove an item from regex blacklist None Administrator
ftb-change <csv list> [rm|remove] Change filetype blacklist, use `ftb-change - rm` to reset None Administrator
urlb-change <csv list> [rm|remove] Change url blacklist, use `urlb-change - rm` to reset None Administrator
list-automod [-r | --raw] List automod configs, use --raw to forcedump json file list-blacklist Moderator
blacklist-action <warn|mute|kick|ban> Set the action to occur when blacklist is broken None Administrator
set-whitelist <role> Set a role that grants immunity from blacklisting blacklist-whitelist, whitelist-set Administrator
set-charantispam <messages> <seconds> <chars> Set how many messages in seconds exceeding total chars to trigger antispam automute None Administrator
set-antispam <messages> <seconds> Set how many messages in seconds to trigger antispam automute antispam-set Administrator
set-antispam-timeout <time[h|m|S]> Set how many seconds a person should be out for with antispam auto mute/timeout mutetime-set, set-mutetime Administrator
set-antispam-action [timeout|mute] set whether to use mute or timeout for antispam triggers None Administrator
add-regexnotifier <regex> Add an item to regex notifier list None Administrator
remove-regexnotifier <<regex> | -i INDEX> Remove an item from notifier list None Administrator

Bookkeeping

Command Syntax Description Aliases Permission Level
remove-mute <user> Removes a user from the mute database. Does not unmute in guild None Administrator
list-mutes [-p PAGE] List all mutes in the mute database None Moderator
search-infractions <-u USER | -m MOD> [-t TYPE] [-p PAGE] [-i INF PER PAGE] [--[no-]automod] [-f FILTER] Grab infractions of a user, -f uses regex warnings, list-infractions, infractions Moderator
infraction-details <infractionID> Grab details of an infractionID get-infraction, grab-infraction Moderator
delete-infraction <infractionID> Delete an infraction by infractionID remove-infraction, rm-infraction Administrator

Colors

Command Syntax Description Aliases Permission Level
set-color-primary <hexcolor|"reset"> Set primary embed color set-colour-primary Administrator
set-color-creation <hexcolor|"reset"> Set creation embed color set-colour-creation Administrator
set-color-edit <hexcolor|"reset"> Set edit embed color set-colour-edit Administrator
set-color-deletion <hexcolor|"reset"> Set deletion embed color set-colour-deletion Administrator

Jokes

Command Syntax Description Aliases Permission Level
jkb <uid> "bans" a user None Moderator

Moderation

Command Syntax Description Aliases Permission Level
warn [+modifiers] <uid> [reason] Warn a user None Moderator
note <uid> [note] Put a note into a users infraction log, does not dm user None Moderator
kick [+modifiers] <uid> [reason] Kick a user None Moderator
ban [+modifiers] <uid> [-d DAYS] [reason] Ban a user, optionally delete messages with -d None Moderator
unban <uid> [reason] Unban a user, does not dm user None Moderator
softban [+modifiers] <uid> [-d DAYS] [reason] Softban (ban and then immediately unban) a user, optionally delete messages with -d None Moderator
mute [+modifiers] <uid> [time[h|m|S]] [reason] Mute a user, defaults to no unmute (0s) None Moderator
unmute <uid> [reason] Unmute a user, does not dm user None Moderator
timeout [+modifiers] <uid> [time[h|m|S]] [reason] Timeout a member, defaults to longest timeout possible (28 days) None Moderator
remove-timeout <uid> [reason] Remove a timeout on a member untimeout Moderator
purge <limit> [user] Purge messages from a given channel and optionally only from a specified user, this will not purge the command invocation None Moderator

Reaction Roles

Command Syntax Description Aliases Permission Level
rr-add <message> <emoji> <role> Add a reactionrole to a message None Administrator
rr-purge <message id> Purge all reactionroles from a message None Administrator
rr-remove <message> <emoji> Remove a reactionrole from a message rr-rm Administrator
rr-list List all reactionroles in guild rr-ls Administrator
rr-addmany <message> (?:<emoji> <role>)+ Add multiple reactionroles None Administrator

Scripting

Command Syntax Description Aliases Permission Level
sonnetsh [args] <command1> ... Sonnet shell runtime, useful for automating setup None Moderator
map [-s args] [-e args] <command> (<args>)+ Map a single command with multiple arguments None Moderator
amap [-s args] [-e args] <command> (<args>)+ Like map, but processes asynchronously, meaning it ignores errors None Moderator
map-expand [-s args] [-e args] <command> (<args>)+ Show what a map expression will expand to without actually running it None Moderator
sub <command> [args]+ runs a command as a subcommand None Everyone
sleep <seconds> Suspends execution for up to 30 seconds, for use in map/sonnetsh None Moderator
kill-script <message> Kills a instance of sonnetsh/map/amap that came from the command sent by the indicated message None Administrator

Starboard

Command Syntax Description Aliases Permission Level
starboard-channel <channel> Change Starboard channel None Administrator
starboard-emoji <emoji> Set the starboard emoji None Administrator
starboard-enabled <bool> Toggle starboard on or off None Administrator
starboard-count <number> Set starboard reaction count threshold None Administrator
starboard-forceboard <message> Forcibly starboard a message and add it to the starboard db None Administrator

Utilities

Command Syntax Description Aliases Permission Level
what-is <snowflake> Attempts to parse a generic discord snowflake and provide information on it None Everyone
role-info <role> Get information on a role roleinfo Everyone
ping Test connection to bot None Everyone
profile [user] Get a users profile user-info, userinfo Everyone
help [category|command] [-p PAGE] [-c] Print helptext, `-c` designates to only look for a command None Everyone
avatar [user] [--global] Get avatar of a user, returns guild avatar if it exists unless --global is specified pfp Everyone
banner [user] Get the profile banner of a user None Everyone
serverinfo Get info on this guild server-info Everyone
grab-message <message> [-r] Grab a message and show its contents, specify -r to get message content as a file get-message Everyone
poll Start a reaction based poll on the message None Everyone
coinflip Flip a coin None Everyone

Version

Command Syntax Description Aliases Permission Level
version-info Prints version info on sonnet modules version, versions Everyone
uptime Prints uptime None Everyone
statistics Prints stats about messages stats Everyone