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

# Utility & Administrative Commands

> Group lifecycle management, interactive WhatsApp attendance polls, connection diagnostics, and system-wide broadcast controls.

## Group Lifecycle Management

To prevent unsolicited messaging, Clyr maintains an explicit state machine for every WhatsApp group stored in the `group_settings` database table.

```
                  ┌───────────────┐
                  │  GROUP JOIN   │
                  └───────┬───────┘
                          │ (Defaults to Silent Mode)
                          ▼
                  ┌───────────────┐
           ┌─────>│ INACTIVE / OFF│<─────┐
           │      └───────┬───────┘      │
   /bot-off│              │ /bot-on      │/bot-off
           │              ▼              │
           │      ┌───────────────┐      │
           └──────│  ACTIVE / ON  │──────┘
                  └───────────────┘
```

### `/bot-on` — Activate Bot in Group

Enables active listening in the current WhatsApp group. Once active, the bot processes raw contract addresses, executes commands, and unfurls media.

```bash theme={null}
/bot-on
```

**Aliases:** `/boton`, `/start-bot`, `/activate`

> [!NOTE]
>
> Requires **Group Administrator** privileges.

***

### `/bot-off` — Deactivate Bot (Silent Mode)

Switches the bot into dormant Silent Mode. While dormant, Clyr ignores all incoming contract addresses, cashtags, and user commands except for `/bot-on` and `/bot-status`.

```bash theme={null}
/bot-off
```

**Aliases:** `/botoff`, `/stop-bot`, `/deactivate`

> [!NOTE]
>
> Requires **Group Administrator** privileges.

***

### `/bot-status` — Inspect Feature Flags

Returns the current operating state of the bot in the active group, including specific toggles for Twitter Sentinel, NFT Floor Radar, and Mint Drop alerts.

```bash theme={null}
/bot-status
```

#### Response Format

```text theme={null}
⚙️ Clyr Bot Status Report
Group: MANDEM 🫂❤️🦅

• Core Engine: ACTIVE 🟢
• Token Contract Scanner: ENABLED 🟢
• Twitter Previews: ENABLED 🟢
• OpenSea NFT Detection: ENABLED 🟢
• Daily Mint Radar: ENABLED (08:00 WAT) 🟢
• Active X Trackers: 3 handles
• Active Raffles: 0
```

***

## Interactive Event Poll Reminders

Clyr integrates directly with WhatsApp's native interactive polling protocol to coordinate Twitter Spaces, community AMAs, and trading sessions.

### `/alert` — Schedule an Event Poll

Creates an attendance poll with built-in background reminders.

```bash theme={null}
/alert <event_title> <time>
```

#### Parameters

| Parameter | Type | Required | Description |
| :- | :- | :- | :- |
| `event_title` | String | **Yes** | Name of the space or community event (e.g. `Base Alpha Space with Founders`). |
| `time` | String | **Yes** | Event start time (e.g. `6:00pm WAT`, `8:00pm UTC`, `tomorrow 7pm`). |

#### Automated Reminder Schedule

1. **Poll Creation**: Clyr posts an interactive WhatsApp poll with options:
   * ✅ *Going (Reminder at T-15m)*
   * 🤔 *Interested*
   * ❌ *Can't Make It*
2. **T-15m Pre-Warning**: 15 minutes before the scheduled time, the background scheduler sends a notification tagging participants who selected "Going".
3. **Kick-Off Ping**: At the exact start time, Clyr dispatches the live link notification.

```bash theme={null}
/alert Founders AMA on Base 7:00pm
```

***

### `/alerts` — List Upcoming Events

Displays all upcoming event reminders scheduled for the active group.

```bash theme={null}
/alerts
```

**Aliases:** `/events`, `/alert-list`

***

### `/alert-cancel` — Cancel an Event Reminder

Removes a scheduled event poll from the background scheduler (Admin only).

```bash theme={null}
/alert-cancel <alert_id>
```

***

## Diagnostics & Navigation

### `/help` — Command Directory

Renders the complete, categorized command menu tailored to the sender's permission level.

```bash theme={null}
/help
```

**Aliases:** `/menu`, `/commands`

***

### `/hello` — Connection Latency Handshake

Performs an immediate ping-pong handshake with the WhatsApp socket connection to verify uptime and latency.

```bash theme={null}
/hello
```

**Aliases:** `/ping`, `/hi`

#### Response

```text theme={null}
Hi @2348057416596! ⚡ Clyr Bot is online and responsive.
Socket Latency: 142ms
```

***

## Super-Administrator Broadcasts

> [!WARNING]
>
> Broadcast commands are strictly restricted to the **Clyr Bot Owner Phone Number** defined in the system environment (`ADMIN_PHONE_NUMBER`). Attempts by unauthorized users are rejected.

### `/broadcast` — Multi-Group System Announcement

Dispatches an announcement across all active WhatsApp groups where Clyr is deployed. The engine employs an automated **300ms inter-group throttling delay** to protect the host phone number from WhatsApp anti-spam bans.

```bash theme={null}
/broadcast <announcement_message>
```

**Aliases:** `/bcast`, `/announce`

#### Example Invocation

```bash theme={null}
/broadcast 🚨 System Update v2.1: Solscan RPC nodes upgraded. Zero-latency token scanning is now live across all groups!
```

***

### `/broadcast-tracker` — Daily Alpha Project Digest

Dispatches a structured, formatted alpha project digest to all subscribed groups, ranking top-performing tokens with gain percentages and contract addresses.

```bash theme={null}
/broadcast-tracker <project_list_payload>
```

***

## Group Feature Toggles (Admin)

Group administrators can selectively enable or mute background automation engines to customize notification volume:

| Feature Toggle | Description | Default State |
| :- | :- | :- |
| `/scan-on` \| `/scan-off` | Toggle passive Solana & EVM contract address scanning | **Enabled** (when bot is on) |
| `/twitter-on` \| `/twitter-off` | Toggle rich X/Twitter link unfurling in chat | **Enabled** |
| `/nft-on` \| `/nft-off` | Toggle automatic OpenSea collection floor previews | **Enabled** |
| `/mint-on` \| `/mint-off` | Toggle daily 09:00 AM WAT NFT mint drop radar broadcasts | **Enabled** |

***

## Direct Message (DM) Account Management

When messaging the bot in private DM (`+234 805 741 6596`), community owners can manage group slots and subscriptions:

| Message | Action |
| :- | :- |
| `FREE` | Claim your 1 free group slot and send invite link |
| `STATUS` | View active plan, subscription expiration, and linked groups |
| `BUY 5` | Generate invoice to add +1 extra group slot (\$5/mo via Crypto) |
| `BUY 15` | Generate invoice for Dedicated Own-Number Mode (\$15/mo) |
| `PAIR` | Request an 8-character pairing code to connect your personal WhatsApp number |
| `VERIFY <tx_hash>` | Submit an on-chain transaction hash for instant subscription activation |


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