obs-agent-connector コマンドリファレンス¶

このドキュメントでは、obs-agent-connector がサポートする Agent、よく使用するコマンド、およびコマンドライン引数をまとめて、すぐに参照できるようにします。

サポート対象の Agent¶

obs-agent-connector agents を実行すると、現在のコネクタがサポートするタイプとオペレーティングシステムを確認できます。この一覧は Agent モニタリングページのタイプ一覧とは用途が異なります。OpenTelemetry を使用して手動で接続するフレームワークについては、Agent モニタリングアプリケーションの作成を参照してください。

Agent ID	製品名	統合方法	macOS	Linux	Windows	説明
`claude`	Claude Code	`obs-agent-connector` 組み込み	✅	✅	✅	Stop / SessionEnd Hook アダプターを使用
`codebuddy`	CodeBuddy	`obs-agent-connector` 組み込み	✅	✅	✅	Stop / SessionEnd Hook とネイティブの `index.json` リプレイをサポート。Linux x64 は製品検証済み
`codex`	Codex	`obs-agent-connector` 組み込み	✅	✅	✅	Stop Hook アダプターを使用し、Codex の信頼設定と構成処理機能を内蔵
`cursor`	Cursor	`obs-agent-connector` 組み込み	✅	✅	✅	`~/.cursor` を検出し、`cursor-agent` を優先的に使用して、ユーザーレベルの Cursor Hooks を管理
`dsh`	DeepSeek Harness	`dsh-otel-plugin`	✅	✅	✅	DeepSeek Harness の設定パッケージを使用
`hermes`	Hermes	`hermes-otel-plugin`	✅	✅	❌	Hermes プラグインを使用
`mimo`	mimo	`opencode-otel-plugin`	✅	✅	✅	mimo 設定ディレクトリ配下の OpenCode 互換プラグインを使用
`opencode`	OpenCode	`opencode-otel-plugin`	✅	✅	✅	`~/.config/opencode` 配下の OpenCode 設定ディレクトリを使用
`openclaw`	OpenClaw	`openclaw-otel-plugin`	✅	✅	✅	OpenClaw プラグインを使用
`qoder`	Qoder	`qoder-otel-plugin`	✅	✅	✅	中国版または国際版のディレクトリを自動的に識別し、対応する `--variant` パラメータを渡します
`workbuddy`	WorkBuddy	`workbuddy-otel-plugin`	✅	❌	✅	検出した WorkBuddy 設定ディレクトリを使用し、その中に `gtrace.json` を書き込みます

Agent の説明¶

Agent ID	説明
`claude`	組み込みアダプターを使用し、管理されたランタイム設定を `~/.obs-agent-connector/claude/` に書き込みます。
`codebuddy`	組み込みアダプターを使用します。コネクタは `~/.codebuddy/settings.json` の Hook 設定を管理します。
`cursor`	組み込みアダプターを使用し、ローカルの Cursor CLI を検出して、利用可能な場合は `cursor-agent` を優先的に使用します。
`dsh`	`PATH` に `dsh` 実行ファイルが存在する場合、または `~/.dsh` ディレクトリが存在する場合に検出されます。デフォルト設定は `web` で、ランタイム設定は `dsh-otel-plugin` によって生成されます。
`mimo`	`~/.config/mimocode` 配下の設定を使用します。プラグインはこのディレクトリの `plugins/opencode-otel-plugin` に配置されます。接続後、`obs-agent-connector status mimo` でプラグインの状態を確認できます。
`qoder`	国際版または中国版のディレクトリを自動的に検出し、対応するバリアントを使用します。
`qoder-cn`	旧バージョンの Agent ID と互換性があり、常に中国版ディレクトリを使用します。
`hermes`	Hermes は YAML 設定を使用するため、現在サポートされている JSON 設定構造には該当しません。したがって、CLI はランタイムの有効化または無効化状態を管理しません。
`openclaw`	`~/.openclaw/openclaw.json` によるランタイムの有効化または無効化をサポートします。プラグインがプライベート設定構造を自己管理するため、`config <agent>` は現在サポートされていません。
`workbuddy`	macOS と Windows をサポートします。Linux は現在サポートされていません。

よく使用するコマンド¶

obs-agent-connector list
obs-agent-connector status <agent>
obs-agent-connector discover
obs-agent-connector discover -u
obs-agent-connector install <agent>
obs-agent-connector config <agent> list
obs-agent-connector config <agent> edit --enabled=false --endpoint=<Endpoint>
obs-agent-connector update <agent>
obs-agent-connector enable <agent>
obs-agent-connector disable <agent>
obs-agent-connector remove <agent>
obs-agent-connector uninstall
obs-agent-connector version
obs-agent-connector version -u

よく使用するパラメータ¶

一般的なインストールパラメータ¶

install <agent> を実行するときによく使用するパラメータは次のとおりです。

パラメータ	説明
`--endpoint`	OBS / GTrace データ受信アドレス（例：`<Endpoint>`）
`--x-token`	データ送信に使用する認証 Token
`--agent-id`	自動生成された `agent_id` を上書きします
`--agent-name`	自動生成された `agent_name` を上書きします
`--static-base`	今回のインストールで使用するベースアドレスを上書きします。外部オープンソースプラグインは `<static-base>/agent_plugins` から取得されます
`--yes`	確認手順をスキップします
`--dry-run`	実行計画とコマンドのプレビューのみを出力し、実際の変更は行いません

デフォルトの ID 情報の生成規則：

--agent-id が指定されていない場合、CLI は agid_<ハイフンなしの uuidv4> を自動生成します。
--agent-name が指定されていない場合、CLI は <hostname>_<agent>_<YYYYMMDD> を自動生成します。

