> ## Documentation Index
> Fetch the complete documentation index at: https://docs.headlesslabs.xyz/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Syntax

> This page summarizes Headless syntax. Examples use the default `.` prefix; registered slash commands appear in Discord's command picker.

## Prefix and slash commands

Check the current prefix with `.prefix`; an Administrator can change it with `.prefix set <new>` or reset it. You can also use `/prefix` with `new_prefix` when the slash command is available. Slash commands provide each argument in a Discord field.

## Arguments and mentions

In documentation, `<required>` and `[optional]` are notation: do not type the brackets. A list such as `<on|off>` means choose one listed value. Use Discord's mention/selector when a command expects a member, role, or channel argument.

## Durations and flags

Headless has no universal duration grammar. For example, Honeyspot accepts compact values such as `60m` or `1w2d`, while `.vanity timeout 10` means ten minutes. `--` options belong only to commands that document them; type two ASCII hyphens, not an em dash `—`.

## Syntax that is not inherited

The `select:ID` format, `--do` punishment sets, and another bot's duration units are not general Headless syntax. Follow the specific command page and do not copy flags from unrelated features.

## Steps

**1. Open the command guide**

Confirm prefix, required arguments, options, and permissions before copying an example.

**2. Replace only the values**

Change mentions, channel, duration, or sample text to your server's values; do not include notation brackets.

**3. Test without sanction**

For moderation rules, start in a logging or preview mode if the command provides one.

## Examples by syntax family

### Configure an Anti-Nuke module

```headless-command Syntax theme={null}
.antinuke ban [on|off|status] [--threshold <1-50>] [--do <none|warn|jail|kick|ban|stripstaff>] [--command <on|off>]
```

```headless-command Example theme={null}
.antinuke ban on --threshold 3 --do ban --command on
```

### Change the command prefix

#### `.prefix`

```headless-command Syntax theme={null}
.prefix
```

```headless-command Example theme={null}
.prefix
```

```headless-command Syntax theme={null}
/prefix [new_prefix:<new_prefix>]
```

```headless-command Example theme={null}
/prefix new_prefix:!
```

#### `.prefix set`

```headless-command Syntax theme={null}
.prefix set <new_prefix>
```

```headless-command Example theme={null}
.prefix set !
```

#### `.prefix reset`

```headless-command Syntax theme={null}
.prefix reset
```

```headless-command Example theme={null}
.prefix reset
```

#### `.antinuke status`

```headless-command Syntax theme={null}
/antinuke status
```

```headless-command Example theme={null}
/antinuke status
```

## Anti-Nuke channel protection

The channel module uses the same action parser as other rules. `stripstaff` is a supported option, and `.an` is the short alias for `.antinuke`.

```headless-command Syntax theme={null}
.antinuke channel [on|off|status] [--threshold <1-50>] [--do <none|warn|jail|kick|ban|stripstaff>]
```

```headless-command Example theme={null}
.an channel on --threshold 1 --do stripstaff
```

### Configure mass joins

```headless-command Syntax theme={null}
.antiraid massjoin [on|off|status] [--threshold <1-50>] [--do <kick|ban>] [--lock <true|false>] [--punish <true|false>]
```

```headless-command Example theme={null}
.antiraid massjoin on --threshold 5 --do kick
```

### Other feature-specific durations

```headless-command Syntax theme={null}
.honeyspot timeout <duration>
```

```headless-command Example theme={null}
.honeyspot timeout 1w2d
```

```headless-command Syntax theme={null}
.vanity timeout <minutes>
```

```headless-command Example theme={null}
.vanity timeout 10
```

> [!WARNING]
>
> Punishment flags can trigger real actions. Verify the exact command and mode before enabling kick, ban, or another sanction.

## Related pages

* [Join Gate](/docs/en/security/anti-raid.md)
* [Moderation](/docs/en/security/moderation.md)
* [Permissions](/docs/en/permissions.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.