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

# AFK

> Set an away-from-keyboard status with a custom message

## Overview

The AFK command allows you to set an away-from-keyboard status. When someone mentions you while you're AFK, the bot will automatically notify them with your custom AFK message.

<Info>
  Your AFK status is automatically removed when you send a message in the server.
</Info>

***

## Command Usage

<CodeGroup>
  ```bash Syntax theme={null}
  ~afk [message]
  ```

  ```bash Examples theme={null}
  ~afk
  ~afk Going to sleep, be back in 8 hours
  ~afk In a meeting
  ~afk Eating lunch, brb
  ~afk Taking a break from Discord
  ```
</CodeGroup>

**Parameters:**

* **message** (optional) — Custom AFK message to display when mentioned
  * If no message provided, defaults to "AFK"
  * Can be any length
  * Supports text and emojis

***

## How It Works

<Steps>
  <Step title="Set AFK Status">
    Run the command with your custom message:

    ```bash theme={null}
    ~afk Going to the store
    ```
  </Step>

  <Step title="Others See Your Status">
    When someone mentions you, they'll be notified you're AFK with your custom message
  </Step>

  <Step title="Auto-Remove on Return">
    Your AFK status automatically clears when you send any message in the server
  </Step>
</Steps>

***

## Examples

<Tabs>
  <Tab title="Simple AFK">
    ```bash theme={null}
    ~afk
    ```

    Sets status to "AFK" with no custom message
  </Tab>

  <Tab title="With Reason">
    ```bash theme={null}
    ~afk Sleeping, will respond in the morning
    ```

    Sets AFK with a detailed reason
  </Tab>

  <Tab title="Short Break">
    ```bash theme={null}
    ~afk brb 5 mins
    ```

    Quick AFK status for short breaks
  </Tab>

  <Tab title="With Emojis">
    ```bash theme={null}
    ~afk 💤 Taking a nap
    ```

    Add emojis to your AFK message
  </Tab>
</Tabs>

***

## Features

<CardGroup cols={2}>
  <Card title="Custom Messages" icon="message">
    Set any message you want people to see when you're away
  </Card>

  <Card title="Auto-Notify" icon="bell">
    Bot automatically responds when someone mentions you
  </Card>

  <Card title="Auto-Remove" icon="rotate-left">
    Status clears automatically when you return and send a message
  </Card>

  <Card title="No Time Limit" icon="clock">
    Stay AFK as long as you need - no expiration
  </Card>
</CardGroup>

***

## Permission Requirements

<Card title="User Permissions" icon="user">
  **No special permissions required** — All members can use this command
</Card>

***

## Related Commands

<CardGroup cols={2}>
  <Card title="User Info" icon="user" href="/userinfo">
    View information about users
  </Card>

  <Card title="Server Info" icon="server" href="/serverinfo">
    View server information
  </Card>
</CardGroup>