> ## 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.

# Getting Started

> A complete step-by-step onboarding guide to adding, activating, and configuring Clyr Bot in your WhatsApp community.

## Overview

Clyr operates as a fully managed cloud service. You do not need to install local software, manage Docker containers, or register developer API keys. Adding Clyr to your community is done entirely through WhatsApp in under two minutes.

> **[Official Clyr Bot DM](https://wa.me/2348057416596?text=Hi)**
>
> **+234 805 741 6596**\\
>
> Click to message the bot directly on WhatsApp.

> **[Official Community & Support](https://chat.whatsapp.com/C0i4lOwpJAI5ohi22kqZV3?mode=gi_t)**
>
> Join the Clyr Community Group for real-time announcements, alpha updates, and admin support.

***

## Onboarding Walkthrough

Follow these steps to connect and configure Clyr for your community.

**1. Prerequisites**

Before starting, ensure that:

1. You have an active WhatsApp account.
2. You are an **Administrator** of the WhatsApp group where you want to deploy Clyr.
3. You have generated a valid WhatsApp Group Invite Link (via **Group Info > Invite to Group via Link**).

**2. Initiate Contact in Direct Message**

Open a direct WhatsApp chat with the official Clyr Bot number:

* **Phone Number:** `+234 805 741 6596`
* **Direct Link:** [wa.me/2348057416596](https://wa.me/2348057416596?text=Hi)

Send a greeting message:

```text theme={null}
Hi
```

Clyr will reply with the interactive onboarding menu:

```text theme={null}
👋 Welcome to Clyr Bot!

I provide automated crypto intelligence, token contract scanning, 
X/Twitter tracking, and raffle management for WhatsApp groups.

To add me to your group, reply with:
BOT <group-invite-link>

Example:
BOT https://chat.whatsapp.com/AbCdEfGhIjKlMnOpQrStUv
```

**3. Submit Your Group Invite Link**

Copy your group's invite link from WhatsApp and send it in the DM:

```text theme={null}
BOT https://chat.whatsapp.com/C0i4lOwpJAI5ohi22kqZV3
```

Clyr will parse the invite code, verify group eligibility, join your group automatically, and send a confirmation to your DM:

```text theme={null}
✅ Successfully joined "Crypto Alpha Syndicate"!

IMPORTANT: By default, the bot is in SILENT mode.
Please head over to your group and run:
/bot-on
```

**4. Activate the Bot in Your Group (/bot-on)**

Navigate to your WhatsApp group. An administrator must send the activation command:

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

> [!NOTE]
>
> **Privacy Protection Rule:** Clyr enters all new groups in **Silent Mode** to prevent disruption. It will not read contract addresses, unfurl links, or dispatch alerts until an administrator explicitly runs `/bot-on`.

The bot will confirm activation in the group:

```text theme={null}
🟢 Clyr Bot is now ACTIVE in this group!

• Token Contract Detection: Enabled
• Twitter Sentinel: Enabled
• Candlestick Charts (/fc): Ready
• Giveaways (/raffle): Ready

Type /help to see all available commands.
```

**5. Perform a Connection Handshake**

Verify that the socket is responsive by testing the handshake command:

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

Clyr will tag your phone number and confirm latency:

```text theme={null}
Hi @2348057416596! ⚡ Clyr Bot is online and operational.
```

**6. Configure Group Preferences (Optional)**

Fine-tune which background listeners run in your group:

```bash theme={null}
/twitter-on    # Enables automatic Twitter/X link previews
/nft-on        # Enables OpenSea NFT floor price detection
/mint-on       # Enables daily 8:00 AM WAT NFT drop schedule broadcasts
```

***

## Role Permissions & Security Model

Clyr strictly adheres to WhatsApp group role hierarchies:

| Command Category | Examples | Permitted Roles | Notes |
| :- | :- | :- | :- |
| **System Activation** | `/bot-on`, `/bot-off` | Group Admins Only | Prevents regular members from muting the bot |
| **Giveaway Control** | `/raffle`, `/raffle-end`, `/raffle-cancel` | Group Admins Only | Ensures only verified admins launch prize draws |
| **Feature Toggles** | `/mint-on`, `/mint-off`, `/twitter-on` | Group Admins Only | Controls group-level spam and notification volume |
| **Market Queries** | `/fc`, `/flex`, `/rate`, `/convert`, `/mints` | All Group Members | Accessible to any active community member |
| **Passive Scans** | Raw Solana / EVM token CAs, `$TICKER` | All Group Members | Scanned automatically across all chat messages |
| **Super Admin** | `/broadcast`, `/broadcast-tracker` | Clyr Owner Only | Restricted to verified system phone numbers |

***

## Troubleshooting & Common Questions

> **The bot did not join after sending the group link**
>
> 1. Verify that your group invite link is still valid and has not been revoked.
> 2. Check if your group has **"Approve New Participants"** enabled in Group Settings. If enabled, a group admin must approve Clyr's join request.
> 3. Ensure your group has not reached WhatsApp's participant limit (1,024 members).

> **Clyr is in the group but does not respond to commands**
>
> 1. Confirm that an admin has run `/bot-on` in the group.
> 2. Check bot status by typing `/bot-status`. If it reports `INACTIVE`, send `/bot-on`.
> 3. Ensure you are using the correct command prefix (`/`).

> **Do I need to make Clyr an Admin in my group?**
>
> Making Clyr a group administrator is **optional** for basic commands like `/fc`, `/flex`, and token scanning. However, admin status is recommended if you want Clyr to pin raffle winners or create native WhatsApp reminder polls via `/alert`.

***

## Subscription Plans

Clyr operates on a transparent tier model with automated crypto payment verification:

| Feature | Free Tier | Extra Groups Tier | Dedicated Number Tier |
| :- | :- | :- | :- |
| **Monthly Price** | **\$0 / month** | **\$5 / month per group** | **\$15 / month** |
| **Active Groups** | 1 Group | Custom (+1 per \$5/mo) | Unlimited Groups |
| **Operating Account** | Shared Clyr Number | Shared Clyr Number | **Your Personal / Dedicated Number (Scan to Link)** |
| **Token Scanning** | Yes (Solana & EVM) | Yes (Solana & EVM) | Yes (Solana & EVM) |
| **Twitter Sentinel** | Up to 3 handles | Up to 15 handles | Unlimited handles |
| **Candlestick Charts** | Standard resolution | High resolution | High resolution + Custom watermark |
| **Rate Limit Priority** | Standard | High | Maximum (Dedicated WhatsApp instance) |
| **Payment Verification** | Free forever | Automated Solana / EVM | Automated Solana / EVM |

> [!TIP]
>
> To upgrade your plan, message the bot in DM with `UPGRADE` or visit the [Support & Pricing](https://docs.clyrbot.xyz/support.md) guide.


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