ErisPulse ErisPulse
Открыть интерактивную версию →
Разделы страницы
Статическое зеркало — интерактивная версия является основной Открыть интерактивную версию →

Быстрый старт

Это ваш первый шаг. Запустите робота ErisPulse за 5 минут — сначала посмотрите результат, а затем разберитесь с каждым шагом.

Эффект за 60 секунд: заставьте бота сначала ответить вам

1. Установка (Python >= 3.10):

pip install ErisPulse

2. Инициализация проекта. Мастер запросит имя проекта, позволит выбрать платформу адаптера и завершит настройку, после чего сгенерирует main.py и config/config.toml:

epsdk init

3. Откройте main.py и замените его на эти 9 строк кода:

from ErisPulse import sdk
from ErisPulse.Core.Event import command

@command("ping", help="Проверка, работает ли бот")
async def ping_handler(event):
    await event.reply("Pong! Бот работает нормально.")

if __name__ == "__main__":
    import asyncio
    asyncio.run(sdk.run(keep_running=True))

4. Запуск:

epsdk run main.py

В терминале появятся логи запуска фреймворка и информация о подключении адаптера. Теперь, если вы отправите боту /ping на подключенной платформе, он ответит:

Pong! Бот работает нормально.

Если вы увидели этот ответ, значит, цепочка фреймворка, адаптера и обработки событий заработала. Если не получилось, просто перейдите в конец документа по ссылке Возникли проблемы; если всё прошло успешно, читайте дальше, чтобы узнать, какие ещё есть варианты на каждом этапе.

Установка ErisPulse: три способа

Выше использовался самый прямой способ — pip. Выбирайте в зависимости от вашей среды:

Установка с помощью pip

Убедитесь, что у вас установлен Python версии >= 3.10, затем установите с помощью pip:

pip install ErisPulse

Если у вас установлен uv, можно использовать uv pip install ErisPulse — установка будет быстрее.

Если вы хотите установить команду epsdk глобально, чтобы не загрязнять окружение проекта, рекомендуется использовать uv tool install:

uv tool install ErisPulse

После установки команда epsdk будет доступна глобально: при запуске в директории проекта автоматически определяется .venv проекта (команда epsdk install устанавливает в окружение проекта, epsdk run запускает в окружении проекта), а сам фреймворк предоставляется из окружения инструмента. Подробнее см. руководство по установке.

Сценарий установки за один клик (рекомендуется для новых сред)

Сценарий автоматически определяет вашу среду (Docker, Python, uv) и предлагает наиболее подходящий способ установки, поддерживает несколько языков (китайский/English/日本語/Русский/繁體中文).

Windows (PowerShell):

irm https://get.erisdev.com/install.ps1 -OutFile install.ps1; powershell -ExecutionPolicy Bypass -File install.ps1

macOS / Linux:

curl -fsSL https://get.erisdev.com/install.sh -o install.sh && chmod +x install.sh && ./install.sh

Сценарий поможет вам выполнить следующие действия:

  • Установка через Docker (рекомендуется, если Docker обнаружен): выбор источника образа (Docker Hub / GHCR), канал версий (стабильный / предварительный), настройка панели управления Dashboard, настройка портов
  • Установка глобального CLI (uv tool, рекомендуется): установка epsdk как глобальной команды, без виртуального окружения, uv автоматически управляет Python (даже если версия системы слишком низкая); при запуске в директории проекта автоматически определяется .venv
  • Традиционная установка: автоматическое создание виртуального окружения, выбор версии ErisPulse, необязательная установка модуля панели управления Dashboard

Использование Docker

В Docker-образе уже включён фреймворк ErisPulse и панель управления Dashboard, поддерживается архитектура linux/amd64 и linux/arm64.

# Скачайте docker-compose.yml
curl -O https://raw.githubusercontent.com/ErisPulse/ErisPulse/main/docker-compose.yml

# Установите токен панели управления и запустите
ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
Не работает Docker Hub?

Используйте образ из GitHub Container Registry, изменив image в docker-compose.yml:

image: ghcr.io/erispulse/erispulse:latest

После запуска перейдите по адресу http://<host>:8000/Dashboard и войдите, используя установленный токен.

Инициализация проекта

Интерактивная инициализация (рекомендуется)

epsdk init

Это запустит интерактивное руководство, которое поможет вам выполнить следующие шаги:

  • Настройка имени проекта
  • Настройка уровня логирования
  • Настройка сервера (хост и порт)
  • Выбор и настройка адаптера
  • Создание структуры проекта

Быстрая инициализация

# Быстрый режим с указанием имени проекта
epsdk init -q -n my_bot

# Или просто указание имени проекта
epsdk init -n my_bot

Создание проекта вручную

Если вы предпочитаете создавать проект вручную:

mkdir my_bot && cd my_bot
epsdk init

Установка модуля

Установка через CLI

epsdk install Yunhu AIChat

Просмотр доступных модулей

epsdk list-remote

Интерактивная установка

При отсутствии имени пакета открывается интерактивный интерфейс установки:

epsdk install

Запуск проекта

# Обычный запуск
epsdk run main.py

# Режим горячей перезагрузки (рекомендуется при разработке)
epsdk run main.py --reload

Включение автодополнения в IDE (по желанию)

Динамически обнаруживаемые модули/адаптеры ErisPulse не поддерживаются автодополнением в IDE по умолчанию. Запустите следующую команду для генерации типовых заглушек:

epsdk types

После генерации, используйте импортированные типы для аннотации переменных, чтобы получить точное автодополнение (подробнее см. Руководство по автодополнению в IDE):

from _ep_types import Yunhu
from ErisPulse import sdk

adapter: Yunhu = sdk.adapter.get("yunhu")
await adapter.Send.To("group", "123").Board(...)  # Автодополнение методов, специфичных для платформы

Структура проекта

Структура проекта после инициализации:

my_bot/
├── config/
│   └── config.toml          # Файл конфигурации
└── main.py                  # Точка входа

Конфигурационный файл

Базовый конфигурационный файл config.toml:

[ErisPulse.server]
host = "0.0.0.0"
port = 8000

[ErisPulse.logger]
level = "INFO"

[Yunhu_Adapter]
# Конфигурация адаптера

Далее

После запуска бота выберите дальнейшие шаги в соответствии с вашими целями:

Хотите создать групповой бот (обработка сообщений, управление группой, уведомления)

Хотите написать свой модуль / адаптер

Хотите запустить бота на постоянной основе

Возникли проблемы