# mtcute

> A modern TypeScript MTProto library and Telegram bot framework

Full API reference is available [here](https://ref.mtcute.dev/), although you SHOULD prefer reading types from LSP instead.

## Table of Contents

### Getting started

- [Quick start](https://mtcute.dev/guide.md)
- [Signing in](https://mtcute.dev/guide/intro/sign-in.md)
- [Getting updates](https://mtcute.dev/guide/intro/updates.md)
- [Handling errors](https://mtcute.dev/guide/intro/errors.md)
- [MTProto vs. Bot API](https://mtcute.dev/guide/intro/mtproto-vs-bot-api.md)
- [FAQ](https://mtcute.dev/guide/intro/faq.md)
- [LLM Assistance](https://mtcute.dev/guide/intro/llm-assistance.md)

### Topics

- [Peers](https://mtcute.dev/guide/topics/peers.md)
- [Storage](https://mtcute.dev/guide/topics/storage.md)
- [Transport](https://mtcute.dev/guide/topics/transport.md)
- [Parse modes](https://mtcute.dev/guide/topics/parse-modes.md)
- [Files](https://mtcute.dev/guide/topics/files.md)
- [Keyboards](https://mtcute.dev/guide/topics/keyboards.md)
- [Inline mode](https://mtcute.dev/guide/topics/inline-mode.md)
- [Conversation](https://mtcute.dev/guide/topics/conversation.md)
- [Raw API](https://mtcute.dev/guide/topics/raw-api.md)

### Dispatcher

- [Introduction](https://mtcute.dev/guide/dispatcher/intro.md)
- [Handlers](https://mtcute.dev/guide/dispatcher/handlers.md)
- [Filters](https://mtcute.dev/guide/dispatcher/filters.md)
- [Groups and propagation](https://mtcute.dev/guide/dispatcher/groups-propagation.md)
- [Handling errors](https://mtcute.dev/guide/dispatcher/errors.md)
- [Middlewares](https://mtcute.dev/guide/dispatcher/middlewares.md)
- [Inline mode](https://mtcute.dev/guide/dispatcher/inline-mode.md)
- [State](https://mtcute.dev/guide/dispatcher/state.md)
- [Rate limit](https://mtcute.dev/guide/dispatcher/rate-limit.md)
- [Child Dispatchers](https://mtcute.dev/guide/dispatcher/children.md)
- [Scenes](https://mtcute.dev/guide/dispatcher/scenes.md)
- [Dependency Injection](https://mtcute.dev/guide/dispatcher/di.md)

### Advanced

- [Tree-shaking](https://mtcute.dev/guide/advanced/treeshaking.md)
- [Workers](https://mtcute.dev/guide/advanced/workers.md)
- [Converting sessions](https://mtcute.dev/guide/advanced/session-convert.md)
- [Network middlewares ](https://mtcute.dev/guide/advanced/net-middlewares.md)
- [Object serialization](https://mtcute.dev/guide/advanced/serialization.md)
- [Custom schema](https://mtcute.dev/guide/advanced/custom-schema.md)

### Other

- [mtcute docs](https://mtcute.dev/README.md)