Skip to content

grammyjs/grammY

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
grammY

The Telegram Bot Framework.

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 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 (or JavaScript) and run on Node.js or Deno.

Quickstart

If you are new to Telegram bots, read the official Introduction for Developers written by the Telegram team.

Visit @BotFather and create a new bot. You will obtain a bot token.

Create a new directory and run

npm install grammy

inside it. Then create a file bot.js with this content:

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

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, and an API Reference. It even integrates with your code editor, e.g. VS Code. 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 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

—main project website and documentation. Gets you started and explains all concepts.

grammY API Reference

—reference of everything that grammY exports. Useful to look up descriptions about any element of grammY.

grammY Example Bots

—repository full of example bots. Includes a setup to easily run any of them.

Awesome grammY

—list of awesome projects built with grammY. Helpful if you want to see some real-world usage.

grammY Telegram Chat

—Telegram 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.

grammY News Channel

—Telegram channel where updates to grammY and the ecosystem are posted. We are also on Twitter.

Telegram Bot API Reference

—documentation of the API that Telegram offers, and that grammY connects to under the hood.

Deno Support

All grammY packages published by @grammyjs run natively on Deno. 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.

You may also be interested in why we support Deno.

JavaScript Bundles

The grammY core package in this repository is available as a JavaScript bundle via https://bundle.deno.dev/. 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 https://bundle.deno.dev/https://raw.githubusercontent.com/grammyjs/grammY/main/src/mod.ts.

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 »

Contributors

Thanks goes to these wonderful people (emoji key):

KnorpelSenf
KnorpelSenf

🤔 💻 📖 🎨 💡 ⚠️ 🔌 📦 👀 🧑‍🏫 📆 🚇
Heero
Heero

🔌 📓 💡 📖 👀 💻 🤔
Wojciech Pawlik
Wojciech Pawlik

🤔 👀 🚇 📦 🔧
Alessandro Bertozzi
Alessandro Bertozzi

📖
trgwii
trgwii

💻 👀
KnightNiwrem
KnightNiwrem

💻 🐛 🔌 📖 💡 👀 🧑‍🏫
Muthu Kumar
Muthu Kumar

👀
EdJoPaTo
EdJoPaTo

🔌 📖 🤔 👀 🐛 💻
Amir Zouerami
Amir Zouerami

📖 🔌 💡
Roj
Roj

📖 👀 🚇 🌍 💻 🤔 🧑‍🏫 💡
jokasimr
jokasimr

🐛
Ciki Momogi
Ciki Momogi

📖 🌍
AndreoliBR
AndreoliBR

👀
Kirill Loskutov
Kirill Loskutov

📖 🐛 🤔 🎨 💬 👀 💻 🔌
Andrew Lane
Andrew Lane

🐛 👀
code-withAshish
code-withAshish

📖 💬
Stephane Mensah
Stephane Mensah

🐛 🔌
Asaku01
Asaku01

📖
ppsimn
ppsimn

🐛
Satont
Satont

🔌 📖
deptyped
deptyped

💡 📖 🐛
Jacek Nowacki
Jacek Nowacki

📖 💻 🐛 👀 🤔
Outvi V
Outvi V

💻
Ikko Ashimine
Ikko Ashimine

📖
Yevhen Denesiuk
Yevhen Denesiuk

👀 🐛 💻
prastian
prastian

🐛 💻
Sayem Chowdhury
Sayem Chowdhury

🤔
kospra
kospra

🤔 💻
Chimit
Chimit

📖
Calsi
Calsi

📖
Jonas Zohren
Jonas Zohren

🐛 💻
linbuxiao
linbuxiao

📖 🌍
JiquanWang99
JiquanWang99

📖 🌍
Borhan Hafez
Borhan Hafez

🔌
WingLim
WingLim

📖 🌍 💻 🔌 🤔
taotie111
taotie111

📖 🌍
Merlin
Merlin

📖
Darvesh
Darvesh

🐛 💻 👀
dcdunkan
dcdunkan

🐛 💻 🔌 👀 📖 🤔 🚇 🔧
Kid
Kid

📖 🌍
Slava Fomin II
Slava Fomin II

🐛 📖
Kiko Beats
Kiko Beats

📖
Vsevolod
Vsevolod

💻 🤔 👀
Habemuscode
Habemuscode

👀 📖 🌍
Nikita Kolmogorov
Nikita Kolmogorov

🔌
Vitaliy Meshchaninov
Vitaliy Meshchaninov

🐛 💻
Дилян Палаузов
Дилян Палаузов

🐛 💻
lmx-Hexagram
lmx-Hexagram

📖
Ilya Semenov
Ilya Semenov

🤔 👀 💻
abdollahzadehAli
abdollahzadehAli

📖 💡
Saeed Nasiri
Saeed Nasiri

📖
Hesoyam
Hesoyam

📖
yrzam
yrzam

🐛
drmikecrowe
drmikecrowe

👀
Martin
Martin

📖 🐛 👀
Pavel
Pavel

💡
Thor 雷神 Schaeff
Thor 雷神 Schaeff

💡
x066it
x066it

🐛 👀
kolay
kolay

👀
Evgeny Nepomnyashchiy
Evgeny Nepomnyashchiy

👀
Ananta Krsna dasa
Ananta Krsna dasa

📖
Mighty Ali
Mighty Ali

💻 👀 🤔
三三
三三

🐛 💻
Roz
Roz

🐛 💻 👀 🚇 🤔
Dani Haro
Dani Haro

💻 🔌 📖
Ryukaizen
Ryukaizen

📖
Alisher Ortiqov
Alisher Ortiqov

📖
Tony Tkachenko
Tony Tkachenko

📖
Ra
Ra

💻
sartoshi-foot-dao
sartoshi-foot-dao

📖
Yoel Navas E.
Yoel Navas E.

🤔
Vitor Gomes
Vitor Gomes

🐛 💻
Aditya
Aditya

🐛 👀
Udit Karode
Udit Karode

👀
Mike Rockétt
Mike Rockétt

👀 🐛
Srinivasa IK Varanasi
Srinivasa IK Varanasi

💻
abdoo9
abdoo9

🐛 💻
ak4zh
ak4zh

👀 🤔 💻
Nikolay Lapshin
Nikolay Lapshin

💻
Aquatica
Aquatica

📖 💬
Fa Dzikri
Fa Dzikri

👀 📖 🌍
Chandler Lattin
Chandler Lattin

💻 👀 🔌
Sergey Parfenyuk
Sergey Parfenyuk

🐛
Émerson Felinto
Émerson Felinto

🐛
Petr Stankin
Petr Stankin

🐛
Maxim Lebedev
Maxim Lebedev

🤔 💻
Madnex
Madnex

📖
Svyatoslav Tupchienko
Svyatoslav Tupchienko

💻
Vladislav Deryabkin
Vladislav Deryabkin

🐛 💻 👀
Kashyap Sharma
Kashyap Sharma

💡
AlexOwl
AlexOwl

🐛 💻
Shrimadhav U K
Shrimadhav U K

💻
Binamra Lamsal
Binamra Lamsal

🤔
gertminov
gertminov

📖
Stephan Psaras
Stephan Psaras

🐛
shevernitskiy
shevernitskiy

🐛 👀
mrmaster009
mrmaster009

📖
Andrey Zontov
Andrey Zontov

🐛 💻 💬 🤔
Abbass Al-Musawi
Abbass Al-Musawi

📖
ArunR
ArunR

🐛 💻
NDA
NDA

🐛 🤔 💻
MatyiFKBT
MatyiFKBT

📖
Chris Andrew C. L.
Chris Andrew C. L.

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!