Skip to content

SnippetUnban

The snippetunban command (also available as sub) allows server moderators to lift a previously applied snippet restriction from a member, restoring their ability to use Tux's snippet creation and management features.

Syntax

The snippetunban command can be used in two ways:

Slash Command:

Text Only
/snippetunban member:@user [reason:STRING] [silent:true/false]

Prefix Command:

Text Only
$snippetunban @user [reason] [-silent]
$sub @user [reason] [-silent]

Aliases:

You can also use these aliases instead of snippetunban:

  • sub

Parameters

Parameter Type Required Description
member Member Yes The member to restore snippet access for.
reason String No The reason for restoring snippet access, logged in the moderation case and included in the DM notification. In prefix commands, this is a positional argument. In slash commands, it is a named parameter. Defaults to "No reason provided".

Flags

This command supports the following flags:

Flag Aliases Type Default Description
-silent -s, -quiet Boolean False If true, Tux will not attempt to DM the user.

-silent

Whether to suppress the DM notification to the user.

  • Type: Boolean
  • Default: False
  • Aliases: -s, -quiet

Permissions

Bot Permissions

Tux requires no special Discord permissions for this command, as it is handled internally via its database.

User Permissions

Users need appropriate moderation permissions to use this command.

Permission System

Command permissions are configured per-guild using Tux's dynamic permission system. Configure via /config commands or see the Permission Configuration guide.

Usage Examples

Basic Snippet Unban

Restoring snippet access for a member.

Text Only
/snippetunban member:@user reason:"Manual release"

With Reason

Text Only
$snippetunban @user Appealed successfully, access restored

Response Format

When executed successfully, Tux will:

  1. Update its internal database to remove the snippet ban for the user.
  2. Attempt to DM the user informing them they can once again create and manage snippets (unless -silent is used).
  3. Create a new moderation case for the snippet unban.
  4. Post a confirmation message in the current channel showing the snippet unban details.
  5. Log the action in the designated moderation log channel.

The confirmation message includes the snippet-unbanned user's name, the reason (if provided), and a link to view the moderation case.

Error Handling

Common Errors

Lacking Permission Rank

When it occurs: Your internal Tux permission rank is lower than what's required to use this command.

What happens: The bot sends an error message indicating you don't have permission to use this command.

Solutions:

  • Contact a server administrator to check your rank
  • Adjust the command configurations via /config commands if you have admin access

User Not Snippet Banned

When it occurs: You attempt to unban a user who does not have an active snippet restriction.

What happens: The bot sends an error message indicating the user is not currently snippet-banned.

Solutions:

  • No action needed - the user is already not snippet-banned
  • Verify the user's snippet ban status using /cases search user:@user
  • /snippetban - Prevent a member from creating snippets
  • /cases - View the moderation history for snippet bans
  • $createsnippet - The snippet command that is restored by this unban