# The Telegram Bot Framework

[![Bot API](https://img.shields.io/badge/Bot%20API-7.9-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api) [![Deno](https://shield.deno.dev/x/grammy)](https://deno.land/x/grammy) [![npm](https://img.shields.io/npm/v/grammy?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/grammy) [![All Contributors](https://img.shields.io/github/all-contributors/grammyjs/grammy?style=flat&labelColor=000&color=3b82f6)](#contributors-) ## _[docs.](https://grammy.dev) [reference.](https://grammy.dev/ref) [chat.](https://telegram.me/grammyjs) [news.](https://telegram.me/grammyjs_news)_

**grammY makes it easy to create Telegram bots.** Both for beginners and at scale. You want grammY because it is easy to use. It is very powerful and always up to date. It has the best [documentation](https://grammy.dev) in town. It is extremely efficient and scales up effortlessly. It has a thriving ecosystem of plugins, a friendly community chat, seamless integrations with web frameworks and databases, and so much more. Are you ready? 🤖🚀 Bots are written in [TypeScript](https://www.typescriptlang.org/) (or JavaScript) and run on [Node.js](https://nodejs.org/) or [Deno](#deno-support). ## Quickstart > If you are new to Telegram bots, read the official [Introduction for Developers](https://core.telegram.org/bots) written by the Telegram team. Visit [@BotFather](https://t.me/BotFather) and create a new bot. You will obtain a **bot token**. Create a new directory and run ```bash npm install grammy ``` inside it. Then create a file `bot.js` with this content: ```ts const { Bot } = require("grammy"); // Create a bot object const bot = new Bot(""); // <-- place your bot token in this string // Register listeners to handle messages bot.on("message:text", (ctx) => ctx.reply("Echo: " + ctx.message.text)); // Start the bot (using long polling) bot.start(); ``` Now you can run the bot via ```bash node bot.js ``` and it will echo all received text messages. Congrats! You just wrote a Telegram bot :) ## Going Further grammY has an excellent [documentation](https://grammy.dev), and an [API Reference](https://grammy.dev/ref). It even integrates with your code editor, e.g. [VS Code](https://code.visualstudio.com/). You can hover over any element of grammY to get a detailed description of what that thing does or means. If you are still stuck, just join the [Telegram chat](https://t.me/grammyjs) and ask for help. People are nice there and we appreciate your question, no matter what it is :) Here are some more resources to support you: ## Resources ### [grammY website](https://grammy.dev) —main project website and documentation. Gets you started and explains all concepts. ### [grammY API reference](https://grammy.dev/ref) —reference of everything that grammY exports. Useful to look up descriptions about any element of grammY. ### [grammY examples](https://github.com/grammyjs/examples) —repository full of example bots. Includes a setup to easily run any of them. ### [Awesome grammY](https://github.com/grammyjs/awesome-grammY) —list of awesome projects built with grammY. Helpful if you want to see some real-world usage. ### [grammY chat](https://t.me/grammyjs) —The chat where you can ask any question about grammY or bots in general. We are also open for feedback, ideas, and contributions! The Russian community chat can be found [here](https://t.me/grammyjs_ru). ### [grammY news](https://t.me/grammyjs_news) —The channel where updates to grammY and the ecosystem are posted. We are also [on Twitter](https://twitter.com/grammy_js). ### [Telegram Bot API Reference](https://core.telegram.org/bots/api) —documentation of the API that Telegram offers, and that grammY connects to under the hood. ## Deno Support All grammY packages published by [@grammyjs](https://github.com/grammyjs) run natively on [Deno](https://deno.land). We are compiling every codebase to still run on Node.js. However, given that most bot developers are still using Node.js, all documentation is written Node.js-first. We may migrate it if Deno overtakes Node.js. If you are already on Deno today, import grammY from [`https://deno.land/x/grammy/mod.ts`](https://deno.land/x/grammy). You may also be interested in [why we support Deno](https://grammy.dev/resources/faq.html#why-do-you-support-deno). ## JavaScript Bundles The grammY core package in this repository is available as a JavaScript bundle via . This lets you transpile all published versions including current `main` branch to standalone JavaScript files. For example, the most recent source on `main` is available from . Being compatible with browsers is especially useful for running bots on Cloudflare Workers. For this reason, we also include a web bundle in our npm package. You can simply do `import { Bot } from "grammy/web"`. ## [Contribution Guide »](./CONTRIBUTING.md) ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_KnorpelSenf 🤔 💻 📖 🎨 💡 ⚠️ 🔌 📦 👀 🧑‍🏫 📆 🚇 🔊 ️️️️♿️	_Heero 🔌 📓 💡 📖 👀 💻 🤔	_{Wojciech Pawlik} 🤔 👀 🚇 📦 🔧	_{Alessandro Bertozzi} 📖	_trgwii 💻 👀	_KnightNiwrem 💻 🐛 🔌 📖 💡 👀 🧑‍🏫	_{Muthu Kumar} 👀	_EdJoPaTo 🔌 📖 🤔 👀 🐛 💻	_{Amir Zouerami} 📖 🔌 💡
_Roj 📖 👀 🚇 🌍 💻 🤔 🧑‍🏫 💡	_jokasimr 🐛	_{Ciki Momogi} 📖 🌍	_AndreoliBR 👀	_{Kirill Loskutov} 📖 🐛 🤔 🎨 💬 👀 💻 🔌	_{Andrew Lane} 🐛 👀	_{code-withAshish} 📖 💬 🐛 👀	_{Stephane Mensah} 🐛 🔌	_Asaku01 📖
_ppsimn 🐛	_Satont 🔌 📖	_deptyped 💡 📖 ✅ 🐛 🌍	_{Jacek Nowacki} 📖 💻 🐛 👀 🤔	_{Outvi V} 💻	_{Ikko Ashimine} 📖	_{Yevhen Denesiuk} 👀 🐛 💻	_prastian 🐛 💻	_{Sayem Chowdhury} 🤔
_kospra 🤔 💻	_Chimit 📖	_Calsi 📖	_{Jonas Zohren} 🐛 💻	_linbuxiao 📖 🌍	_JiquanWang99 📖 🌍	_{Borhan Hafez} 🔌	_WingLim 📖 🌍 💻 🔌 🤔	_taotie111 📖 🌍
_Merlin 📖	_Darvesh 🐛 💻 👀	_dcdunkan 🐛 💻 🔌 👀 📖 🤔 🚇 🔧 🧑‍🏫 🚧	_Kid 📖 🌍	_{Slava Fomin II} 🐛 📖	_{Kiko Beats} 📖	_Vsevolod 💻 🤔 👀	_Habemuscode 👀 📖 🌍 🚧	_{Nikita Kolmogorov} 🔌
_{Vitaliy Meshchaninov} 🐛 💻	_{Дилян Палаузов} 🐛 💻	_lmx-Hexagram 📖	_{Ilya Semenov} 🤔 👀 💻	_{abdollahzadehAli} 📖 💡	_{Saeed Nasiri} 📖	_Hesoyam 📖	_yrzam 🐛	_drmikecrowe 👀
_Martin 📖 🐛 👀	_Pavel 💡	_{Thor 雷神 Schaeff} 💡	_x066it 🐛 👀	_kolay 👀	_{Evgeny Nepomnyashchiy} 👀	_{Ananta Krsna dasa} 📖	_{Mighty Ali} 💻 👀 🤔	_三三 🐛 💻
_Roz 🐛 💻 👀 🚇 🤔 🧑‍🏫 🔌	_{Dani Haro} 💻 🔌 📖	_Ryukaizen 📖	_{Alisher Ortiqov} 📖	_{Tony Tkachenko} 📖	_Ra 💻	_{sartoshi-foot-dao} 📖	_{Yoel Navas E.} 🤔	_{Vitor Gomes} 🐛 💻
_Aditya 🐛 👀	_{Udit Karode} 👀	_{Mike Rockétt} 👀 🐛	_{Srinivasa IK Varanasi} 💻	_abdoo9 🐛 💻 👀 📖	_ak4zh 👀 🤔 💻	_{Nikolay Lapshin} 💻	_Aquatica 📖 💬	_{Fa Dzikri} 👀 📖 🌍
_{Chandler Lattin} 💻 👀 🔌	_{Sergey Parfenyuk} 🐛	_{Émerson Felinto} 🐛	_{Petr Stankin} 🐛	_{Maxim Lebedev} 🤔 💻	_Madnex 📖	_{Svyatoslav Tupchienko} 💻	_{Vladislav Deryabkin} 🐛 💻 👀	_{Kashyap Sharma} 💡
_AlexOwl 🐛 💻	_{Shrimadhav U K} 💻	_{Binamra Lamsal} 🤔	_gertminov 📖 ✅	_{Stephan Psaras} 🐛	_{shevernitskiy} 🐛 👀 💻	_mrmaster009 📖	_{Andrey Zontov} 🐛 💻 💬 🤔 📖 🌍	_{Abbass Al-Musawi} 📖 🐛 💻
_ArunR 🐛 💻	_NDA 🐛 🤔 💻	_MatyiFKBT 📖	_{Chris Andrew C. L.} 🐛 💻 👀	_{Islam Kiiasov} 💻	_{Shane Avery Sistoza} 🤔 💻 ⚠️	_Maicol 💻	_{Nazar Antoniuk} 📖 🌍 🚧	_{Aleksei Ivanov} 👀
_{Vladislav Ponomarev} ⚠️ 💻 📦	_{Louie Tan} 👀	_{Leandro Vargas} 🐛 💻	_{Sean Yap} 🐛 💻	_{Sergey Solovev} 🤔 👀	_{Sree (Taylor's Version)} 🐛 💻	_{Yaroslav Vovchenko} 🐛 💻	_gabe 👀	_{Lavrentiy Rubtsov} 📖
_{Josh Gillies} 💻	_{Uladzislau Hramyka} 🐛	_{Gabriele Belluardo} 🐛 💻	_{Dim Chen} 🐛 💻	_fwqaaq 🤔 💻	_{Janek Szynal} 🤔	_{Alexander Mordvinov} 🤔	_Ash 👀	_{Winston H.} 🤔 💻 👀 ⚠️
_{Hero Protagonist} 💻 🐛 🤔 🔌	_{Mobin Askari} 🔌	_Ubertao 🤔 💻	_Grigory 🤔 💻 📖	_aleveha 💻	_barinbritva 👀	_{Lyudmil Ivanov} 💡	_lexomis 👀	_{Andrew Sologor} 👀
_rayz 💬

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!