3.8 KiB
modern typescript library for mtproto
documentation
•
api reference
•
telegram chat
•
kanban board
Warning
mtcute is currently in alpha stage: the api is not very stable yet, and there may be a lot of bugs feel free to try it out, though, any feedback is appreciated!
releases may not follow semver just yet, so please pin the versions for now
import { NodeTelegramClient } from '@mtcute/node'
import { Dispatcher, filters } from '@mtcute/dispatcher'
const tg = new NodeTelegramClient({
apiId: parseInt(process.env.API_ID),
apiHash: process.env.API_HASH,
storage: 'my-account'
})
const dp = Dispatcher.for(tg)
dp.onNewMessage(filters.chat('private'), async (msg) => {
await msg.replyText('hiiii from mtcute! 🌸')
})
tg.run({
phone: () => tg.input('phone > '),
code: () => tg.input('code > '),
password: () => tg.input('password > ')
}, async (self) => {
console.log(`logged in as ${self.displayName}`)
})
mtcute is a modern, performant and ✨ cute ✨ mtproto library and bot framework, supporting both web and nodejs.
quick start
🤖 just starting a (user)bot? use the scaffolding tool:
pnpm create @mtcute/bot
🏭 want to integrate it into your existing nodejs app? use the nodejs wrapper:
pnpm add @mtcute/node
# for native crypto
pnpm add @mtcute/crypto-node
✨ building something for web? use the client directly:
pnpm add @mtcute/client
learn more: guide
features
- 🍰 simple: mtcute hides all the complexity and provides a clean and modern API
- ✨ compatible: mtcute supports almost everything Bot API does, and even more!
- 🍡 lightweight: Running instance uses less than 50 MB of RAM.
- 🛡️ type-safe: Most of the APIs (including MTProto) are strictly typed to help your workflow
- ⚙️ hackable: Almost every aspect of the library is customizable, including networking and storage
- 🕙 up-to-date: mtcute uses the latest TL schema to provide the newest features as soon as possible
cat in the readme 🐈
setting up for development
git clone https://github.com/mtcute/mtcute
fnm use # or `nvm use`
cd mtcute
pnpm install --frozen-lockfile
# generate code from tl schema
pnpm -C packages/tl run gen-code
acknowledgements
some parts were based on or greatly inspired by these projects: