简体中文 English 繁體中文 日本語 Русский
本文为静态镜像，内容以交互版为准 在交互式文档中心打开 →

User Guide

This guide helps you install, configure, and manage the ErisPulse project.

Content List

Document Description
Installation and Setup System requirements, installation methods (pip/uv/Docker), and installation verification
ErisPulse-App Mobile/Desktop Client Official client: Run directly on mobile/desktop with native interface to manage ErisPulse instances
CLI Command Reference Complete usage instructions for the epsdk command-line tool
Configuration File Reference Detailed explanation of each configuration item in config/config.toml
Deployment Guide Docker deployment, systemd service setup, and SSL configuration

Quick Reference

Common Commands

Command Description
epsdk init Initialize project (-q for quick mode, -n to specify name)
epsdk install <package-name> Install module/adapter (enters interactive mode without parameters)
epsdk config <name> Interactive configuration of declarative configuration items for adapter/module
epsdk run main.py Run project (--reload for hot-reload mode)
epsdk list List installed modules/adapters
epsdk upgrade <package-name> Upgrade module/adapter
epsdk doctor Diagnose environment (Python/backend/configuration/PyPI connectivity)

For the complete list of commands and parameter descriptions, see CLI Command Reference.

Common Configuration Locations

Configuration Description See Also
[ErisPulse.server] Server configuration (host, port) Configuration File Guide
[ErisPulse.logger] Logging configuration (level, output file) Configuration File Guide
[ErisPulse.framework] Framework configuration (lazy loading) Configuration File Guide
[ErisPulse.event.command] Command event configuration (prefix) Configuration File Guide
[Adapter Name] Adapter-specific configuration Platform Features Guide