Files
telegram-tui/README.md
2026-05-17 03:56:04 +03:00

71 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# tele-tui
Консольный Telegram-клиент на Rust с Vim-style навигацией, Normal/Insert режимами, TDLib и поддержкой русской раскладки.
## Возможности
- Авторизация через TDLib, список чатов, история и realtime updates.
- Отправка, редактирование, удаление, reply, forward, copy и реакции.
- Поиск по чатам и внутри открытого чата.
- Telegram-папки, pinned/muted/mentions/unread indicators.
- Markdown entities, inline фото, fullscreen image modal и фото-альбомы.
- Голосовые сообщения через `ffplay`.
- Desktop notifications, clipboard и открытие URL через feature flags.
- Multi-account profiles, account switcher и per-account lock files.
## Установка
Требования:
- Rust stable, рекомендовано 1.85+.
- TDLib скачивается автоматически через `tdlib-rs` feature `download-tdlib`.
- Для голосовых сообщений нужен `ffplay` из ffmpeg.
```bash
cargo build --release
```
## Credentials
Получите Telegram API credentials на <https://my.telegram.org/apps> и сохраните их в:
```text
~/.config/tele-tui/credentials
```
Формат:
```text
API_ID=your_api_id
API_HASH=your_api_hash
```
Для локальной разработки можно использовать `.env` в корне проекта с теми же ключами.
## Запуск
```bash
cargo run --release
```
Для выбора аккаунта:
```bash
cargo run --release -- --account work
```
Runtime-конфиг создаётся в `~/.config/tele-tui/config.toml`; пример лежит в [config.toml.example](config.toml.example).
## Документация
- [AGENT.md](AGENT.md) - краткие правила для агента.
- [DEVELOPMENT.md](DEVELOPMENT.md) - локальные правила разработки и проверок.
- [CONTEXT.md](CONTEXT.md) - текущий статус, риски и следующие шаги.
- [docs/HOTKEYS.md](docs/HOTKEYS.md) - горячие клавиши.
- [docs/PROJECT_STRUCTURE.md](docs/PROJECT_STRUCTURE.md) - карта подсистем.
- [docs/TDLIB_INTEGRATION.md](docs/TDLIB_INTEGRATION.md) - проектные заметки по TDLib.
## Лицензия
MIT