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

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

サポートされている Agent¶

Agent 識別子	製品名	統合方式	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 プラグインを使用
`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 識別子	説明
`claude`	内蔵アダプターを使用し、管理対象のランタイム構成を `~/.obs-agent-connector/claude/` に書き込みます。
`codebuddy`	内蔵アダプターを使用します。コネクタは `~/.codebuddy/settings.json` 内の Hook 構成を管理します。
`cursor`	内蔵アダプターを使用し、ローカルの Cursor CLI を検出して、利用可能な場合は `cursor-agent` を優先使用します。
`dsh`	`PATH` に `dsh` 実行ファイルが存在するか、`~/.dsh` ディレクトリが存在する場合に検出されます。デフォルト設定は `web` で、ランタイム構成は `dsh-otel-plugin` が生成します。
`qoder`	国際版または中国版のディレクトリを自動検出し、対応するバリアントを使用します。
`qoder-cn`	旧バージョンとの互換性のための Agent 識別子で、常に中国版ディレクトリを使用します。
`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`	データレポートに使用する認証トークン
`--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`	認証トークン
`--plugin-source`	プラグインソース。現在は `oss` または `github` をサポート
`--plugin-base-url`	外部プラグインのダウンロードベースアドレス
`--binary-only`	コネクタバイナリのみを更新し、`config.json` は書き込まない

`install.ps1`¶

パラメータ	説明
`-Version`	指定されたバージョンのコネクタをインストール（デフォルト: `latest`）
`-InstallDir`	コネクタバイナリのインストールディレクトリ
`-ConfigDir`	コネクタ設定ディレクトリ
`-DownloadBaseUrl`	コネクタインストールパッケージとメタデータのダウンロードベースアドレス
`-Endpoint`	OBS / GTrace データ受信アドレス
`-XToken`	認証トークン
`-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¶