用戶使用指南
Tip
什麼時候需要讀這篇:需要安裝環境、設定 config.toml、用 epsdk 管理元件,或把機器人部署上線時按篇查閱;不需要則跳過。
這裡涵蓋機器人「跑起來之後」的全部日常操作:安裝、設定、命令列管理、部署與升級。
內容列表
| 文件 | 說明 |
|---|---|
| 安裝與配置 | 系統需求、安裝方式(pip/uv/Docker)、驗證安裝 |
| ErisPulse-App 手機/桌面客戶端 | 官方客戶端:手機 / 桌面直接運行,原生介面管理 ErisPulse 實例 |
| CLI 命令參考 | epsdk 命令列工具的完整使用說明 |
| 配置文件說明 | config/config.toml 各配置項的詳細說明 |
| 部署指南 | Docker 部署、systemd 服務、SSL 配置 |
快速參考
常用命令
| 命令 | 說明 |
|---|---|
epsdk init |
初始化專案(-q 快速模式,-n 指定名稱) |
epsdk install <包名> |
安裝模組/適配器(不帶參數進入互動模式) |
epsdk config <名稱> |
互動式配置適配器/模組的宣告式配置項 |
epsdk run main.py |
運行專案(--reload 熱重載模式) |
epsdk list |
列出已安裝的模組/適配器 |
epsdk upgrade <包名> |
升級模組/適配器 |
epsdk doctor |
診斷環境(Python/後端/配置/PyPI 連通性) |
完整的命令列表和參數說明請參考 CLI 命令參考。
常見配置位置
| 配置項 | 說明 | 詳見 |
|---|---|---|
[ErisPulse.server] |
伺服器配置(主機、端口) | 配置文件說明 |
[ErisPulse.logger] |
日誌配置(等級、輸出檔案) | 配置文件說明 |
[ErisPulse.framework] |
框架配置(懶加載) | 配置文件說明 |
[ErisPulse.event.command] |
命令事件配置(前綴) | 配置文件說明 |
[適配器名] |
各適配器的特定配置 | 平台特性指南 |