ErisPulse ErisPulse
インタラクティブ版で開く →
このページのセクション
静的ミラーです。内容はインタラクティブ版が正となります インタラクティブ版で開く →

速習

これが最初の一歩です。 5 分でゼロから ErisPulse ロボットを起動しましょう。まずは効果を見て、その後各ステップを詳しく説明します。

60 秒効果:まずロボットが 1 文だけ返信するようにする

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 のインストール:3 つの方法

上記では最も直接的な 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 でプロジェクト環境で実行されます。フレームワーク本体はツール環境から提供されます。詳しくはインストールの参考を参照してください。

1 つでインストールするスクリプト(新規環境に推奨)

インストールスクリプトは、環境(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

# Dashboard トークンを設定して起動
ERISPULSE_DASHBOARD_TOKEN=your-token docker compose up -d
Docker Hub が利用できない場合?

GitHub Container Registry のイメージを使用する場合は、docker-compose.yml の image を次のように変更します:

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]
# アダプターの設定

次のステップ

ロボットが起動したら、目的に応じて選択してください:

グループ用ロボットを作りたい(メッセージ処理、グループ管理、通知)

自分のモジュール / アダプターを書きたい

ロボットを長期的に動かしたい

問題に遭遇した場合