外部プラグインの呼び出し規約：

コネクタは、公開バージョン、--type gtrace、Endpoint、Token、タグ、および設定またはバリアントパラメータのみをプラグインに渡します。
プラグインインストーラーは、アーカイブのダウンロード、チェックサム検証、プラグイン登録、プライベートランタイム設定を自ら処理します。
コネクタは --source を渡さず、外部プラグインのプライベート gtrace.json の読み書きも行いません。

組み込みアダプターのインストールパラメータ¶

以下のパラメータは、組み込みの claude、codebuddy、codex、cursor アダプターに適用されます。

パラメータ	説明
`--trace-path`	Trace データ送信パスを上書きします
`--metrics-path`	Metrics データ送信パスを上書きします
`--header`	HTTP リクエストヘッダーを追加します。繰り返し使用できます
`--tag`	リソース属性を追加します。繰り返し使用できます
`--capture-content`	コンテンツ収集モード。指定できる値は `none`、`preview`、`full` です
`--max-chars`	収集するコンテンツの最大文字数
`--enable`	ランタイム設定を `enabled=true` に設定します
`--disable`	ランタイム設定を `enabled=false` に設定します

CodeBuddy の設定は既存の ~/.codebuddy/gtrace.json にマージして書き込まれ、認識できないフィールドは削除されません。

`discover` パラメータ¶

パラメータ	説明
`-u`	インストール済みのプラグインを更新し、検出されたがまだインストールされていないプラグインをインストールします
`--endpoint`	今回の実行で使用する保存済みの Endpoint を上書きします
`--x-token`	今回の実行で使用する保存済みの Token を上書きします
`--yes`	確認手順をスキップします
`--dry-run`	検出、インストール、更新の計画のみを出力します

`update` パラメータ¶

パラメータ	説明
`--static-base`	プラグインのダウンロードベースアドレスを上書きします
`--yes`	確認手順をスキップします
`--dry-run`	更新計画のみを出力します

使用上の注意：

update は一度に 1 つの Agent のみを受け付けます。
update claude、update codebuddy、update codex、update cursor は組み込み Hook を再調整します。
外部プラグインを更新する場合、現在のランタイム設定は保持されます。

`enable` および `disable` パラメータ¶

パラメータ	説明
`--dry-run`	設定変更のみを出力し、設定ファイルには書き込みません

現在、JSON 設定によるランタイムの有効化または無効化をサポートしている Agent：

claude
codebuddy
codex
cursor
dsh
opencode
openclaw
qoder
workbuddy

`remove` パラメータ¶

パラメータ	説明
`--yes`	確認手順をスキップします
`--dry-run`	削除計画のみを出力します
`--purge-config`	ランタイム設定も削除します。CodeBuddy の場合は、データ送信状態も削除します

`version` パラメータ¶

パラメータ	説明
`-u`	コネクタを最新バージョンに更新します
`--offline`	ローカルバージョンのみを表示し、リモートバージョンは確認しません

インストールスクリプトのパラメータ¶

`install.sh`¶

パラメータ	説明
`--version`	指定したバージョンのコネクタをインストールします。デフォルトは `latest` です
`--install-dir`	コネクタバイナリファイルのインストールディレクトリ
`--config-dir`	コネクタ設定ディレクトリ
`--download-base-url`	コネクタのインストールパッケージとメタデータのダウンロードベースアドレス
`--endpoint`	OBS / GTrace データ受信アドレス
`--x-token`	認証 Token
`--plugin-source`	プラグインの取得元。現在は `oss` または `github` をサポートしています
`--plugin-base-url`	外部プラグインのダウンロードベースアドレス
`--binary-only`	コネクタのバイナリファイルのみを更新し、`config.json` には書き込みません

`install.ps1`¶

パラメータ	説明
`-Version`	指定したバージョンのコネクタをインストールします。デフォルトは `latest` です
`-InstallDir`	コネクタバイナリファイルのインストールディレクトリ
`-ConfigDir`	コネクタ設定ディレクトリ
`-DownloadBaseUrl`	コネクタのインストールパッケージとメタデータのダウンロードベースアドレス
`-Endpoint`	OBS / GTrace データ受信アドレス
`-XToken`	認証 Token
`-PluginSource`	プラグインの取得元。現在は `oss` または `github` をサポートしています
`-PluginBaseUrl`	外部プラグインのダウンロードベースアドレス
`-BinaryOnly`	コネクタのバイナリファイルのみを更新し、`config.json` には書き込みません
`-NoPathUpdate`	ユーザーの `PATH` 環境変数を更新しません

使用例¶

組み込みの CodeBuddy アダプターをインストールします。

obs-agent-connector install codebuddy --yes

指定した Endpoint と Token を使用して外部プラグインをインストールします。

obs-agent-connector install dsh \
  --endpoint <Endpoint> \
  --x-token <X-Token> \
  --yes

すべての Agent を検出し、インストール済みのプラグインを同期します。

obs-agent-connector discover -u --yes

プラグインを削除しますが、その設定は保持します。

obs-agent-connector remove codex --yes

コネクタを更新します。

obs-agent-connector version -u

obs-agent-connector コマンドリファレンス¶

サポート対象の Agent¶

Agent の説明¶

よく使用するコマンド¶

よく使用するパラメータ¶

一般的なインストールパラメータ¶

組み込みアダプターのインストールパラメータ¶

discover パラメータ¶

update パラメータ¶

enable および disable パラメータ¶

remove パラメータ¶

version パラメータ¶

インストールスクリプトのパラメータ¶

install.sh¶

install.ps1¶