GramIO

English

Русский

English

Русский

Appearance

Get Started ​

Create a new bot with GramIO in minutes. You should already have Node.js, Bun or Deno installed.

Obtain your bot token ​

First, create a bot and get a token. You can do this using the @BotFather bot.

Send him the /newbot command and follow the instructions until you receive a token like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw.

Create your bot project ​

There are two ways to create a bot project:

Automatically ​

The easiest way is to use create-gramio.

bash
npm create gramio bot-example
bash
yarn create gramio bot-example
bash
pnpm create gramio bot-example
bash
bunx create-gramio bot-example

And then:

bash
cd bot-example
npm run dev
bash
cd bot-example
yarn dev
bash
cd bot-example
pnpm dev
bash
cd bot-example
bun dev

Supported environment ​

The environment can work together

When you select ESLint and Drizzle, you get eslint-plugin-drizzle

Manually ​

To manually create a new bot with GramIO, install the package:

bash
npm install gramio
bash
yarn add gramio
bash
pnpm add gramio
bash
bun install gramio

Setup TypeScript:

bash
npm install typescript -D
npx tsc --init
bash
yarn add typescript -D
yarn dlx tsc --init
bash
pnpm add typescript -D
pnpm exec tsc --init
bash
bun install typescript -D
bunx tsc --init

create src folder with index.ts file and write something like:

ts
import { 
Bot
 } from "gramio";

const 
bot
 = new 
Bot
("") // put you token here
    .
command
("start", (
context
) => 
context
.
send
("Hi!"))
    .
onStart
(
console
.
log
);


bot
.
start
();
ts
import { Bot } from "jsr:@gramio/core";

const bot = new Bot("") // put you token here
    .command("start", (context) => context.send("Hi!"))
    .onStart(console.log);

bot.start();

and run the bot with:

bash
npx tsx ./src/index.ts
bash
bun ./src/index.ts
bash
deno run --allow-net --allow-env ./src/index.ts

Done! 🎉

Now you can interact with your Telegram bot.