diff --git a/README.md b/README.md new file mode 100644 index 0000000..c7fcabb --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Валера - ИИ-ассистент Telegram-бот + +Интеллектуальный Telegram-бот с поддержкой нескольких LLM, памятью на ChromaDB, распознаванием речи и планировщиком задач. + +## Возможности + +- **Интеграция с LLM**: qwen-code, opencode, Gigachat, YandexGPT +- **Память**: Векторная БД ChromaDB для хранения истории разговоров +- **Режимы работы**: С подтверждением и автономный +- **Распознавание речи**: Vosk или Faster-Whisper +- **Планировщик**: Напоминания и периодическая генерация идей +- **Прокси**: Поддержка SOCKS5 и MTProxy + +## Установка + +1. Клонируйте репозиторий и перейдите в директорию: +```bash +cd valera +``` + +2. Установите зависимости: +```bash +pip install -r requirements.txt +``` + +3. Скопируйте `.env.example` в `.env` и заполните настройки: +```bash +cp .env.example .env +``` + +4. Настройте переменные окружения в `.env`: +```env +TELEGRAM_BOT_TOKEN=your_bot_token +TELEGRAM_PROXY_URL= # опционально +DEFAULT_TOOL=opencode +``` + +## Запуск + +```bash +python -m src.bot.main +``` + +## Команды + +- `/start` - Начать работу +- `/help` - Показать справку +- `/mode confirm|auto` - Переключить режим +- `/use qwen|open|gigachat|yandex` - Выбрать LLM +- `/qwen|/open|/gigachat|/yandex <текст>` - Задать вопрос +- `/forget` - Очистить историю +- `/remind <текст> <время>` - Создать напоминание +- `/stt on|off` - Включить/выключить распознавание речи +- `/cancel` - Отменить текущее действие + +## Требования + +- Python 3.10+ +- qwen-code и/или opencode в PATH +- ffmpeg (для аудио) +- Модель Vosk или Faster-Whisper (опционально)