# /vanityroles setup

### Description

This command allows you to quickly setup the [Vanity Roles](/features/vanity-roles.md) features for the bot.

### Cheat Sheet

{% hint style="info" %}
`/vanityroles setup !role: !channel: url:`

<mark style="color:red;">**Note:**</mark>**&#x20;Any parameter prefixed with&#x20;**<mark style="color:red;">**!**</mark>**&#x20;is required, the others are optional.**
{% endhint %}

**Permissions**

* Administrator

### Parameters

Parameters are the options you can pass if you want extra input or custom behaviour.

<table data-view="cards"><thead><tr><th>Parameter</th><th>Purpose</th><th>Options</th></tr></thead><tbody><tr><td><mark style="color:green;background-color:green;"><code>Role</code></mark></td><td>The role which should be applied when a user meets the vanity requirements</td><td><code>&#x3C;any></code></td></tr><tr><td><mark style="color:green;background-color:green;"><code>Channel</code></mark></td><td>The channel which notifications should be sent to when the user meets the vanity requirements</td><td><code>&#x3C;any></code></td></tr><tr><td><mark style="color:green;background-color:green;"><code>URL</code></mark></td><td>The Vanity URL to watch, which determines the vanity requirements. <strong>By default, this is the current vanity URL for your server.</strong></td><td><code>&#x3C;any></code></td></tr></tbody></table>


---

# 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.elyxir.dev/commands/vanityroles/setup.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.