Быстрый старт
Это ваш первый шаг. Запустите робота ErisPulse за 5 минут, начиная с нуля.
Установка ErisPulse
Скрипт установки с одним нажатием (рекомендуется)
Скрипт автоматически определяет вашу среду (Docker, Python, uv) и направляет вас к наиболее подходящему способу установки.
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, настройка портов
- Традиционная установка: автоматическое создание виртуального окружения, выбор версии ErisPulse, необязательная установка модуля панели управления Dashboard
Использование Docker
Docker-образ уже содержит в себе фреймворк ErisPulse и панель управления Dashboard.
# Скачать docker-compose.yml
curl -O https://raw.githubusercontent.com/ErisPulse/ErisPulse/main/docker-compose.yml
# Установить токен Dashboard и запустить
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 и войдите, используя установленный токен.
Установка с помощью 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 запустит с использованием проектного окружения), а сам фреймворк будет предоставлен из окружения инструмента. Подробнее см. справочник по установке.
Инициализация проекта
Интерактивная инициализация (рекомендуется)
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]
# Конфигурация адаптера
Далее
После запуска робота вы можете продолжить по мере необходимости:
Хотите узнать, как работает фреймворк?
- Основные понятия — архитектура адаптеров / модулей / событий
- Обзор архитектуры — визуальная схема архитектуры
Хотите реализовать больше функций?
- Примеры распространённых задач — хранение данных, планирование задач, управление правами доступа
- Введение в обработку событий — обработка сообщений, уведомлений, запросов
Хотите разработать свой собственный модуль / адаптер?
Справочные материалы по запросу: