# Antinuke

## Information

{% hint style="warning" %}
To start using antinuke, you need to need to use `antinuke setup`.
{% endhint %}

Antinuke is triggered by a threshold set **per user**.

Your antinuke should **never** have to be higher than 5. Antinuke will not work as well if it's threshold is set high. We recommend a threshold between 1 and 5.

## Parameters

| Name       | Description                   |
| ---------- | ----------------------------- |
| threshold  | Threshold to trigger antinuke |
| punishment | Action to be taken on trigger |
| time       | Threshold for account age     |

{% hint style="info" %}
Review the contents of each **antinuke subcommand** to see what parameters are supported. All parameters above aren't available to every subcommand!
{% endhint %}

## Punishments

Click the following to view all antinuke punishments available:

{% content-ref url="/pages/M8W1s0B1kjPxF5dsKqD9" %}
[Punishments](/resources/punishments.md)
{% endcontent-ref %}

## Admins & Whitelisted <a href="#admins-and-whitelisted" id="admins-and-whitelisted"></a>

You can whitelist members from triggering antinuke by using `antinuke whitelist [user]`.

You can also grant antinuke admin to a user, which allows them to modify antinuke settings. You can do this by using `[prefix] antinuke admin [user]`. Only give this to people you trust.

{% hint style="warning" %}
Be careful who you whitelist. They can nuke your server without being detected by antinuke.
{% endhint %}

## Antinuke Logs <a href="#antinuke-logs" id="antinuke-logs"></a>

You can set a channel to send antinuke logs by using `antinuke logs`. Whenever antinuke is triggered, a message will be sent to that channel. It is recommended that you set this up.

## Antinuke Recommended Configuration

If you don't know how to configure your Antinuke, here is our recommended config for the Antinuke module.

```
// Role Config
antinuke rolecreate enable 3 strip
antinuke roledelete enable 1 strip
antinuke editrole enable ban
antinuke giverole enable strip

// Channel Config
antinuke channelcreate enable 3 strip
antinuke channeldelete enable 1 strip

// Role Moderation
antinuke kick enable 3 kick
antinuke ban enable 3 kick
antinuke botadd enable strip
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.evelina.bot/security/antinuke.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
