Руководство пользователя
Tip
Когда читать этот документ: если вам нужно установить окружение, настроить config.toml, управлять компонентами с помощью epsdk или развернуть бота в рабочей среде — обращайтесь к этому руководству по мере необходимости; если нет — можете пропустить.
Здесь описаны все повседневные операции с ботом «после запуска»: установка, настройка, управление через командную строку, развёртывание и обновление.
Содержание
| Документ | Описание |
|---|---|
| Установка и настройка | Требования к системе, способы установки (pip/uv/Docker), проверка установки |
| ErisPulse-App мобильный/настольный клиент | Официальный клиент: запуск на телефоне / настольном компьютере, управление экземпляром ErisPulse через нативный интерфейс |
| Справочник команд CLI | Полное описание использования командной строки epsdk |
| Описание конфигурационного файла | Подробное описание всех параметров в файле config/config.toml |
| Руководство по развертыванию | Развертывание с помощью Docker, служба systemd, настройка SSL |
Быстрая справка
Часто используемые команды
| Команда | Описание |
|---|---|
epsdk init |
Инициализация проекта (-q быстрый режим, -n указать имя) |
epsdk install <имя_пакета> |
Установка модуля/адаптера (без параметров запускает интерактивный режим) |
epsdk config <имя> |
Интерактивная конфигурация декларативных параметров адаптера/модуля |
epsdk run main.py |
Запуск проекта (--reload режим горячей перезагрузки) |
epsdk list |
Список установленных модулей/адаптеров |
epsdk upgrade <имя_пакета> |
Обновление модуля/адаптера |
epsdk doctor |
Диагностика окружения (Python/бэкенд/конфигурация/доступность PyPI) |
Полный список команд и описание параметров можно найти в Справке по командной строке.
Распространённые места конфигурации
| Параметр | Описание | См. также |
|---|---|---|
[ErisPulse.server] |
Конфигурация сервера (хост, порт) | Описание файла конфигурации |
[ErisPulse.logger] |
Конфигурация логирования (уровень, файл вывода) | Описание файла конфигурации |
[ErisPulse.framework] |
Конфигурация фреймворка (ленивая загрузка) | Описание файла конфигурации |
[ErisPulse.event.command] |
Конфигурация событий команд (префикс) | Описание файла конфигурации |
[имя_адаптера] |
Специфичная конфигурация каждого адаптера | Руководство по особенностям платформы |
Следующие шаги
- Ещё не запустили проект: сначала посмотрите Быстрый старт, а затем системно изучите Руководство для начинающих
- Хотите писать собственные модули / адаптеры: переходите к Руководству разработчика
- Нужно найти конкретные методы какого-либо класса: обратитесь к Справочнику API