CLI コマンドリファレンス
Tip
このドキュメントを参照すべきとき:epsdk コマンドの引数を忘れたとき、コンポーネント管理をスクリプトに組み込みたいとき、run / stop / restart の挙動を制御したいときに参照してください。日常的に init / install / run しか使わない場合は、次の一点だけ覚えていれば十分です:epsdk <コマンド> --help でいつでも引数の説明を確認できるので、本文を通読する必要はありません。
epsdk は ErisPulse のコマンドラインツールです:プロジェクトの初期化、モジュールとアダプターのインストール / アップグレード、コンポーネントの対話式設定、ボットの実行と停止、環境の診断が、すべてこの 1 つのコマンドで行えます。
ヒント:
epsdk(コマンドなし)のメインヘルプはカテゴリごとにグループ化して表示されます:プロジェクト(init / create / run)、コンポーネント管理(install / uninstall / upgrade / list / list-remote / types)、設定と診断(config / doctor / i18n)、その他(self-update / version)。
パッケージ管理コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
install |
i, add |
[package]... [--upgrade/-U] [--pre] [-e PATH] [--user] [--no-deps] [-t DIR] [--index-url URL] [--extra-index-url URL] [--no-cache-dir] [-r FILE] [-c FILE] [--force-reinstall] [--ignore-installed] [--compile/--no-compile] [--prefix DIR] [--src DIR] [--config-settings SETTINGS] [--no-binary FORMAT] [--only-binary FORMAT] [--prefer-binary] [--build-isolation/--no-build-isolation] [--upgrade-strategy {eager,only-if-needed,to-satisfy-only}] [--break-system-packages] [--no-uv] |
モジュール/アダプターのインストール |
uninstall |
rm, remove |
<package>... [--no-uv] |
モジュール/アダプターのアンインストール |
upgrade |
up |
[package]... [--force/-f] [--pre] [--no-uv] |
指定モジュールまたはすべてをアップグレード |
self-update |
su, update |
[version] [--pre] [--force/-f] [--no-uv] |
SDK 自身を更新 |
診断コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
doctor |
diag |
[--verbose] [--fix] |
環境を診断してヘルスレポートを出力。--fix は自動修復を試みます |
install
ErisPulse のモジュールまたはアダプターパッケージをインストールします。パッケージ名を指定しない場合は対話式インストール画面に入ります。
エイリアス: i, add
uv プロジェクト連携(2.11.1+):uv 管理下のプロジェクト内(
uv.lockまたは[tool.uv]が存在する場合)では、install/upgrade/uninstallが自動的にuv add/uv removeへ切り替わります——依存関係はpyproject.tomlとuv.lockに同期して書き込まれ、uv syncで epsdk がインストールしたコンポーネントが消えることはなくなります。失敗時は自動的に uv pip / pip 経路へフォールバックします。--userなど uv が対応していない引数は直接 pip を使用します。ターゲット環境の解決順序:ERISPULSE_PYTHON→UV_PROJECT_ENVIRONMENT→ プロジェクトの.venv→UV_PYTHON→VIRTUAL_ENV→ 現在のインタープリター(epsdk doctorで完全な決定チェーンを確認できます)。
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[package]... |
インストールするパッケージ名。複数指定可能 | |
--upgrade |
-U |
インストール時に最新バージョンへアップグレード |
--pre |
プレリリース版のインストールを許可 | |
--editable |
-e |
編集可能モードでインストール(パスの指定が必要) |
--user |
ユーザーの site-packages ディレクトリにインストール | |
--no-deps |
依存関係をインストールしない | |
--target |
-t |
指定したディレクトリにインストール |
--index-url |
PyPI ミラーの URL を指定 | |
--extra-index-url |
追加の PyPI ミラー URL(複数回指定可能) | |
--no-cache-dir |
キャッシュを無効化 | |
--requirement |
-r |
requirements ファイルからインストール |
--constraint |
-c |
制約ファイルからインストール |
--force-reinstall |
強制的に再インストール | |
--ignore-installed |
インストール済みパッケージを無視 | |
--compile |
インストール後に .pyc ファイルをコンパイル | |
--no-compile |
インストール後に .pyc ファイルをコンパイルしない | |
--prefix |
指定したプレフィックスディレクトリにインストール | |
--src |
編集可能インストール時に使用するソースディレクトリ | |
--config-settings |
ビルドバックエンドに渡す設定(複数回指定可能) | |
--no-binary |
バイナリパッケージを使用しないよう制限(形式は :all: など) |
|
--only-binary |
バイナリパッケージのみ使用するよう制限(形式は :all: など) |
|
--prefer-binary |
バイナリパッケージを優先選択 | |
--build-isolation |
ビルド分離を有効化 | |
--no-build-isolation |
ビルド分離を無効化 | |
--upgrade-strategy |
アップグレード戦略:eager、only-if-needed、to-satisfy-only |
|
--break-system-packages |
システムパッケージマネージャーが管理する Python パッケージの変更を許可 | |
--no-uv |
uv の代わりに pip を使用 |
例:
# 単一モジュールをインストール
epsdk install Weather
# 複数モジュールをインストール
epsdk install Yunhu Weather
# ミラーからインストールしてアップグレード
epsdk install Weather -U --index-url https://pypi.tuna.tsinghua.edu.cn/simple
# 編集可能モードでインストール(開発モード)
epsdk install -e ./my-adapter
uninstall
インストール済みの ErisPulse モジュールまたはアダプターパッケージをアンインストールします。パッケージ名を指定しない場合は対話式アンインストール画面に入ります。
エイリアス: rm, remove
引数:
| 引数 | 説明 |
|---|---|
<package>... |
アンインストールするパッケージ名。複数指定可能 |
--no-uv |
uv の代わりに pip を使用 |
例:
# 単一モジュールをアンインストール
epsdk uninstall Weather
# 複数モジュールをアンインストール
epsdk uninstall Yunhu Weather
upgrade
インストール済みの ErisPulse コンポーネントをアップグレードします。パッケージ名を指定しない場合は、対話式ですべてをアップグレードします。
エイリアス: up
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[package]... |
アップグレードするパッケージ名。複数指定可能 | |
--force |
-f |
確認をスキップして強制アップグレード |
--pre |
プレリリース版へのアップグレードを許可 | |
--no-uv |
uv の代わりに pip を使用 |
例:
# すべてのパッケージをアップグレード
epsdk upgrade
# 指定パッケージをアップグレード
epsdk upgrade Weather
# 強制アップグレード(確認をスキップ)
epsdk upgrade -f
self-update
ErisPulse SDK 自身を最新バージョンに更新します。
エイリアス: su, update
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[version] |
更新するターゲットのバージョン番号を指定 | |
--pre |
プレリリース版への更新を許可 | |
--force |
-f |
確認をスキップして強制更新 |
--no-uv |
uv の代わりに pip を使用 |
例:
# 最新安定版に更新
epsdk self-update
# 指定バージョンに更新
epsdk self-update 1.2.3
# プレリリース版を許可
epsdk self-update --pre
# 強制更新
epsdk self-update -f
Note
uv tool install ErisPulse でインストールした場合、このコマンドは自動的に uv tool upgrade ErisPulse へ切り替わります(バージョン指定時は uv tool install ErisPulse==<バージョン> --force)。pip で直接ツール環境をアップグレードすると、その変更は uv のマニフェスト復元によって消し去られてしまいます。
Windows での更新は新しいコンソールウィンドウで行われます:現在の CLI はツール環境のファイルロックを解除するために先に終了する必要があり、ウィンドウに完了が表示されたらターミナルを開き直してください。
情報照会コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
list |
l, ls |
[--type/-t {modules,adapters,all}] [--outdated/-o] |
インストール済みコンポーネントの一覧表示 |
list-remote |
lsr |
[--type/-t {modules,adapters,all}] [--refresh/-r] |
リモートで利用可能なコンポーネントの一覧表示 |
version |
ver |
SDK と Python のバージョン情報を表示(-V と同等) |
list
インストール済みの ErisPulse モジュールとアダプターを一覧表示します。
エイリアス: l, ls
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
--type |
-t |
タイプを指定:modules、adapters、all(デフォルト) |
--outdated |
-o |
アップグレード可能なパッケージのみ表示 |
例:
# インストール済みのすべてのコンポーネントを一覧表示
epsdk list
# モジュールのみ一覧表示
epsdk list -t modules
# アダプターのみ一覧表示
epsdk list -t adapters
# アップグレード可能なパッケージのみ表示
epsdk list -o
list-remote
リモートリポジトリで利用可能な ErisPulse モジュールとアダプターを一覧表示します。
エイリアス: lsr
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
--type |
-t |
タイプを指定:modules、adapters、all(デフォルト) |
--refresh |
-r |
リモートパッケージリストのキャッシュを強制的に更新 |
例:
# リモートで利用可能なすべてのコンポーネントを一覧表示
epsdk list-remote
# リモートのモジュールのみ一覧表示
epsdk list-remote -t modules
# キャッシュを強制更新してから一覧表示
epsdk list-remote -r
設定コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
config |
cfg, conf |
[name] [--list/-l] [--json] |
アダプター/モジュールの宣言型設定項目を対話式で設定 |
config
アダプター/モジュールの宣言型設定項目を対話式で入力します。ウィザードはアダプター/モジュールが宣言する設定クラス(ConfigClass / AccountConfigClass)によって駆動され、フォームの自動生成と検証が行われるため、config.toml を手書きする必要はありません。
アダプターはさらにマルチアカウント(bot アカウント)管理に対応しています:アカウントの追加/編集/削除、および有効/無効の切り替えです。
エイリアス: cfg, conf
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[name] |
ターゲット名(アダプターのプラットフォーム名またはモジュール名)。空欄で対話選択へ | |
--list |
-l |
すべてのターゲットの設定状態のみ一覧表示(ウィザードには入りません) |
--json |
すべてのターゲットとその設定状態を JSON で出力(CI / スクリプト用)。ウィザードには入りません |
例:
# すべてのアダプター/モジュールの設定状態を確認
epsdk config --list
# 設定状態を JSON で出力(CI / スクリプト用)
epsdk config --json
# 対話式でターゲットを選択して設定
epsdk config
# 指定したアダプターを直接設定
epsdk config yunhu
# 指定したモジュールを直接設定
epsdk config MyModule
説明:
- 設定状態は 4 段階に分かれます:
準備完了(検証通過)、未完成(必須項目の欠落または検証失敗)、未設定(一度も生成されていない)、設定なし(ターゲットが設定クラスを宣言していない) - フィールド値には出所が表示されます:既存の設定では
(現在:値)と表示され、未設定の場合は schema のデフォルト値が(デフォルト:値)と表示されます。Enter キーを押すだけでその値が保持されます - シークレット系フィールド(
secretを宣言)は入力時にエコーバックされず、Enter キーで設定済みの値を保持します - 対話選択モードでは、個々のウィザードが終了すると選択メニューに戻ります(状態は更新済み)。複数のターゲットを連続して設定でき、空欄入力で終了します
- グローバルフォームの検証に失敗し、再入力を断念した場合、そのウィザードは中断され、設定は一切書き込まれません(「有効だが設定が不完全」という中途半端な状態の発生を防ぎます)
- 保存すると即座に
config/config.tomlに書き込まれ、Dashboard と実行中の SDK のどちらからでも参照できます。実行中のアダプターで新しいアカウント設定を適用する必要がある場合は、プロセスを再起動すれば OK です epsdk install(対話式インストール)とepsdk initでアダプターのインストールに成功した後、設定宣言が検出されると自動的にこのウィザードへ案内します。コマンドラインでパッケージ名を直接指定してインストールした場合は、設定に関するヒントの表示のみ行います
実行制御コマンド
Tip
epsdk run はプロジェクトディレクトリ内の .venv 仮想環境を自動検出して使用し、ボットを実行します
(ERISPULSE_PYTHON 環境変数でインタープリターを明示的に指定することもできます)。epsdk install /
uninstall / upgrade / list も同様にプロジェクトの仮想環境に対して作用します。
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
run |
r |
[script] [--reload] [--strict/--no-strict] |
指定したスクリプトまたは SDK を実行 |
stop |
— | [--force] [--pid PID] |
実行中のインスタンスを停止(epsdk run で起動されたもの) |
restart |
— | [--force] [--pid PID] |
実行中のインスタンスを再起動(停止後、元の引数で再起動) |
run
ErisPulse プロジェクトのスクリプトを実行するか、SDK を直接起動します。ホットリロードモードに対応しています。
エイリアス: r
引数:
| 引数 | 説明 |
|---|---|
[script] |
実行するスクリプトファイル。指定しない場合は SDK を実行 |
--reload |
ホットリロードモードを有効化:ファイルの変更を監視し、コンポーネント単位のコードホットリロードを自動的にトリガーします(プロセス全体の再起動は不要)。デフォルトでは .venv/.git などのディレクトリを無視し(ErisPulse.framework.watch_ignore_dirs で設定可能)、プラグインディレクトリはプラグイン用ホットリロード watcher が正確に処理します |
--strict / --no-strict |
厳格モードを一時的に有効 / 無効化(今回のみ有効、設定には書き込まれません)。デフォルトは ErisPulse.framework.strict_mode に従います |
例:
# SDK を直接実行
epsdk run
# 指定したスクリプトファイルを実行
epsdk run main.py
# ホットリロードモードで実行(ファイル変更でコードレベルのホットリロードを自動トリガー)
epsdk run main.py --reload
# SDK のホットリロードモード
epsdk run --reload
# 一時的な厳格モード:起動前セルフチェックに失敗したら終了し、フレームワークの厳格レベルは今回限り最低 1 に引き上げられます
epsdk run main.py --strict
# 一時的な寛容モード(設定で strict_mode が有効でも、今回はとりあえず動かしたい場合)
epsdk run main.py --no-strict
起動前セルフチェック: run は起動前に config/config.toml の解析可能性と、インストール済みコンポーネントの必須設定の完全性を素早くチェックします。厳格性はデフォルトで ErisPulse.framework.strict_mode に従います(0 以外のときはチェック失敗で終了、0 のときは警告のみで続行)。設定ファイルが存在しない場合は正常な初回起動と見なされ、通知のみで失敗とは判定されません。--strict で一時的に有効化:プリチェックに失敗したら終了し、同時にフレームワークの厳格レベルを今回限り最低 1 に引き上げます(不適合コンポーネントはスキップ。ERISPULSE_FRAMEWORK_STRICT_MODE 環境変数を通じて実行プロセスに伝達され、設定ファイルには書き込まれません)。--no-strict はその逆で、一時的に寛容側へ切り下げます。セルフチェック自体に異常が起きた場合は自動的にスキップされ、ネットワークプローブは含まれないため、起動をブロックすることはありません。
--reloadのスーパーバイズ構造(2.11.1 以降):epsdk run --reloadは「スーパーバイザープロセス + リロード worker 子プロセス」構成で動作します。.pyファイルの保存でトリガーされるホットリロードは、すべて worker 内で完結します(排他直列・ストーム統合)。モジュール側の構文エラーは全体プリチェックで拒否され、旧インスタンスがサービスを継続します。sdk.hard_restart()のとき worker は終了コード 42 で終了し、スーパーバイザープロセスが理由を表示した後、自動的にまったく新しい worker を立ち上げ直します——フレームワーク本体のアップグレード後、新しいコードが即座に有効になります。
stop
実行中の ErisPulse インスタンス(epsdk run で起動され、同一プロジェクトディレクトリ内で実行されているもの)を停止します。
run は起動時にスーパーバイザープロセスの PID、現在のフレームワーク子プロセスの PID、元の起動コマンドを
.erispulse/runtime.json に書き込み、stop はこれに基づいてインスタンスを特定します。
停止順序: POSIX ではまずスーパーバイザープロセスに SIGINT を送信します(Ctrl+C と同じグレースフルな終了処理パス—— finally チェーンがフレームワーク子プロセスを自動終了させます)。タイムアウト時には SIGTERM / SIGKILL へと段階的に引き上げます。Windows には プロセスシグナルのセマンティクスがないため、先にフレームワーク子プロセスを終了させてからスーパーバイザープロセスを終了させます(スーパーバイザーが強制終了をクラッシュと誤認して 再起動してしまうのを防ぐため)。
引数:
| 引数 | 説明 |
|---|---|
--force |
グレースフル停止をスキップし、直接強制終了します |
--pid PID |
対象プロセスの PID を直接指定します(実行状態ファイルを上書き。非標準の起動方法用) |
例:
# 現在のプロジェクトの実行インスタンスを停止
epsdk stop
# 強制終了
epsdk stop --force
restart
実行中の ErisPulse インスタンスを再起動します:stop と同じセマンティクスで停止した後、状態ファイルに記録された
元の起動コマンドで再起動します(フォアグラウンドで現在のターミナルを引き継ぎ、新しいインスタンスが新しい実行状態ファイルを書き込みます)。
コンテナ内インスタンス(PID 1):状態ファイルに記録されたインスタンスがコンテナのメインプロセスである場合(pid == 1。公式
イメージの CMD ["epsdk", "run"] など)は、終了しての再起動は利用できません——PID 1 が終了するとコンテナも終了するためです。この場合、
代わりにフレームワークプロセスへ SIGUSR1 を送信し、プロセス内ホットリスタート(sdk.restart())をトリガーします:
モジュールとアダプターのコードレベルのホットリロードが行われ、ep i で新しくインストールしたアダプターが即座に有効になり、コンテナはオンラインを維持します。プロセス全体の再起動
(フレームワーク自体の更新、構造的な設定変更)が必要な場合は、コンテナを再起動してください(docker restart <コンテナ>)。詳細は
デプロイ → コンテナ内再起動 を参照してください。
引数: stop と同じ(--force / --pid PID)。
例:
# グレースフル再起動(pip でアダプター/モジュールをアップグレードした後にコードを反映させます。実行中のモジュールは
# sdk.reload_module / sdk.adapter.reload によるコードレベルのホットリロードも利用でき、再起動は不要です)
epsdk restart
Note
python main.py のように epsdk run を経由しない起動方法は、実行状態ファイルを書き込みません——その種の
プロセスはシステムツールで管理するか、epsdk stop --pid <PID> で PID を指定してください。
プロジェクト管理コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
init |
— | [path] [--project-name/-n <name>] [--path <dir>] [--adapter/-a <name>] [--quick/-q] [--force/-f] [--here] [--no-uv] [--no-venv] |
ErisPulse プロジェクトを初期化 |
create |
— | {module,adapter,pack} [--name/-n <name>] [--description/-d <desc>] [--author/-a <name>] [--email/-e <mail>] [--homepage <url>] [--output/-o <dir>] [--force/-f] [--local] |
モジュール/アダプターのスキャフォールドを作成。pack はローカルプラグインを公開可能なプロジェクトに変換 |
init
新しい ErisPulse プロジェクトを初期化します。対話式モードとクイックモードに対応。2.8.4 以降は pyproject.toml(依存マニフェスト)を生成し、オプションでプロジェクトの .venv 仮想環境を作成してフレームワークとアダプターをインストールでき、さらに任意のディレクトリの指定にも対応しています。
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[path] |
ターゲットパス(親ディレクトリを含められます。例:../apps/mybot。名前のみの場合は --project-name と同等) |
|
--project-name |
-n |
プロジェクト名 |
--path |
プロジェクトの親ディレクトリ(-n と組み合わせて作成場所を指定) |
|
--adapter |
-a |
インストールするアダプターを事前選択(引数の繰り返し指定またはカンマ区切りが可能)。指定した場合はアダプターの問い合わせと選択をスキップします |
--quick |
-q |
クイックモード。対話式ウィザードをスキップします(デフォルトで .venv を作成し依存関係をインストール) |
--force |
-f |
既存の設定ファイルを強制上書き |
--here |
現在のディレクトリで初期化し、サブディレクトリを作成しません | |
--no-uv |
uv の代わりに pip を使用 | |
--no-venv |
仮想環境の作成と依存関係のインストールをスキップ |
例:
# 対話式で初期化
epsdk init
# クイック初期化(現在のディレクトリに my_bot/ を作成。pyproject.toml + .venv を含む)
epsdk init -q -n my_bot
# クイック初期化+アダプター事前インストール(非対話。スクリプト / CI 向け)
epsdk init -q -n my_bot --adapter yunhu,telegram
# 任意のディレクトリを指定して初期化(../apps/mybot)
epsdk init ../apps/mybot
# 親ディレクトリとプロジェクト名を組み合わせ
epsdk init -n my_bot --path ../apps
# 既存の設定を強制上書き
epsdk init -f
# 現在のディレクトリで初期化
epsdk init --here -n my_bot
# プロジェクト構造のみ生成し、仮想環境は作成しない
epsdk init --no-venv -n my_bot
init の生成物:main.py、pyproject.toml(依存マニフェスト)、config/config.toml + config.full.example、config/ssl/、logs/、.gitignore、README.md。仮想環境の作成を選択した場合は、追加で .venv が生成され、その中に erispulse と選択したアダプターがインストールされます。
Note
.gitignore はグループ化テンプレートです:Python バイトコードとビルド成果物、仮想環境と .env、ツールキャッシュ、エディタとシステムファイルなどからなり、さらに実行時ディレクトリの config/ と logs/ を丸ごと除外します——config.toml にはアダプターのトークンなどの機密情報が含まれるため、リポジトリへのコミットは推奨されません。共有用の設定スケルトンには config.full.example を使用してください。
Warning
uv run epsdk run でボットを実行しないでください。uv run は pyproject.toml が存在しないディレクトリで実行されると使い捨ての分離環境を作成します——その中で epsdk install によりインストールされたアダプターは永続化されません。プロジェクトディレクトリ内で epsdk run を使用するか(プロジェクトの .venv を自動使用)、または先に仮想環境をアクティブ化してから実行してください。
create
ErisPulse モジュールまたはアダプターのスキャフォールドプロジェクトを作成します。pack サブコマンドは、ローカルプラグイン(plugins/ ディレクトリ)を公開可能な標準プロジェクトに変換します。
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
{module,adapter,pack} |
作成するタイプ:module / adapter / pack(プラグインをプロジェクトに変換) |
|
--name |
-n |
プロジェクト名(PascalCase) |
--description |
-d |
プロジェクトの説明 |
--author |
-a |
作者名 |
--email |
-e |
作者のメールアドレス |
--homepage |
プロジェクトのホームページ URL | |
--output |
-o |
出力ディレクトリ(デフォルトは現在のディレクトリ) |
--force |
-f |
既存のディレクトリを強制上書き |
--local |
ローカルプラグインを作成(module / adapter で利用可能):plugins/<name>/ パッケージ構造を生成し、パッケージングなしでインストール可能 |
例:
# 対話式で作成(タイプの選択と情報の入力をガイド)
epsdk create
# Module プロジェクトを直接作成
epsdk create module -n MyModule
# ローカルプラグインを作成(プロジェクトの plugins/ ディレクトリに配置され、起動時に自動検出)
epsdk create module -n MyModule --local
# ローカルアダプタープラグインを作成(同上。パッケージング不要で開発)
epsdk create adapter -n MyAdapter --local
# Adapter プロジェクトを直接作成
epsdk create adapter -n MyAdapter
# ローカルプラグインを公開可能なプロジェクトに変換(対話でプラグインを選択 → メタ情報を補完 → 標準プロジェクトを生成)
epsdk create pack
# 完全な引数指定
epsdk create module -n MyModule -d "モジュールの説明" -a "作者" -e "[email protected]"
# 出力ディレクトリを指定
epsdk create module -n MyModule -o ./projects
# 既存のディレクトリを強制上書き
epsdk create module -n MyModule -f
言語コマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
i18n |
language, lang |
[lang] [--list/-l] |
CLI の表示言語を表示または切り替え |
i18n
現在の CLI の言語を表示、対応言語の一覧表示、表示言語の切り替えを行います。引数を指定しない場合は対話式選択画面に入ります。
エイリアス: language, lang
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
[lang] |
切り替える言語コード(例:zh-CN、en、ja、ru) |
|
--list |
-l |
対応しているすべての言語を一覧表示 |
例:
# 対話式で言語を選択
epsdk i18n
# 英語に切り替え
epsdk i18n en
# 日本語に切り替え
epsdk i18n ja
# 対応しているすべての言語を一覧表示
epsdk i18n --list
型スタブコマンド
| コマンド | エイリアス | 引数 | 説明 |
|---|---|---|---|
types |
t, stub |
[--output/-o <path>] [--force] [--adapters-only] [--modules-only] |
IDE 補完を有効にするための型スタブファイルを生成 |
types
インストール済みの ErisPulse モジュールとアダプターをスキャンし、それぞれに .pyi 型スタブファイルを生成します。これにより、IDE で正確なコード補完と型チェックのサポートが得られます。
エイリアス: t, stub
引数:
| 引数 | 短い引数 | 説明 |
|---|---|---|
--output |
-o |
出力パス(デフォルトは現在のディレクトリの ep-stubs/) |
--force |
既存のスタブファイルを強制上書き | |
--adapters-only |
アダプターの型スタブのみ生成 | |
--modules-only |
モジュールの型スタブのみ生成 |
注意:
--adapters-onlyと--modules-onlyは相互に排他で、同時に指定した場合は後者が有効になります。
例:
# インストール済みのすべてのモジュールとアダプターの型スタブを生成
epsdk types
# アダプターのスタブのみ生成
epsdk types --adapters-only
# 指定したディレクトリに出力
epsdk types -o ./typings
# 既存のファイルを強制上書き
epsdk types --force
グローバル引数
以下の引数はすべてのコマンドに適用されます:
| 引数 | 短い引数 | 説明 |
|---|---|---|
--help |
-h |
ヘルプ情報を表示 |
--version |
-V |
バージョン情報を表示 |
--verbose |
-v |
詳細な出力を表示(-vv/-vvv のように重ね指定可能) |
--no-color |
カラー出力を無効化(CI / ログ収集に適する) | |
--no-banner |
起動 Banner をスキップ(スクリプト呼び出し / CI 向け。非対話ターミナルと ERISPULSE_NO_BANNER=1 の場合は自動的にサイレント化) |
|
--yes |
-y |
すべての対話プロンプトを自動確認(非対話実行) |
環境診断
doctor
Note
このコマンドには ErisPulse 2.7.0+ が必要です。
現在の CLI 実行環境を診断し、ヘルスレポートを出力します。「なぜインストールできない / 接続できない」種の問題の切り分けに使用します。
| 引数 | 説明 |
|---|---|
--verbose |
詳細な診断情報を表示 |
--fix |
診断後に修復可能な問題の自動修復を試みます |
チェック項目:
- Python:インタープリターのバージョンとパス
- インストールバックエンド:
uvとpipのどちらを使用するか - ターゲットインタープリター:パッケージが実際にインストールされるターゲットの Python 環境
- 設定ファイル:
config/config.tomlが存在するかどうか - コンポーネント設定:インストール済みコンポーネントの宣言型設定の完全性(「インストールしたのに動かない」の多くは必須項目の欠落が原因)
- 設定汚染(2.11.1+):過去のアップグレードで残った残留キー(旧バージョンのランタイムがバインドしていたシャドウ状態キーや、遊離した設定セクション)をスキャンし、検出次第通知します
- PyPI 接続性:PyPI にアクセスできるか(検出されたコンポーネント数も表示)
- システムプロキシ:プロキシが検出されたかどうか
自動修復(--fix):
config.tomlが存在しない → 現在の言語に応じた初期設定ファイルを生成(initによるプロジェクト作成と同じソース)- コンポーネント設定の「未完成」 → 対話式設定ウィザードを 1 つずつ起動して必須項目を補完(非対話環境では
epsdk config <名前>の使用を促すヒントを表示) - 設定汚染の残留キー → 出所を明示した上で確認を経て削除(tomlclass のロスレス経路。コメントと順序は保持)
- Python バージョンが低すぎる、PyPI にアクセスできないなど人手の介入が必要な問題 → 行動提案のみ出力
# 環境診断を実行
epsdk doctor
# エイリアスを使用
epsdk diag
# 診断して自動修復を試みる
epsdk doctor --fix
対話式インストール
epsdk install をパッケージ名を指定せずに実行すると、対話式インストールに入ります:
epsdk install
対話画面で提供されるもの:
- アダプターの選択
- モジュールの選択
- カスタムインストール
よくある使い方
モジュールのインストール
# 単一モジュールをインストール
epsdk install Weather
# 複数モジュールをインストール
epsdk install Yunhu Weather
# モジュールをアップグレード
epsdk install Weather -U
コンポーネントの一覧表示
# すべてのコンポーネントを一覧表示
epsdk list
# アダプターのみ一覧表示
epsdk list -t adapters
# アップグレード可能なコンポーネントのみ一覧表示
epsdk list -o
# リモートで利用可能なコンポーネントを確認
epsdk list-remote
コンポーネントのアンインストール
# 単一コンポーネントをアンインストール
epsdk uninstall Weather
# 複数コンポーネントをアンインストール
epsdk uninstall Yunhu Weather
コンポーネントの設定
# 設定状態を確認
epsdk config --list
# 対話式でターゲットを選択して設定
epsdk config
# 指定したアダプターを設定
epsdk config yunhu
コンポーネントのアップグレード
# すべてのコンポーネントをアップグレード
epsdk upgrade
# 指定したコンポーネントをアップグレード
epsdk upgrade Weather
# 強制アップグレード
epsdk upgrade -f
プロジェクトの実行
# 通常実行
epsdk run main.py
# ホットリロードモード
epsdk run main.py --reload
言語の切り替え
# 対話式で言語を選択
epsdk i18n
# 直接英語に切り替え
epsdk i18n en
# 対応言語を一覧表示
epsdk i18n --list
型スタブの生成
# すべての型スタブを生成
epsdk types
# モジュールの型スタブのみ生成
epsdk types --modules-only
プロジェクトの初期化
# 対話式で初期化
epsdk init
# クイック初期化
epsdk init -q -n my_bot
スキャフォールドの作成
# 対話式で作成(タイプの選択と情報の入力をガイド)
epsdk create
# Module プロジェクトを直接作成
epsdk create module -n MyModule
# Adapter プロジェクトを直接作成
epsdk create adapter -n MyAdapter
# 完全な引数指定
epsdk create module -n MyModule -d "モジュールの説明" -a "作者" -e "[email protected]"
# 既存のディレクトリを強制上書き
epsdk create module -n MyModule -f