メインコンテンツへスキップ

クライアントオプション一覧

クライアントの動作は config/copilot.php で設定します。 同じオプションは Copilot::client() や useStdio() / useTcp()、new Client([...]) に配列で渡すこともできます。 このページは設定ファイルにあるオプションと、設定ファイルにはないがコードから渡せるオプションの一覧です。

設定ファイルのオプション

接続まわり

  • mode: クライアントモード。'copilot-cli'(通常)か 'empty'。empty は CLI の暗黙的な機能を無効化するモードで、ベースディレクトリ・SessionFs・TCP URL のいずれかを明示する必要があります。
  • url: 既存の Copilot CLI サーバーの URL(例: tcp://127.0.0.1:12345)。設定すると SDK は新しい CLI プロセスを起動せず、このサーバーに接続します。詳しくは TCPモード を参照してください。
  • cli_path: CLI 実行ファイルのパス。null を指定すると自動で探します。
  • cli_args: CLI 起動時に渡す追加の引数(例: ['--yolo'])。
  • cwd: CLI プロセスの作業ディレクトリ。
  • log_level: CLI サーバーのログレベル。none / error / warning / info / debug / all から選びます。

既定値として使われるもの

  • timeout: sendAndWait() のデフォルトのタイムアウト(秒)。Copilot::run() でも使われます。
  • model: セッション作成時にモデルを指定しなかった場合のデフォルトモデル。
  • permission_approve: Facade(Copilot::run() など)利用時の権限リクエストの自動処理。'deny-all'(すべて拒否)/ 'approve-safety'(シェルと書き込み以外を承認)/ 'approve-all'(すべて承認)/ false(ハンドラーを注入しない)から選びます。Client を直接使う場合は常に onPermissionRequest ハンドラーが必須です。詳しくは Permission Requests を参照してください。

データの置き場所

  • copilot_home: Copilot のデータ(セッション状態や設定)のベースディレクトリ。起動する CLI プロセスの COPILOT_HOME 環境変数として渡されます。未設定の場合は CLI のデフォルト(~/.copilot)です。
  • base_directory: copilot_home と同じものを指す公式 SDK 名のエイリアス。両方を指定した場合は base_directory が優先されます。
  • session_fs: セッション状態(ファイルと SQLite)を自前のストレージへ委譲する SessionFs プロバイダーの設定。initialCwd / sessionStatePath / conventions が必須で、設定した場合は各セッションでも createSessionFsProvider の指定が必要です。
  • builtin_plugin_directories: 信頼済みの組み込みプラグインディレクトリの絶対パスの配列。クライアント起動時にランタイムへ登録されます。詳しくは Plugin Directories を参照してください。

その他

  • telemetry: OpenTelemetry の設定配列(otlpEndpoint / filePath / exporterType / sourceName / captureContent)。起動する CLI プロセスの環境変数に変換されます。詳しくは OpenTelemetry を参照してください。
  • session_idle_timeout_seconds: セッションのサーバー全体のアイドルタイムアウト(秒)。0(デフォルト)で無効になり、セッションは無期限に残ります。
  • request_handler: モデル層への HTTP リクエストを横取りする CopilotRequestHandler またはクロージャ(実験的機能)。WebSocket リクエストには使えません。

設定ファイルにないオプション

以下は設定ファイルには含まれていませんが、useStdio() や Copilot::client()、new Client([...]) の引数として渡せます。 github_token と use_logged_in_user は、外部サーバーが自身の認証を管理する TCP モードでは使えません。 設定したまま TCP 接続すると例外になります。 トークンの実行時切り替えについては GitHub トークン も参照してください。 多くのオプションには snake_case と camelCase の両方の名前が使えます(例: session_fs と sessionFs、builtin_plugin_directories と builtinPluginDirectories、request_handler と requestHandler)。
最終更新日 2026年11月16日