GramIO

English

Русский

English

Русский

Appearance

GramIO

Create your Telegram bots with convenience!

Get started

Alpha

The project is currently in development (but it can already be used)

🔥

Fast start project

With npm create gramio you can quickly start a project in various configurations without wasting time on boring setup

✨

Extensible

Our plugin and hook system is awesome

⚙️

Code-generated

Many parts are code-generated

🛡️

Type-safe

Written in TypeScript with love ❤️

Get started ​

This command will help you create a project with GramIO (and ORM, linters and plugins) the easiest way.

bash
npm create gramio@latest ./bot
bash
yarn create gramio@latest ./bot
bash
pnpm create gramio@latest ./bot
bash
bun create gramio@latest ./bot
bash
TODO:// Deno is supported but not in scaffolding

For more information, see the «Get started» section.

GramIO in action ​

Example which uses some interesting features.

ts
import { 
Bot
, 
format
, 
bold
, 
code
 } from "gramio";
import { 
findOrRegisterUser
 } from "./utils";

const 
bot
 = new 
Bot
(
process
.
env
.
BOT_TOKEN
 as string)
    .
derive
("message", async () => {
        const 
user
 = await 
findOrRegisterUser
();

        return {
            
user
,
        };
    })
    .
on
("message", (
context
) => {
        
context
.
user
;
        //
        //
        //
        //
        //
        //
        //

        return 
context
.
send
(
format
`
        Hi, ${
bold
(
context
.
user
.
name
)}! 
        You balance: ${
code
(
context
.
user
.
balance
)}`);
    })
    .
on
("callback_query", (
context
) => {
        //
        //
        
context
.user;
Property 'user' does not exist on type 'CallbackQueryContext<Bot<{}, DeriveDefinitions & { message: { user: { id: number; name: string; balance: number; }; }; }>>'.
    });