build-wizard-flow

Create multi-step Telegram bot wizard flows with Kotlin annotations.

247|18|Updated May 26, 2022
One-click install
npx skills add https://github.com/vendelieu/telegram-bot --skill build-wizard-flow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: build-wizard-flow
Source: https://github.com/vendelieu/telegram-bot/tree/main/.cursor/skills/bot-user/build-wizard-flow
Command: npx skills add https://github.com/vendelieu/telegram-bot --skill build-wizard-flow

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the creation of complex, multi-step conversational flows within a Telegram bot, such as forms or questionnaires, by providing a structured way to manage state, validation, and user interaction.

Core Features & Use Cases

  • Wizard Creation: Define multi-step conversational flows using @WizardHandler and WizardStep.
  • State Management: Automatically persists and retrieves typed state between steps.
  • Validation: Implement custom validation logic for user input at each step.
  • Use Case: Build a user registration process that asks for name, age, and email in sequence, validating each input before proceeding or retrying.

Quick Start

Annotate an object with @WizardHandler and define nested classes extending WizardStep to create your wizard.

Frequently Asked Questions about build-wizard-flow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create multi-step wizard flows in a Kotlin Telegram bot?

You can create multi-step wizard flows in a Kotlin Telegram bot by using `@WizardHandler` annotations and defining nested classes that extend `WizardStep` to manage conversational state and transitions. This approach simplifies complex user interactions like forms.

What is the best way to manage conversational state for Telegram bot questionnaires?

Managing conversational state for Telegram bot questionnaires is handled automatically by leveraging Kotlin Symbol Processing (KSP) for code generation, which persists and retrieves typed state between wizard steps without manual state tracking.

How do I validate user input at each step of a Telegram bot wizard?

You validate user input at each step of a Telegram bot wizard by implementing custom validation logic within your `WizardStep` classes, allowing the flow to proceed only after successful verification or retrying the step on invalid data.

Do I need Kotlin Symbol Processing to build conversational wizards?

Yes, Kotlin Symbol Processing (KSP) is required to build conversational wizards with this approach. KSP handles the code generation that simplifies the development and runtime logic for state management and step transitions.

Can I use fluent API to define complex Telegram bot interactions?

Yes, you can use a fluent API alongside Kotlin annotations to define complex Telegram bot interactions. This combination structures multi-step conversational flows, handling input validation and step transitions for intricate processes.