> For the complete documentation index, see [llms.txt](https://niloc3.gitbook.io/bdaybot/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://niloc3.gitbook.io/bdaybot/commands.md).

# Commands

{% hint style="info" %}
How to Read These Docs

* Anything in carrots `<>` is a mandatory argument. **Do not include the < >**
* Anything in brackets `[]` is an optional argument.  **Do not include the \[ ]**
* Anything in curly brackets `{}` is an variable. **Keep the { }**
  {% endhint %}

## All Bot Commands&#x20;

| Command                                   | Examples                                                                                                    | Explanation                                                                                                                                                          |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/help [command]`                         | <p></p><ul><li>/help setbday</li><li>/help</li></ul>                                                        | Gets a link to these docs or help on a specific command.                                                                                                             |
| `/support`                                | <ul><li>/support</li></ul>                                                                                  | Sends a link to join the support server.                                                                                                                             |
| `/vote`                                   | <ul><li>/vote</li></ul>                                                                                     | <p>Sends a link to vote for Birthday Bot.</p><p></p>                                                                                                                 |
| `/setbday <birthday>`                     | <ul><li>/setbday 03/05</li></ul>                                                                            | Sets your birthday. Use MM/DD format.                                                                                                                                |
| `/getbday [user]`                         | <ul><li>/getbday @Niloc</li><li>/getbday 626916199783071750</li></ul>                                       | Checks what another users birthday is set to. Use mention or ID.                                                                                                     |
| `/settings`                               | <ul><li>/settings</li></ul>                                                                                 | Checks what the settings are for your server.                                                                                                                        |
| `/message <add\|remove\|clear> <message>` | <ul><li>/message remove HBD {user}</li><li>/message add Happy Bday {user}!</li><li>/message clear</li></ul> | Adds or removes birthday messages. Use `{user}` to mention the user. Use no arguments to check what your birthday messages are. More then one message is **premium** |
| `/channel <#channel>`                     | <ul><li>/channel #birthdays</li></ul>                                                                       | Sets the birthday channel that birthdays will be announced to.                                                                                                       |
| `/premium`                                | <ul><li>/premium</li></ul>                                                                                  | Checks if your server is premium for the month. <https://patreon.com/bdaybot>                                                                                        |
| `/embed`                                  | <ul><li>/embed</li></ul>                                                                                    | Toggles birthday messages being in an embed or not. **Premium**                                                                                                      |
| `/premiumperks`                           | <ul><li>/premiumperks</li></ul>                                                                             | Shows you the perks you get for being cool, <https://patreon.com/bdaybot>                                                                                            |
| `/addpremium`                             | <ul><li>/addpremium</li></ul>                                                                               | Marks a server as premium if you have it                                                                                                                             |
| `/removepremium`                          | <ul><li>/removepremium</li></ul>                                                                            | Unmarks a server as premium, giving you another server to mark.                                                                                                      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://niloc3.gitbook.io/bdaybot/commands.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.