環境変数
CLAUDE_AGENT_SDK_CLIENT_APP
環境変数。設定すると、process.env とマージする代わりにサブプロセスの環境を置き換えるため、PATH などの継承される変数を保持するには { ...process.env, YOUR_VAR: 'value' } を渡すこと。このパターンの例は Handle slow or stalled API responses を、基盤の CLI が読み取る変数は Environment variables を参照。アプリを User-Agent ヘッダーで識別させるには CLAUDE_AGENT_SDK_CLIENT_APP を設定する。
使い方・用途
- Agent SDK で構築したアプリから発信される API リクエストの User-Agent ヘッダーに自アプリ名を含め、トラフィックの識別元を示せるようにする。
- 自作アプリ経由の利用を區別して把握したい場合に、User-Agent ヘッダーへアプリ識別情報を付与する。
- リクエストヘッダーに関するエラー調査時に、ヘッダー値を供給している環境変数として特定しやすくする。
英語原文(公式ドキュメントより)
| env | Record<string, string \| undefined> | process.env | Environment variables. When set, this replaces the subprocess environment instead of merging with process.env, so pass { ...process.env, YOUR_VAR: 'value' } to keep inherited variables like PATH. See Handle slow or stalled API responses for an example of this pattern, and Environment variables for variables the underlying CLI reads. Set CLAUDE_AGENT_SDK_CLIENT_APP to identify your app in the User-Agent header |