ErisPulse 2.5.0.dev2

ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。

English | 简体中文 | 繁體中文 | 日本語 | Русский 🎉 v2.5.0-dev.1 now supports multiple languages! The framework core and CLI interface now have built-in support for Chinese (Simplified/Traditional), English, Japanese, and Russian, automatically switching based on your system language! ErisPulse Event-driven multi-platform robot development framework Based on the OneBot12 standard interface, write once, deploy across multiple platforms. A flexible plugin system, hot-reload support, and a complete developer toolchain, suitable for various scenarios from simple chatbots to complex automation systems. Supports Vibe Coding workflow, letting AI directly generate usable modules — View

---

Core Features

⚡ Event-driven Architecture A clear event model based on the OneBot12 standard, making message handling logic more intuitive and efficient	🌐 Cross-platform Compatibility Write plugin modules once and use them across all platforms, without repetitive development for different platforms
🧩 Modular Design A flexible plugin system, easy to extend and integrate, supporting hot-swappable module management	🔄 Hot-reload Support Reload code without restarting during development, greatly improving development iteration efficiency

---

Quick Start

One-click Installation Script (Recommended)

The installation script automatically detects your environment (Docker, Python, uv), guides you to choose the most suitable installation method, and supports multiple languages (Chinese/English/Japanese/Russian/Traditional Chinese).

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 Installation Demo

pip Installation Demo

Using Docker (Recommended)

docker pull erispulse/erispulse:latest

Unable to access Docker Hub?

If Docker Hub is inaccessible, you can use GitHub Container Registry:

docker pull ghcr.io/erispulse/erispulse:latest

When using the ghcr.io image, modify the docker-compose.yml file's image:

image: ghcr.io/erispulse/erispulse:latest

Quick Start

# Download docker-compose.yml
curl -O https://raw.githubusercontent.com/ErisPulse/ErisPulse/main/docker-compose.yml

# Set Dashboard login token and start
ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d

The image includes the ErisPulse framework and Dashboard management panel, supporting linux/amd64 and linux/arm64 architectures.

After startup, visit http://<host>:<port>/Dashboard, and use the set token as the password to log in to the Dashboard management panel.

Using Pre-release Version (Dev)

Set ERISPULSE_CHANNEL=dev to use the pre-release version:

# Method 1: Use environment variable (Recommended)
ERISPULSE_CHANNEL=dev ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d

# Method 2: Build dev image
ERISPULSE_BUILD_TARGET=dev docker compose up -d --build

To automatically update to the latest version at startup (regardless of stable or dev), explicitly set ERISPULSE_UPDATE_ON_START=true:

ERISPULSE_CHANNEL=dev ERISPULSE_UPDATE_ON_START=true docker compose up -d

You can also pull the pre-built dev image:

docker pull erispulse/erispulse:dev

Docker Environment Variables

Variable	Default Value	Description
ERISPULSE_CHANNEL	stable	Version channel: stable (stable version) or dev (pre-release version)
ERISPULSE_UPDATE_ON_START	false	Whether to automatically update to the latest version when the container starts (must be explicitly enabled)
ERISPULSE_DASHBOARD_TOKEN	empty	Dashboard login token
ERISPULSE_PORT	8000	Dashboard port mapping
TZ	Asia/Shanghai	Container timezone

Setting ERISPULSE_UPDATE_ON_START=true ensures that even if the image is outdated, the container will automatically fetch the latest version at startup.

1Panel App Store

Install ErisPulse one-click via the 1Panel app store, see ErisPulse-1Panel.

