Справочник командной строки
Tip
Когда нужно читать эту страницу: забыли параметры команды epsdk, хотите добавить управление компонентами в скрипт, или хотите контролировать поведение run / stop / restart. Для повседневного использования init / install / run достаточно знать одну команду: epsdk <команда> --help — всегда можно посмотреть описание параметров, не читая всю статью.
epsdk — это инструмент командной строки ErisPulse: инициализация проекта, установка / обновление модулей и адаптеров, интерактивная настройка компонентов, запуск и остановка робота, диагностика среды — всё это доступно одной командой.
Совет:
epsdk(без команды) показывает основную справку по категориям: Проект (init / create / run), Управление компонентами (install / uninstall / upgrade / list / list-remote / types), Конфигурация и диагностика (config / doctor / i18n), Прочее (self-update / version).
Команды управления пакетами
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
install |
i, add |
[пакет]... [--upgrade/-U] [--pre] [-e ПУТЬ] [--user] [--no-deps] [-t КАТАЛОГ] [--index-url URL] [--extra-index-url URL] [--no-cache-dir] [-r ФАЙЛ] [-c ФАЙЛ] [--force-reinstall] [--ignore-installed] [--compile/--no-compile] [--prefix КАТАЛОГ] [--src КАТАЛОГ] [--config-settings НАСТРОЙКИ] [--no-binary ФОРМАТ] [--only-binary ФОРМАТ] [--prefer-binary] [--build-isolation/--no-build-isolation] [--upgrade-strategy {eager,only-if-needed,to-satisfy-only}] [--break-system-packages] [--no-uv] |
Установка модуля/адаптера |
uninstall |
rm, remove |
<пакет>... [--no-uv] |
Удаление модуля/адаптера |
upgrade |
up |
[пакет]... [--force/-f] [--pre] [--no-uv] |
Обновление указанного модуля или всех |
self-update |
su, update |
[версия] [--pre] [--force/-f] [--no-uv] |
Обновление SDK |
Команды диагностики
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
doctor |
diag |
[--verbose] [--fix] |
Диагностика среды и вывод отчета о состоянии; --fix пытается автоматически исправить |
install
Установка пакетов модуля или адаптера ErisPulse. Если имя пакета не указано, запускается интерактивный установщик.
Алиас: i, add
Связь с uv (2.11.1+): в проектах, управляемых uv (существует
uv.lockили[tool.uv]),install/upgrade/uninstallавтоматически используютuv add/uv remove— зависимости записываются вpyproject.tomlиuv.lock,uv syncбольше не удаляет компоненты, установленные через epsdk; в случае сбоя автоматически возвращается к uv pip / pip. Параметры, не поддерживаемые uv, например--user, используют pip. Порядок определения целевой среды:ERISPULSE_PYTHON→UV_PROJECT_ENVIRONMENT→.venvпроекта →UV_PYTHON→VIRTUAL_ENV→ текущий интерпретатор (командаepsdk doctorпоказывает полную цепочку).
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[пакет]... |
Имя пакета для установки, можно указать несколько | |
--upgrade |
-U |
Обновить до последней версии |
--pre |
Разрешить установку предварительных версий | |
--editable |
-e |
Установить в режиме редактирования (требует указания пути) |
--user |
Установить в каталог site-packages пользователя | |
--no-deps |
Не устанавливать зависимости | |
--target |
-t |
Установить в указанный каталог |
--index-url |
Указать URL зеркала PyPI | |
--extra-index-url |
Дополнительный URL зеркала PyPI (можно указать несколько) | |
--no-cache-dir |
Отключить кэш | |
--requirement |
-r |
Установка из файла requirements |
--constraint |
-c |
Установка из файла ограничений |
--force-reinstall |
Принудительная переустановка | |
--ignore-installed |
Игнорировать уже установленные пакеты | |
--compile |
Компилировать .pyc файлы после установки | |
--no-compile |
Не компилировать .pyc файлы после установки | |
--prefix |
Установить в указанный префикс каталога | |
--src |
Каталог исходного кода для установки в режиме редактирования | |
--config-settings |
Передача конфигурации сборочному бэкенду (можно указать несколько) | |
--no-binary |
Ограничение использования бинарных пакетов (например, :all:) |
|
--only-binary |
Ограничение использования только бинарных пакетов (например, :all:) |
|
--prefer-binary |
Предпочтение бинарных пакетов | |
--build-isolation |
Включить изоляцию сборки | |
--no-build-isolation |
Отключить изоляцию сборки | |
--upgrade-strategy |
Стратегия обновления: eager, only-if-needed, to-satisfy-only |
|
--break-system-packages |
Разрешить изменение системных пакетов | |
--no-uv |
Использовать pip вместо uv |
Примеры:
# Установка одного модуля
epsdk install Weather
# Установка нескольких модулей
epsdk install Yunhu Weather
# Установка из зеркала и обновление
epsdk install Weather -U --index-url https://pypi.tuna.tsinghua.edu.cn/simple
# Установка в режиме редактирования (для разработки)
epsdk install -e ./my-adapter
uninstall
Удаление установленного модуля или адаптера ErisPulse. Если имя пакета не указано, запускается интерактивный удалитель.
Алиас: rm, remove
Параметры:
| Параметр | Описание |
|---|---|
<пакет>... |
Имя пакета для удаления, можно указать несколько |
--no-uv |
Использовать pip вместо uv |
Примеры:
# Удаление одного модуля
epsdk uninstall Weather
# Удаление нескольких модулей
epsdk uninstall Yunhu Weather
upgrade
Обновление установленных компонентов ErisPulse. Если имя пакета не указано, запускается интерактивное обновление всех.
Алиас: up
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[пакет]... |
Имя пакета для обновления, можно указать несколько | |
--force |
-f |
Принудительное обновление, без подтверждения |
--pre |
Разрешить обновление до предварительных версий | |
--no-uv |
Использовать pip вместо uv |
Примеры:
# Обновление всех пакетов
epsdk upgrade
# Обновление указанного пакета
epsdk upgrade Weather
# Принудительное обновление (без подтверждения)
epsdk upgrade -f
self-update
Обновление самого ErisPulse SDK до последней версии.
Алиас: su, update
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[версия] |
Указать номер целевой версии | |
--pre |
Разрешить обновление до предварительных версий | |
--force |
-f |
Принудительное обновление, без подтверждения |
--no-uv |
Использовать pip вместо uv |
Примеры:
# Обновление до последней стабильной версии
epsdk self-update
# Обновление до указанной версии
epsdk self-update 1.2.3
# Разрешить предварительные версии
epsdk self-update --pre
# Принудительное обновление
epsdk self-update -f
Note
При установке через uv tool install ErisPulse команда автоматически заменяется на uv tool upgrade ErisPulse (при указании версии — uv tool install ErisPulse==<версия> --force), прямое обновление с помощью pip приведёт к восстановлению инвентаря uv. На Windows обновление выполняется в новом окне консоли: текущий CLI должен быть завершён для освобождения файлов инструментального окружения, после завершения обновления откройте терминал заново.
Команды для просмотра информации
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
list |
l, ls |
[--type/-t {modules,adapters,all}] [--outdated/-o] |
Вывод списка установленных компонентов |
list-remote |
lsr |
[--type/-t {modules,adapters,all}] [--refresh/-r] |
Вывод списка доступных удалённых компонентов |
version |
ver |
Вывод информации о версии SDK и Python (эквивалентно -V) |
list
Вывод списка установленных модулей и адаптеров ErisPulse.
Алиас: l, ls
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
--type |
-t |
Указать тип: modules, adapters, all (по умолчанию) |
--outdated |
-o |
Вывести только обновляемые пакеты |
Примеры:
# Вывод всех установленных компонентов
epsdk list
# Только модули
epsdk list -t modules
# Только адаптеры
epsdk list -t adapters
# Только обновляемые пакеты
epsdk list -o
list-remote
Вывод списка доступных удалённых модулей и адаптеров ErisPulse.
Алиас: lsr
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
--type |
-t |
Указать тип: modules, adapters, all (по умолчанию) |
--refresh |
-r |
Принудительное обновление кэша удалённых пакетов |
Примеры:
# Вывод всех доступных удалённых компонентов
epsdk list-remote
# Только удалённые модули
epsdk list-remote -t modules
# Обновление кэша и вывод
epsdk list-remote -r
Команды конфигурации
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
config |
cfg, conf |
[имя] [--list/-l] [--json] |
Интерактивная конфигурация адаптера/модуля |
config
Интерактивное заполнение конфигурационных параметров адаптера/модуля. Визуальный помощник генерируется на основе класса конфигурации (ConfigClass / AccountConfigClass), автоматически создаёт форму и проводит валидацию, без необходимости ручного редактирования config.toml.
Адаптеры дополнительно поддерживают управление несколькими аккаунтами (бот-аккаунтами): добавление/редактирование/удаление аккаунтов, а также включение/отключение.
Алиас: cfg, conf
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[имя] |
Имя цели (название платформы адаптера или модуля), оставить пустым — переход в интерактивный выбор | |
--list |
-l |
Вывести только состояние всех целей, без запуска помощника |
--json |
Вывести состояние всех целей в формате JSON (для CI / скриптов), без запуска помощника |
Примеры:
# Просмотр состояния всех адаптеров/модулей
epsdk config --list
# Вывод состояния в JSON (для CI / скриптов)
epsdk config --json
# Интерактивный выбор цели для конфигурации
epsdk config
# Конфигурация указанного адаптера
epsdk config yunhu
# Конфигурация указанного модуля
epsdk config MyModule
Описание:
- Состояние конфигурации делится на четыре категории:
Готово(валидация пройдена),Незавершено(отсутствуют обязательные поля или валидация не пройдена),Не настроено(никогда не генерировалось),Нет конфигурации(цель не объявляет класс конфигурации) - Значения полей снабжены пометками источника: уже настроенные отображаются как
(当前:значение), не настроенные — как(默认:значение); просто нажмите Enter, чтобы сохранить значение - Секретные поля (объявленные как
secret) не отображаются при вводе, нажатие Enter сохраняет установленное значение - В режиме интерактивного выбора, после завершения одного помощника, возвращается в меню выбора (состояние обновлено), можно настроить несколько целей подряд, нажатие Enter завершает
- При неудачной валидации формы и отказе от повторного ввода, текущий помощник завершается без сохранения конфигурации (избегает состояния "включено, но конфигурация не полна")
- После сохранения конфигурация немедленно записывается в
config/config.toml, видна в Dashboard и запущенном SDK; для применения новой конфигурации аккаунта в работающем адаптере перезапустите процесс epsdk install(интерактивная установка) иepsdk initпосле успешной установки адаптера автоматически запускают помощник конфигурации, если обнаружено объявление конфигурации; при установке по имени пакета в командной строке выводится только подсказка о конфигурации
Команды управления выполнением
Tip
epsdk run автоматически обнаруживает и использует виртуальное окружение .venv в каталоге проекта для запуска робота
(также можно явно указать интерпретатор с помощью переменной среды ERISPULSE_PYTHON). Команды epsdk install /
uninstall / upgrade / list также действуют на виртуальное окружение проекта.
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
run |
r |
[script] [--reload] [--strict/--no-strict] |
Запуск указанного скрипта или SDK |
stop |
— | [--force] [--pid PID] |
Остановка работающего экземпляра (запущенного с помощью epsdk run) |
restart |
— | [--force] [--pid PID] |
Перезапуск работающего экземпляра (остановка и запуск с теми же параметрами) |
run
Запуск скрипта проекта ErisPulse или прямой запуск SDK. Поддерживает режим горячей перезагрузки.
Алиас: r
Параметры:
| Параметр | Описание |
|---|---|
[script] |
Запускаемый файл скрипта, если не указан, запускается SDK |
--reload |
Включение режима горячей перезагрузки: отслеживание изменений файлов и автоматическое триггерное обновление кода на уровне компонентов (без перезапуска всего процесса); по умолчанию каталоги .venv/.git игнорируются (можно настроить через ErisPulse.framework.watch_ignore_dirs), каталог плагинов обрабатывается точным обновлением плагина-наблюдателя |
--strict / --no-strict |
Временное включение / выключение строгого режима (действует только на этот запуск, не сохраняется в конфигурации); по умолчанию следует ErisPulse.framework.strict_mode |
Примеры:
# Прямой запуск SDK
epsdk run
# Запуск указанного файла скрипта
epsdk run main.py
# Горячая перезагрузка (автоматическое обновление кода при изменении файлов)
epsdk run main.py --reload
# Горячая перезагрузка SDK
epsdk run --reload
# Временный строгий режим: завершение с ошибкой при предварительной проверке, уровень строгости фреймворка повышается до минимум 1 на этот запуск
epsdk run main.py --strict
# Временный нейтральный режим (в конфигурации включен strict_mode, но на этот запуск хочется запуститься)
epsdk run main.py --no-strict
Предварительная проверка при запуске: run выполняет быструю проверку config/config.toml на возможность парсинга и обязательных конфигураций установленных компонентов, строгость по умолчанию следует ErisPulse.framework.strict_mode (при ненулевом значении ошибка проверки приводит к завершению, при нулевом — только предупреждение и продолжение). Отсутствие конфигурационного файла считается нормальным для первого запуска, только предупреждение, не ошибка. --strict временно включает: предварительная проверка завершается с ошибкой, уровень строгости фреймворка повышается до минимум 1 (пропуск несоответствующих компонентов, через переменную среды ERISPULSE_FRAMEWORK_STRICT_MODE передается в процесс запуска, не сохраняется в файл конфигурации); --no-strict временно понижает до нейтрального. При возникновении исключений в самой предварительной проверке автоматически пропускается, не включает проверку сети, не блокирует запуск.
Структура наблюдения
--reload(начиная с версии 2.11.1):epsdk run --reloadзапускается в виде «надзорного процесса + подпроцесс перезагрузки». Сохранение.pyфайлов вызывает горячую перезагрузку в подпроцессе (исключительный последовательный режим, объединение шторма изменений); синтаксические ошибки в модуле будут отклонены предварительной проверкой, старый экземпляр продолжит обслуживание. При вызовеsdk.hard_restart()подпроцесс завершается с кодом 42, надзорный процесс отображает причину и автоматически перезапускает новый подпроцесс — после обновления фреймворка новая версия кода сразу применяется.
stop
Остановка работающего экземпляра ErisPulse (запущенного с помощью epsdk run и выполненного в том же каталоге проекта). run при запуске записывает PID надзорного процесса, PID текущего подпроцесса фреймворка и исходную команду запуска в файл .erispulse/runtime.json, stop использует эти данные для определения экземпляра.
Порядок остановки: В POSIX-системах сначала отправляется сигнал SIGINT (аналогичный Ctrl+C — путь к элегантному завершению, автоматически завершается подпроцесс фреймворка по цепочке finally), при таймауте постепенно повышаются до SIGTERM / SIGKILL; в Windows нет семантики сигналов процесса, сначала останавливается подпроцесс фреймворка, затем надзорный процесс (чтобы избежать ошибочного восстановления при принудительном завершении).
Параметры:
| Параметр | Описание |
|---|---|
--force |
Пропуск элегантной остановки, прямое принудительное завершение |
--pid PID |
Прямое указание PID целевого процесса (перезаписывает файл состояния, используется для нестандартных способов запуска) |
Примеры:
# Остановка текущего запущенного экземпляра проекта
epsdk stop
# Принудительное завершение
epsdk stop --force
restart
Перезапуск работающего экземпляра ErisPulse: остановка по семантике stop, затем запуск с использованием исходной команды запуска, записанной в файле состояния (захватывает текущий терминал, новый экземпляр записывает новый файл состояния).
Экземпляр в контейнере (PID 1): Если экземпляр, записанный в файле состояния, является главным процессом контейнера (PID == 1, например, в официальном образе CMD ["epsdk", "run"]), то остановка и перезапуск невозможны — выход PID 1 приводит к завершению контейнера. В этом случае отправляется сигнал SIGUSR1 процессу фреймворка, вызывая горячий перезапуск внутри процесса (sdk.restart()): код модулей и адаптеров обновляется на уровне кода, адаптеры, установленные через ep i, сразу применяются, контейнер остается онлайн. Для полного перезапуска процесса (обновление фреймворка, структурные изменения конфигурации) перезапустите контейнер (docker restart <контейнер>). Подробнее см. Развертывание → Перезапуск в контейнере (экземпляр с PID 1).
Параметры: такие же, как у stop (--force / --pid PID).
Пример:
# Элегантный перезапуск (после обновления адаптера/модуля через pip для применения кода; модули, запущенные в процессе, также можно обновить с помощью `sdk.reload_module` / `sdk.adapter.reload` на уровне кода, без перезапуска)
epsdk restart
Note
Запуск с помощью python main.py и других способов, не использующих epsdk run, не записывает файл состояния запуска — такие процессы управляются системными инструментами или с помощью epsdk stop --pid <PID>, указав PID.
Команды управления проектом
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
init |
— | [путь] [--project-name/-n <имя>] [--path <каталог>] [--adapter/-a <имя>] [--quick/-q] [--force/-f] [--here] [--no-uv] [--no-venv] |
Инициализация проекта ErisPulse |
create |
— | {module,adapter,pack} [--name/-n <имя>] [--description/-d <описание>] [--author/-a <имя>] [--email/-e <почта>] [--homepage <сайт>] [--output/-o <каталог>] [--force/-f] [--local] |
Создание шаблона модуля/адаптера; pack преобразует локальный плагин в публикуемый проект |
init
Инициализация нового проекта ErisPulse. Поддерживает интерактивный и быстрый режим, начиная с 2.8.4 создаёт pyproject.toml (список зависимостей), по умолчанию создаёт виртуальное окружение .venv и устанавливает фреймворк и адаптер, поддерживает указание произвольного каталога.
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[путь] |
Целевой путь (может включать родительские каталоги, например ../apps/mybot; имя без пути эквивалентно --project-name) |
|
--project-name |
-n |
Имя проекта |
--path |
Родительский каталог проекта (в сочетании с -n указывает путь создания) |
|
--adapter |
-a |
Предварительно выбранный адаптер (можно передавать несколько раз или через запятую), при передаче пропускает выбор адаптера |
--quick |
-q |
Быстрый режим, пропускает интерактивное руководство (по умолчанию создаёт .venv и устанавливает зависимости) |
--force |
-f |
Принудительное перезапись существующих файлов конфигурации |
--here |
Инициализация в текущем каталоге, без создания подкаталога | |
--no-uv |
Использование pip вместо uv | |
--no-venv |
Пропуск создания виртуального окружения и установки зависимостей |
Примеры:
# Интерактивная инициализация
epsdk init
# Быстрая инициализация (создаёт my_bot/ в текущем каталоге, с `pyproject.toml` + `.venv`)
epsdk init -q -n my_bot
# Быстрая инициализация с предустановленными адаптерами (без интеракции, для скриптов / CI)
epsdk init -q -n my_bot --adapter yunhu,telegram
# Инициализация в произвольном каталоге (../apps/mybot)
epsdk init ../apps/mybot
# Комбинация родительского каталога и имени проекта
epsdk init -n my_bot --path ../apps
# Принудительная перезапись конфигурации
epsdk init -f
# Инициализация в текущем каталоге
epsdk init --here -n my_bot
# Создание только структуры проекта, без виртуального окружения
epsdk init --no-venv -n my_bot
Результат инициализации: main.py, pyproject.toml (список зависимостей), config/config.toml + config.full.example, config/ssl/, logs/, .gitignore, README.md; при выборе создания виртуального окружения дополнительно создаётся .venv и устанавливаются erispulse и выбранные адаптеры.
Note
.gitignore — шаблон с группировкой: байт-коды и результаты сборки, виртуальные окружения и .env, кэш инструментов, файлы редактора и системы, и полностью исключает каталоги config/ и logs/ — config.toml содержит токены адаптеров и другие чувствительные данные, не рекомендуется включать в репозиторий; для совместного использования шаблона конфигурации используйте config.full.example.
Warning
Не используйте uv run epsdk run для запуска робота. uv run в каталоге без pyproject.toml создает изолированную среду для однократного запуска — адаптеры, установленные через epsdk install, не будут сохранены. Используйте epsdk run в каталоге проекта (автоматически использует .venv), или активируйте виртуальное окружение перед запуском.
create
Создание шаблона модуля или адаптера ErisPulse; подкоманда pack преобразует локальный плагин (plugins/ каталог) в публикуемый стандартный проект.
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
{module,adapter,pack} |
Тип для создания: module / adapter / pack (преобразование плагина в проект) |
|
--name |
-n |
Имя проекта (в стиле PascalCase) |
--description |
-d |
Описание проекта |
--author |
-a |
Имя автора |
--email |
-e |
Электронная почта автора |
--homepage |
URL-адрес проекта | |
--output |
-o |
Каталог вывода (по умолчанию текущий каталог) |
--force |
-f |
Принудительная перезапись существующего каталога |
--local |
Создание локального плагина (доступно для module / adapter): генерирует структуру plugins/<имя>/, без установки через пакет |
Примеры:
# Интерактивное создание (выводит выбор типа и заполняет информацию)
epsdk create
# Прямое создание проекта модуля
epsdk create module -n MyModule
# Создание локального плагина (в каталог `plugins/` проекта, автоматически обнаруживается при запуске)
epsdk create module -n MyModule --local
# Создание локального адаптера плагина (аналогично, без установки через пакет)
epsdk create adapter -n MyAdapter --local
# Прямое создание проекта адаптера
epsdk create adapter -n MyAdapter
# Преобразование локального плагина в публикуемый проект (интерактивный выбор плагина → заполнение метаинформации → генерация стандартного проекта)
epsdk create pack
# Полные параметры
epsdk create module -n MyModule -d "Описание модуля" -a "Автор" -e "[email protected]"
# Указание каталога вывода
epsdk create module -n MyModule -o ./projects
# Принудительная перезапись существующего каталога
epsdk create module -n MyModule -f
Команды языка
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
i18n |
language, lang |
[язык] [--list/-l] |
Просмотр или смена языка отображения CLI |
i18n
Просмотр текущего языка CLI, список поддерживаемых языков, смена языка отображения. Если параметр не указан, запускается интерактивное меню выбора.
Алиас: language, lang
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
[язык] |
Код языка для смены (например, zh-CN, en, ja, ru) |
|
--list |
-l |
Вывод списка всех поддерживаемых языков |
Примеры:
# Интерактивный выбор языка
epsdk i18n
# Смена на английский
epsdk i18n en
# Смена на японский
epsdk i18n ja
# Вывод списка всех поддерживаемых языков
epsdk i18n --list
Команды для генерации типовых аннотаций
| Команда | Алиас | Параметры | Описание |
|---|---|---|---|
types |
t, stub |
[--output/-o <путь>] [--force] [--adapters-only] [--modules-only] |
Генерация файлов аннотаций типов для автодополнения в IDE |
types
Сканирование установленных модулей и адаптеров ErisPulse, генерация файлов .pyi с аннотациями типов, для получения точного автодополнения и проверки типов в IDE.
Алиас: t, stub
Параметры:
| Параметр | Краткий | Описание |
|---|---|---|
--output |
-o |
Путь вывода (по умолчанию ep-stubs/ в текущем каталоге) |
--force |
Принудительная перезапись существующих файлов аннотаций | |
--adapters-only |
Генерировать только аннотации для адаптеров | |
--modules-only |
Генерировать только аннотации для модулей |
Важно:
--adapters-onlyи--modules-onlyвзаимоисключительны, при одновременном указании последний параметр имеет приоритет.
Примеры:
# Генерация аннотаций для всех установленных модулей и адаптеров
epsdk types
# Только аннотации для адаптеров
epsdk types --adapters-only
# Вывод в указанный каталог
epsdk types -o ./typings
# Принудительная перезапись файлов
epsdk types --force
Глобальные параметры
Следующие параметры применимы ко всем командам:
| Параметр | Краткий | Описание |
|---|---|---|
--help |
-h |
Показать справку |
--version |
-V |
Показать информацию о версии |
--verbose |
-v |
Показать подробный вывод (можно повторять -vv/-vvv) |
--no-color |
Отключить цветной вывод (подходит для CI / сбора логов) | |
--no-banner |
Пропустить стартовый баннер (скриптовое использование / CI; в неинтерактивных терминалах и при ERISPULSE_NO_BANNER=1 автоматически скрыт) |
|
--yes |
-y |
Автоматическое подтверждение всех интерактивных запросов (без интеракции) |
Диагностика окружения
doctor
Note
Эта команда доступна в ErisPulse 2.7.0+.
Диагностика текущей среды CLI, вывод отчета о состоянии. Используется для выявления проблем "почему не устанавливается / не подключается".
| Параметр | Описание |
|---|---|
--verbose |
Показать подробную диагностику |
--fix |
Диагностировать и попытаться автоматически исправить исправимые проблемы |
Проверяемые пункты:
- Python: версия и путь интерпретатора
- Установщик: используется
uvилиpip - Целевой интерпретатор: фактическая среда, куда установлены пакеты
- Конфигурационный файл: существует ли
config/config.toml - Конфигурация компонентов: полнота обязательных полей конфигурации установленных компонентов ("установлен, но не запущен" часто из-за отсутствующих обязательных полей)
- Загрязнение конфигурации (2.11.1+): поиск остаточных ключей от прошлых обновлений (тени состояния, привязанные к старой версии, отдельные конфигурационные секции), при обнаружении — предупреждение
- Доступность PyPI: можно ли подключиться к PyPI (и показать количество обнаруженных компонентов)
- Системный прокси: обнаружен ли прокси
Автоматическое исправление (--fix):
- Отсутствует
config.toml→ генерируется начальный конфигурационный файл на основе текущего языка (так же, как приinit) - Конфигурация компонента "незавершена" → поочередно запускает интерактивный помощник конфигурации для заполнения обязательных полей (в неинтерактивной среде — подсказка использовать
epsdk config <имя>) - Остаточные ключи загрязнения конфигурации → перечисление источников и удаление после подтверждения (без потери порядка и комментариев)
- Проблемы с низкой версией Python, недоступностью PyPI и т.д. — только рекомендации по действию
# Диагностика среды
epsdk doctor
# Алиас
epsdk diag
# Диагностика и автоматическое исправление
epsdk doctor --fix
Интерактивная установка
Запуск epsdk install без указания пакета ведёт к интерактивной установке:
epsdk install
Интерфейс предоставляет:
- Выбор адаптера
- Выбор модуля
- Пользовательская установка
Общие способы использования
Установка модуля
# Установка одного модуля
epsdk install Weather
# Установка нескольких модулей
epsdk install Yunhu Weather
# Обновление модуля
epsdk install Weather -U
Вывод списка компонентов
# Вывод всех компонентов
epsdk list
# Только адаптеры
epsdk list -t adapters
# Только обновляемые компоненты
epsdk list -o
# Вывод доступных удалённых компонентов
epsdk list-remote
Удаление компонентов
# Удаление одного компонента
epsdk uninstall Weather
# Удаление нескольких компонентов
epsdk uninstall Yunhu Weather
Конфигурация компонентов
# Просмотр состояния конфигурации
epsdk config --list
# Интерактивный выбор цели для конфигурации
epsdk config
# Конфигурация указанного адаптера
epsdk config yunhu
Обновление компонентов
# Обновление всех компонентов
epsdk upgrade
# Обновление указанного компонента
epsdk upgrade Weather
# Принудительное обновление
epsdk upgrade -f
Запуск проекта
# Обычный запуск
epsdk run main.py
# Горячая перезагрузка
epsdk run main.py --reload
Смена языка
# Интерактивный выбор языка
epsdk i18n
# Прямая смена на английский
epsdk i18n en
# Вывод списка поддерживаемых языков
epsdk i18n --list
Генерация типовых аннотаций
# Генерация всех типовых аннотаций
epsdk types
# Только типовые аннотации для модулей
epsdk types --modules-only
Инициализация проекта
# Интерактивная инициализация
epsdk init
# Быстрая инициализация
epsdk init -q -n my_bot
Создание шаблона
# Интерактивное создание (выводит выбор типа и заполняет информацию)
epsdk create
# Прямое создание проекта модуля
epsdk create module -n MyModule
# Прямое создание проекта адаптера
epsdk create adapter -n MyAdapter
# Полные параметры
epsdk create module -n MyModule -d "Описание модуля" -a "Автор" -e "[email protected]"
# Принудительная перезапись существующего каталога
epsdk create module -n MyModule -f
Далее
- После установки компонентов нужно заполнить конфигурацию: используйте интерактивный помощник
epsdk config, или посмотрите описание конфигурационного файла для ручного редактирования - После написания кода нужна подсказка IDE: запустите
epsdk types, подробнее см. генерацию типовых аннотаций - Робот не запускается: сначала проведите диагностику среды с помощью
epsdk doctor(см. диагностика среды), для долгосрочной развертки смотрите руководство по развертыванию