Building with AI

GramIO provides AI skills that give your AI assistant deep knowledge of the framework — every API, plugin, pattern, and best practice. Build Telegram bots faster with accurate, up-to-date context instead of the AI guessing.

Install Skills

The quickest way to add GramIO skills to your project:

npx

npx skills add gramiojs/documentation/skills

bunx

bunx skills add gramiojs/documentation/skills

This installs skills for all detected AI agents (Claude Code, Cursor, Cline, etc.) in your project.

Install Options

# Install all skills to all agents without prompts
npx skills add gramiojs/documentation/skills --all

# Install only for Claude Code
npx skills add gramiojs/documentation/skills --agent claude-code

# Install globally (available in all projects)
npx skills add gramiojs/documentation/skills --global

# Install a specific skill (@ shorthand)
npx skills add gramiojs/documentation/skills@gramio

# Or with --skill flag
npx skills add gramiojs/documentation/skills --skill gramio

# Skip confirmation prompts (useful for CI/CD)
npx skills add gramiojs/documentation/skills --yes

# List available skills without installing
npx skills add gramiojs/documentation/skills --list

Manual Install

If you prefer to copy manually:

# Clone and copy the skills directory
git clone https://github.com/gramiojs/documentation.git /tmp/gramio-docs
cp -r /tmp/gramio-docs/skills/* .claude/skills/

Available Skills

gramio — Framework Knowledge (Auto)

The core skill. Activates automatically when you ask about GramIO. Contains:

• 12 runnable examples — basic bot, keyboards, callbacks, formatting, files, errors, webhooks, sessions, scenes, Telegram Stars, TMA, Docker
• 18 reference docs — bot configuration, API, context, triggers, hooks, updates & lifecycle, keyboards, formatting, files, CallbackData, storage, Telegram Stars, types, webhooks, rate limits, Docker, TMA, plugin development
• 6 plugin guides — session, scenes, i18n, autoload, prompt, and others

You don't invoke this skill — your AI assistant reads it automatically when relevant.

/gramio-pick-username — Pick a Bot Username

/gramio-pick-username weather bot for Russian users
/gramio-pick-username крипто-трекер
/gramio-pick-username is @weatherly_bot free?

Generates candidate Telegram bot usernames that satisfy BotFather's rules (5–32 chars, a-z0-9_, ends in bot, no leading digit / leading-trailing / consecutive underscores), checks availability on t.me by inspecting the main CTA button text (Start Bot / View Bot = taken, Send Message = free), and returns a ranked shortlist. Always reminds the user to verify the finalist in @BotFather — a name free on t.me may still be reserved from a previously deleted bot.

What the Skills Cover

The gramio skill gives your AI assistant knowledge of:

Area	Coverage
Bot constructor	All options, proxy (Node/Bun/Deno), custom API URL, test DC, info skip
API calls	bot.api.*, suppress: true, withRetries(), type helpers, debugging
Triggers	command, hears, callbackQuery, inlineQuery, chosenInlineResult, reaction
Context	derive (scoped/global), decorate, middleware, context.is() narrowing
Hooks	onStart, onStop, onError (scoped, custom kinds), preRequest, onResponse, onResponseError
Keyboards	All button types, layout helpers (.columns(), .pattern(), .wrap()), styling, RemoveKeyboard, ForceReply
Formatting	All entities (bold, italic, code, pre, link, mention, spoiler...), join(), restrictions
Files	MediaUpload (path/url/buffer/stream/text), MediaInput, download, Bun.file()
CallbackData	Type-safe schemas with .number(), .string(), .pack(), queryData
Storage	In-memory, Redis, Cloudflare KV adapters, custom adapters
Webhooks	Elysia, Fastify, Hono, Express, Koa, Bun.serve, Deno.serve, tunneling
Rate limits	withRetries(), broadcasting, @gramio/broadcast, BullMQ queues
All 11 plugins	Session, Scenes, I18n, Autoload, Prompt, Auto Retry, Media Cache, Media Group, Split, Auto Answer CB, PostHog
Plugin development	Plugin class, derive/decorate/error/group, scaffolding, lazy loading, middleware order
Telegram Stars	Invoices, pre-checkout, payments, subscriptions, inline invoices, refunds, test mode
TMA	Monorepo scaffold, mkcert HTTPS, @gramio/init-data, Elysia auth guard
Docker	Dockerfile (Node.js/Bun), multi-stage builds, Docker Compose, graceful shutdown
Types	@gramio/types standalone package, type helpers, Proxy wrapper, declaration merging
Updates & Lifecycle	start()/stop() options, graceful shutdown (SIGINT/SIGTERM), webhook shutdown order

llms.txt

GramIO generates LLM-friendly documentation at build time:

• /llms.txt — Table of contents with links to all pages
• /llms-full.txt — Complete documentation in a single text file

Any AI tool can fetch these URLs for full GramIO context. Additionally, any documentation page URL with .md appended returns raw markdown — for example, https://gramio.dev/bot-api.md returns the markdown source of the Bot API page.