Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lukan.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Telegram plugin connects Lukan to Telegram using the Bot API with long polling. No public URL or webhook setup needed.

​
Setup

# Install the plugin
lukan plugin install telegram

# Set your bot token (from @BotFather)
lukan tg config set botToken "YOUR_BOT_TOKEN"

# Start the plugin
lukan plugin start telegram

​
Getting a Bot Token

  1. Open Telegram and message @BotFather
  2. Send /newbot and follow the prompts
  3. Copy the bot token

​
Configuration

FieldDescription
botTokenTelegram Bot API token from @BotFather
whitelistAllowed user IDs (empty = allow all)
allowedGroupsAllowed group/chat IDs
prefixCommand prefix filter (e.g. /ai)

​
Commands

CommandDescription
lukan tg configView/edit plugin configuration
lukan plugin start telegramStart the plugin
lukan plugin stop telegramStop the plugin
lukan plugin restart telegramRestart the plugin

​
Tools

The agent has access to these Telegram-specific tools when running via the plugin:
  • TelegramSend — Send text messages
  • TelegramSendMedia — Send photos, documents, audio, video
  • TelegramGetChats — List chats with message history
  • TelegramReadMessages — Read message history from a chat
  • TelegramGetChatInfo — Get chat metadata

​
Pipeline Approvals

Telegram works as a notification channel for pipeline approval gates. Set telegram as the notification plugin and use the numeric chat ID as the channel. Chat IDs are negative for groups (e.g. -1001234567890) and positive for private chats.