Update plugin-runtime documentation to clarify directory structure, installation steps, and local modifications for LangBot and langbot-plugin-sdk.

This commit is contained in:
Junyan Qin
2026-02-25 13:07:35 +08:00
parent 0071e7655c
commit 0afe882162
3 changed files with 90 additions and 22 deletions
+33 -8
View File
@@ -6,34 +6,46 @@ title: "プラグインランタイム、CLI、SDKのデバッグ"
プラグインランタイム、CLI、SDKはこちらでオープンソース化されています: https://github.com/langbot-app/langbot-plugin-sdk
</Info>
プラグインランタイムのソースコードをクローンします:
LangBotはlangbot-plugin-sdkで定義されたエンティティに依存するため、新しいディレクトリでVS Codeを開き、LangBotとlangbot-plugin-sdk(git clone https://github.com/langbot-app/langbot-plugin-sdk)をサブディレクトリとして配置することをお勧めします。ディレクトリ構造は以下の通りです:
```bash
git clone https://github.com/langbot-app/langbot-plugin-sdk
langbot-projects
├── LangBot
├── langbot-plugin-sdk
```
プラグインランタイムディレクトリに移動し、依存関係をインストールします:
LangBotディレクトリに移動し、依存関係をインストールします:
```bash
cd langbot-plugin-sdk
cd LangBot
uv sync --dev
```
この時点で、uvは自動的に仮想環境(.venv)を作成します。エディターがこの仮想環境を使用するかどうかを尋ねる場合は、`Yes`を選択してください。
または、この仮想環境を手動でアクティブ化できます:
<img
width="600"
src="/images/zh/develop/confirm_venv.png"
/>
プロンプトが表示されない場合は、右下隅からPythonインタープリターのパスをvenv内のインタープリターに手動で設定してください。
次に、VS Code下部のターミナルを開きます。これにより自動的にvenvがアクティブ化されます。
または、この仮想環境を手動でアクティブ化できます:
```bash
# .venvのパスに応じてコマンドを変更してください
source .venv/bin/activate
```
## プラグインランタイムの起動
```bash
lbp rt
uv run --no-sync lbp rt
```
`lbp`コマンドがこのディレクトリの仮想環境の`lbp`実行可能ファイルであることを確認するか、`python -m langbot_plugin.cli.__init__ rt`で起動してください。
または`python -m langbot_plugin.cli.__init__ rt`で起動してください。
プラグインランタイムは以下のパラメーターを受け入れます:
@@ -43,6 +55,18 @@ lbp rt
- `-s`: `stdio`を使用して制御接続を受け入れます。**本番環境でのみ使用してください**。
- `--skip-deps-check`: すべてのプラグイン依存関係がインストールされていることを確認するため、ランタイムは起動時に毎回すべてのインストール済みプラグインの依存関係をチェックしてインストールします。このパラメーターを使用してこのチェックを無効にします。
### LangBotでローカル修正したlangbot-plugin-sdkを使用する
メッセージエンティティやプラグインデータ定義などを変更した場合、実行時のデータ形式の互換性を確保するために、LangBot環境に更新する必要があります。
**LangBotディレクトリの仮想環境(.venv)がアクティブ化されたターミナル**で、langbot-plugin-sdkディレクトリに移動し、以下を実行します:
```bash
uv pip install .
```
これにより、修正したlangbot-plugin-sdkがLangBotの環境にインストールされます。
### LangBotをこのランタイムに接続する
LangBotの`data/config.yaml`で`plugin.runtime_ws_url`を`ws://localhost:5400/control/ws`に設定します。
@@ -52,7 +76,8 @@ plugin:
runtime_ws_url: ws://localhost:5400/control/ws
```
そして、LangBotメインプログラムの起動時に起動パラメーター`--standalone-runtime`を追加します(例: `uv run main.py --standalone-runtime`)。 LangBotを再起動すると、WebSocketを使用してこのランタイムに接続されます。
そして、LangBotメインプログラムの起動時に起動パラメーター`--standalone-runtime`を追加します(例: `uv run --no-sync main.py --standalone-runtime`)。このコマンドでは必ず`--no-sync`パラメーターを付けてください。これにより、同期したローカルのlangbot-plugin-sdkがリモート版で上書きされないことが保証されます。\
LangBotを再起動すると、WebSocketを使用してこのランタイムに接続されます。
## langbot-plugin-sdkアーキテクチャ