Docs / Administration / Setup Wizard

Setup Wizard

OmniGest walks you through configuration the first time you add it to a group or channel. Instead of exploring /config blindly, the bot invites you to a step-by-step DM wizard that gets your group production-ready in 2-3 minutes.

How it triggers

When the bot is added to a group, supergroup, or channel, OmniGest detects the event and posts a single message in the chat with two buttons:

  • ⚙️ Configure bot — opens a private chat (/start setup_<chat_id>) and starts the wizard.
  • ℹ️ Later — records that you have postponed setup. The bot will not invite you again, even if you re-add it to the same group later.

In channels, where a button would be confusing (posts reach all subscribers), the message is plain text and the admin can launch the wizard manually with /setup in DM.

Two modes: Fast and Full

After tapping the button, the wizard offers a fork:

Mode Steps For whom
Fast 5 You want a functional group in 2 minutes. Covers essentials.
Full 7 You want to review every protection before accepting defaults.

Fast mode steps

  1. Language — Spanish or English
  2. Welcome message — use the default or write your own
  3. Captcha — require verification from new members (recommended for public groups)
  4. AliExpress — use the bot's affiliate links, connect your own credentials, or skip
  5. Coupons — cadence for receiving broadcasts: daily / every 2 days / weekly / fortnightly / off

Extra Full mode steps

  1. Security pack — enable AntiSpam + AntiFlood + WordFilter in one click
  2. AI moderation — automatic analysis with OpenAI Moderation (NSFW, scam, CSAM)

Channel mode

Channels get a reduced 3-step wizard: language, coupon cadence, and Daily Tip. Group protections (captcha, antispam, etc.) do not apply since only the admin publishes.

Resume a half-finished wizard

If you close the DM or hit ⏸️ Pause on any step, OmniGest saves your state:

  • Next time you message /start or /config in DM, the bot detects pending wizards and offers ▶️ Resume or 🗑️ Discard.
  • State persists until you finish, discard, or a month passes (automatic purge planned for high volumes).

Skip individual steps

Each step has three actions:

  • Tap an option — applies the decision and advances
  • ⏭️ Skip — marks the step as ~skipped and advances without touching settings
  • ⬅️ Back — returns to the previous step

Skips are tracked (~lang, ~captcha, etc.) so you can later audit what each admin decided during setup.

One invitation per group

To avoid spam, OmniGest stamps setup_invite_resolved_at as soon as:

  • You complete the wizard, or
  • You tap ℹ️ Later on the invitation, or
  • You skip all steps.

After that, even if you are removed from the group and re-added, no second invitation is sent. To re-configure, type /setup in DM.

Kill-switch for owners

The bot owner can disable the auto-trigger globally:

SETUP_WIZARD_ENABLED=false

With the flag at false: - New groups do not receive the button invitation. - /setup in DM short-circuits silently. - In-progress wizards keep working until they finish or close.

Useful for emergency shutdowns or deploys where you want to validate the rest of the bot before exposing the wizard.

Why this matters

The first minute in any new group is where you lose the admin. If they have to discover 20 commands to understand what the bot does, they will most likely close Telegram and forget. The setup wizard reduces that onboarding to "tap this button" → guided DM → group ready. It is the difference between a bot that gets tested and a bot that gets used.