bash <(curl -sL https://get-1panel.erisdev.com/install.sh)

Using pip Installation

pip install ErisPulse

You can also use the one-click installation script above, which automatically detects the environment and guides configuration.

Running Effect

Dashboard:

💡 Experience the live demo dashboard online: DashDemo

Same code, multiple platform responses:

Kook

QQ

Yunhu

Initialize Project

# Interactive initialization
epsdk init

# Quick initialization (specify project name)
epsdk init -q -n my_bot

Create First Robot

Create main.py file:

Command Handler from ErisPulse import sdk from ErisPulse.Core.Event import command @command("hello", help="Send greeting message") async def hello_handler(event): user_name = event.get_user_nickname() or "friend" await event.reply(f"Hello, {user_name}!") @command("ping", help="Test if the robot is online") async def ping_handler(event): await event.reply("Pong! The robot is running normally.") if __name__ == "__main__": import asyncio asyncio.run(sdk.run(keep_running=True))

Effect Explanation Send /hello Robot replies: Hello, {username}! Send /ping Robot replies: Pong! The robot is running normally. Running Method epsdk run main.py # Or development mode epsdk run main.py --reload

For more detailed instructions, please refer to:

• Quick Start Guide
• Getting Started Guide

Multi-turn Conversation Example

ErisPulse includes a powerful multi-turn conversation engine, making it easy to implement guided operations, information collection, and other interactive scenarios:

from ErisPulse.Core.Event import command, request

@command("register")
async def register_handler(event):
    conv = event.conversation(timeout=60)
    
    await conv.say("Welcome to register!")
    
    # Multi-step collection of user information, with automatic validation
    data = await conv.collect([
        {"key": "name", "prompt": "Please enter your name"},
        {"key": "age", "prompt": "Please enter your age",
         "validator": lambda e: e.get_text().strip().isdigit(),
         "retry_prompt": "Age must be a number, please re-enter"},
    ])
    
    if data and await conv.confirm(f"Confirm registration? Name: {data['name']}, Age: {data['age']}"):
        # Use SendDSL to actively push notifications
        await sdk.adapter.get(event.get_platform()).Send.To(
            "user", event.get_user_id()
        ).Text(f"Registration successful! Welcome {data['name']}")
        # Or await event.reply("Registration successful!")

# Automatically handle friend requests
@request.on_friend_request()
async def handle_friend_request(event):
    user_name = event.get_user_nickname() or event.get_user_id()
    
    # Approve the request
    result = await event.approve()
    if result.get("status") == "ok":
        await event.reply(f"Friend request approved automatically, welcome {user_name}")

See more Conversation API (branching/joining/selection/persistence)

@command("quiz")
async def quiz_handler(event):
    conv = event.conversation(timeout=30)
    
    # Multiple-choice question
    answer = await conv.choose("Who is the creator of Python?", [
        "Guido van Rossum",
        "James Gosling", 
        "Dennis Ritchie",
    ])
    
    if answer == 0:
        await conv.say("Correct!")
    elif answer is None:
        await conv.say("Timed out, try again next time!")
    else:
        await conv.say("Incorrect, the correct answer is Guido van Rossum")

@command("menu")
async def menu_handler(event):
    conv = event.conversation(timeout=60)
    
    # Branching, build complex interaction flow
    @conv.branch("main")
    async def main_menu():
        await conv.say("=== Main Menu ===\n1. Personal Information\n2. Settings\n3. Exit")
        resp = await conv.wait()
        if resp and resp.get_text().strip() == "1":
            await conv.goto("profile")
    
    @conv.branch("profile")
    async def profile():
        await conv.say("Name: Alice\n0. Return")
        resp = await conv.wait()
        if resp and resp.get_text().strip() == "0":
            await conv.goto("main")
    
    await conv.start()

See Conversation Multi-turn Dialogue

---

Supported Adapters

We welcome your contributions to adapters!

Adapter	Description
Kook	Kook (Kahei La) instant messaging platform
Matrix	Matrix decentralized communication protocol
OneBot11	OneBot v11 general robot protocol
OneBot12	OneBot v12 standard protocol
QQ	Official QQ robot platform
Sandbox	Web-based debugging, no need to connect to real platforms
Telegram	Global instant messaging platform
Email	Email protocol adapter for sending and receiving
Yunhu	Enterprise-level instant messaging platform (robot access)
Yunhu User	Access adapter based on the Yunhu user protocol
Flower Maple Cafe	Allons! (・ω・) /
Discord	Global community communication platform, supports servers, channels, and private messages
Webhook	General HTTP bridge adapter, connects to any system
WeChat Official Account	Official WeChat Official Account platform

See Adapter Details

---

Application Scenarios

Multi-platform Robot	Chat Assistant	Automation Tool	Message Forwarding
Deploy robots with the same functionality across multiple platforms	Integrate AI chat modules for entertainment and interaction	Message notifications, task management, data collection	Cross-platform message synchronization and forwarding

---

Contribution Guide

The health of the ErisPulse project still needs your contribution! We welcome various forms of contributions:

1. Report Issues — Submit bug reports in GitHub Issues
2. Feature Requests — Propose new ideas through Community Discussions
3. Code Contributions — Read Code Style and Contribution Guide before submitting PRs
4. Documentation Improvements — Help improve documentation and example code

Join Community Discussions

---

Star History

---

Acknowledgments

This project is partially based on sdkFrame · The core adapter standardization layer is based on the OneBot12 specification · Thank you to all developers and authors who have contributed to the open-source community