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

# Quickstart

> Get started with Annie Mei in minutes by adding the bot to your Discord server and trying out basic commands.

# Quickstart Guide

Get Annie Mei running in your Discord server in just a few minutes.

<Steps>
  <Step title="Add the Bot to Discord">
    The quickest way to start is to invite the hosted Annie Mei bot directly:

    [Add Annie Mei to your Discord server](https://discord.com/oauth2/authorize?client_id=962106280430932079\&permissions=388160\&scope=bot)

    Open the link, choose your Discord server, and authorize the bot.

    By adding Annie Mei or using its slash commands, you agree to the [Terms of Service](/legal/terms-of-service). Review the [Privacy Policy](/legal/privacy-policy) to understand how Annie Mei handles Discord interactions and optional AniList account links.

    <Note>
      You'll need "Manage Server" permissions on the Discord server to add bots.
    </Note>
  </Step>

  <Step title="Verify the Bot is Online">
    Once added, check that Annie Mei appears online in your server's member list. The bot will automatically register its slash commands when it starts up.

    You can verify this by typing `/` in any channel - you should see Annie Mei's commands in the autocomplete menu.
  </Step>

  <Step title="Try Your First Command">
    Let's test the bot with a simple health check:

    ```text theme={}
    /ping
    ```

    The bot should respond with a short greeting, confirming it's online and can answer slash commands.
  </Step>

  <Step title="Look Up an Anime">
    Now try searching for an anime:

    ```text theme={}
    /anime search:Attack on Titan
    ```

    Annie Mei will return detailed information from AniList, including the title, description, rating, episode count, and more.

    <Note>
      You can search by name or use an AniList ID for exact matches. Japanese kana is also supported!
    </Note>
  </Step>

  <Step title="Search for Manga">
    Search for manga information:

    ```text theme={}
    /manga search:Chainsaw Man
    ```

    You can also search using Japanese characters:

    ```text theme={}
    /manga search:きめつのやいば
    ```
  </Step>

  <Step title="Find Theme Songs">
    Look up opening and ending theme songs for an anime with Spotify links:

    ```text theme={}
    /songs search:Demon Slayer
    ```

    <Warning>
      For anime with numeric titles, wrap the title in quotes to ensure proper parsing:

      ```text theme={}
      /songs search:"86"
      ```
    </Warning>
  </Step>

  <Step title="Look Up a Character">
    Search for character details and appearances:

    ```text theme={}
    /character search:Lelouch spoilers:disallow
    ```

    <Note>
      The `spoilers` option is required. Use `allow` to reveal spoiler aliases and description content, or `disallow` for a spoiler-free result.
    </Note>
  </Step>

  <Step title="Link your AniList account (optional)">
    To include your AniList watch or read status in server lookups, link your AniList account:

    ```text theme={}
    /register
    ```

    Complete the browser flow that opens from the button. After that, your status and score can appear in `/anime` and `/manga` results for your server.

    Confirm the linked account with:

    ```text theme={}
    /whoami
    ```
  </Step>

  <Step title="Review your preferences">
    Open your private settings panel:

    ```text theme={}
    /settings
    ```

    You can choose title display, analytics privacy, and guild score options.
  </Step>
</Steps>

## Available commands

Here's a quick reference of all available commands:

| Command                                                       | Description                                                                           |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `/help`                                                       | Shows all available commands and usage information                                    |
| `/ping`                                                       | Quick greeting to confirm the bot is online                                           |
| `/register`                                                   | Start secure AniList OAuth linking                                                    |
| `/unregister confirmation:<Confirm unlink or Cancel>`         | Unlink your AniList account and delete active stored AniList OAuth credentials        |
| `/whoami`                                                     | View the AniList account ID and profile link currently linked to your Discord profile |
| `/settings`                                                   | Review and update user or server preferences                                          |
| `/anime search:<term or id>`                                  | Look up anime by name or AniList ID                                                   |
| `/manga search:<term or id>`                                  | Look up manga by name or AniList ID                                                   |
| `/search query:<description>`                                 | Find anime or manga from a natural-language description                               |
| `/recommend type:<anime or manga> search:<term or id>`        | Get AniList community recommendations for a title                                     |
| `/character search:<term or id> spoilers:<allow or disallow>` | Look up character details and appearances by name or AniList ID                       |
| `/songs search:<term or id>`                                  | Find opening and ending theme songs for an anime                                      |

## Search Tips

* **Use AniList IDs** for exact matches when you know the specific ID
* **Japanese kana is fully supported** - search in Japanese if you prefer
* **Wrap numeric titles in quotes** to prevent parsing issues (e.g., `/songs search:"86"`)
* **Partial matches work** - you don't need to type the full title

## Next Steps

If you want to self-host Annie Mei or contribute to development, check out the [Installation Guide](/installation).