Unjail¶
The unjail command releases a member from isolation, removing the "Jail" role and restoring the previous roles they held before being jailed. Tux automatically tracks and stores a member's roles when they are jailed, making it easy to return them to their original state once the issue is resolved.
If a jailed member leaves and rejoins the server, Tux re-jails them automatically; use /unjail when you intend to release them.
Syntax¶
The unjail command can be used in two ways:
Slash Command:
/unjail member:@user [reason:STRING] [silent:true/false]
Prefix Command:
$unjail @user [reason] [-silent]
$uj @user [reason] [-silent]
Aliases:
You can also use these aliases instead of unjail:
uj
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
member |
Member | Yes | The member to release from jail. |
reason |
String | No | The reason for releasing the user from jail, which is 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 member being unjailed.
- Type: Boolean
- Default: False
- Aliases:
-s,-quiet
Permissions¶
Bot Permissions¶
Tux requires the following permissions:
- Manage Roles - Required to remove the jail role and re-add previous roles.
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 Unjail (Slash)¶
Releasing a member from jail.
/unjail member:@user
With Reason (Slash)¶
/unjail member:@user reason:"Behavior improved"
With Reason¶
$unjail @user Investigation complete, rules explained
Response Format¶
When executed successfully, Tux will:
- Locate the latest jail case for the member in the database.
- Remove the "Jail" role from the member.
- Re-assign the roles stored in the jail case.
- Attempt to DM the user with the unjail confirmation (unless
-silentis used). - Create a new moderation case for the unjail action.
- Post a confirmation message in the current channel showing the unjail details.
- Log the action in the designated moderation log channel.
The confirmation message includes the unjailed user's name, the reason (if provided), and a link to view the moderation case. All roles that were stored when the user was jailed are automatically restored.
Error Handling¶
Common Errors¶
Missing Permissions / Higher Role¶
When it occurs: Tux lacks the "Manage Roles" permission, or the target user's highest role is equal to or higher than Tux's highest role.
What happens: The bot sends an error message indicating insufficient permissions.
Solutions:
- Ensure Tux has the "Manage Roles" permission in the server settings
- Move Tux's role above the target's role in the server hierarchy
- Check that Tux's role has the necessary permissions in the server settings
Lacking Permission Rank¶
When it occurs: Your internal Tux permission rank is lower than required.
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 commandsif you have admin access
No Jail Case Found¶
When it occurs: The bot cannot find a record of the user being jailed in its database.
What happens: The bot sends an error message indicating no jail case was found for the user.
Solutions:
- You may need to manually restore the user's roles if they were jailed elsewhere or if the case was deleted
- Check if the user was jailed using a different bot or method
- Use
/cases search user:@user type:jailto verify if a jail case exists
Member Not Jailed¶
When it occurs: The user does not have the "Jail" role.
What happens: The bot sends an error message indicating the member is not currently jailed.
Solutions:
- No action needed - the user is already not jailed
- Verify the user's jail status by checking their roles or using
/cases search user:@user type:jail
Roles Not Restored¶
When it occurs: Some roles may no longer exist, or Tux's highest role is now below those roles in the hierarchy.
What happens: The unjail succeeds, but some roles cannot be restored. Tux logs which roles could not be restored.
Solutions:
- Tux will log which roles could not be restored - check the moderation log channel
- Hand-assign any missing roles if necessary
- Ensure Tux's role is high enough in the hierarchy to manage the roles that need to be restored
- Verify that the roles still exist in the server
Related Commands¶
/jail- Restrict a member to the jail channel and remove roles/cases- View the details of the original jail case