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

# Quick Start

> The five commands that turn a bare install into a moderated server.

Run these in order. Every command is safe to re-run, and each replies with what changed.

## 1. Create the mute roles

```text theme={null}
/setup mute
```

Creates (or reuses) **Muted** and **Image Muted**, then denies the right permissions for them in
every channel and category:

| Role | Blocks |
| - | - |
| Muted | Messages, threads, reactions, voice messages, speaking |
| Image Muted | File uploads and link embeds |

Re-run it whenever you add channels outside a category. The roles are saved as the `mute-role` and
`imagemute-role` settings, and `/imagemute` applies the role for a duration instead of editing every
channel.

**Needs Manage Roles**

Criminal needs **Manage Roles** and a role above the ones it creates. Both setup commands refuse
to run with a clear message if that's missing.

## 2. Build the jail

```text theme={null}
/setup jail
```

Creates or reuses the **Jailed** role plus a private `#jail` channel, then configures visibility in
every channel and category so jailed members can only see the jail. `/unjail` releases early, and
`/jail` defaults to one hour.

## 3. Pick a log channel

```text theme={null}
/config channel log-channel #mod-logs
```

This is the single channel every log entry goes to: messages, members, threads, stages, voice,
channels, roles, server settings, invites, webhooks, scheduled events and AutoMod. Entries never ping
anyone, and each carries a timestamp in the reader's own timezone.

## 4. Enable AutoMod

```text theme={null}
/config toggle automod enabled:True
/automod filter rule:"server invites" enabled:True
/config number automod-spam 5
/automod action action:"delete and warn"
```

Rules ship **off**: invites, links, caps, mentions, spam and the word filter each need turning on.
Staff with `Manage Messages` are always exempt. Details in [AutoMod](https://docs.criminal.work/features/automod.md).

## 5. Turn on the things you want

```text theme={null}
/config toggle levels enabled:True
/config channel levelup-channel #levels
/config channel suggestion-channel #suggestions
/config channel starboard-channel #sob-board
/config toggle vanity enabled:True
/config role vanity-role @Advertiser
```

## Verify it

```text theme={null}
/help
/automod status
/vanity status
/ping
```

`/help` renders the live command tree grouped by category — if a command isn't listed, it isn't
loaded. `/dev deploy-status` (bot team owners) confirms the checkout and git auth are wired up.


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