Get started

Create 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 the command /newbot and follow the instructions until you receive a token like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw.

Scaffolding the project

This command will help you create a project with GramIO the easiest way.

npm

npm create gramio@latest ./bot

yarn

yarn create gramio@latest ./bot

pnpm

pnpm create gramio@latest ./bot

bun

bun create gramio@latest ./bot

deno

TODO:// Deno is supported but not in scaffolding

Supported environment

• ORM/Query builders
• • Prisma
• • Drizzle
• Linters
• • Biome
• • ESLint with some plugins
• Plugins
• • Scenes
• • Session
• • Autoload
• • Prompt
• • Auto-retry
• • Media-cache
• • I18n
• • Media-group
• Others
• • Dockerfile + docker-compose.yml
• • Jobify (Bullmq wrapper)
• • Husky (Git hooks)
• • Fluent2ts
• • GramIO storages
• Telegram apps
• Elysia (by create-elysiajs)

The environment can work together

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

Manual installation

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

npm

npm install gramio

yarn

yarn add gramio

pnpm

pnpm add gramio

bun

bun install gramio

Setup TypeScript:

npm

npm install typescript -D
npx tsc --init

yarn

yarn add typescript -D
yarn dlx tsc --init

pnpm

pnpm add typescript -D
pnpm exec tsc --init

bun

bun install typescript -D
bunx tsc --init

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

Bun or Node.js

import { Bot } from "gramio";

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

bot.start();

Deno

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:

tsx

npx tsx ./src/index.ts

bun

bun ./src/index.ts

deno

deno run --allow-net ./src/index.ts

Done! 🎉

Now you can interact with your Telegram bot.