すぐに始める

これはあなたの最初の一歩です。 5 分でゼロから ErisPulse ロボットを立ち上げましょう。

ErisPulse のインストール

1 本化インストールスクリプト（推奨）

インストールスクリプトは、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 のイメージを使用する場合は、docker-compose.yml の image を次のように変更します：

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

次のステップ

ロボットが起動した後、必要に応じて以下を進めてください。

フレームワークの仕組みを知りたい?

基本概念 — アダプター / モジュール / イベントの設計
アーキテクチャ概要 — 可視化されたアーキテクチャ図

もっと多くの機能を実装したい?

一般的なタスクの例 — ストレージ、スケジューリング、権限制御
イベント処理の入門 — メッセージ、通知、リクエストの処理

独自のモジュール / アダプターを開発したい?

必要に応じて参照:

設定ファイルの説明 · CLI コマンド · デプロイガイド