高度な設定
高度な設定
Codex のローカルクライアント向けの、より高度な設定オプション
プロバイダー、ポリシー、統合をより細かく制御する必要がある場合は、これらのオプションを使用します。すぐに始めるには、設定の基本を参照してください。
プロジェクトのガイダンス、再利用可能な機能、カスタムスラッシュコマンド、サブエージェントのワークフロー、統合については、カスタマイズを参照してください。設定キーについては、設定リファレンスを参照してください。
プロファイル
プロファイルを使用すると、名前付きの設定レイヤーを保存し、CLI からそれらを
切り替えられます。--profile profile-name を渡すと、Codex は
~/.codex/config.toml を読み込み、その上に ~/.codex/profile-name.config.toml を重ねます。
プロファイル名には、英字、数字、ハイフン、アンダースコアを使用できます。
プロファイルごとに個別の TOML ファイルを作成します。プロファイルファイルでは
トップレベルの設定キーを使用し、[profiles.profile-name] の下にネストしないでください。
# ~/.codex/deep-review.config.toml
model = "gpt-5.6-sol"
model_reasoning_effort = "xhigh"
approval_policy = "on-request"
model_catalog_json = "/Users/me/.codex/model-catalogs/deep-review.json"codex --profile deep-review
codex exec --profile deep-review "review this change"プロファイルファイルは、基本のユーザー設定より上、プロジェクト設定および CLI
設定より下のレイヤーであるため、基本設定と異なる値だけを含めれば十分です。
プロファイルファイルでは model_catalog_json も上書きできます。両方のファイルで
設定されている場合、Codex はプロファイルの値を使用します。
Codex 0.134.0 以降では、--profile は config.toml から
[profiles.profile-name] を読み込まなくなり、トップレベルの profile = "profile-name"
セレクターもサポートされなくなりました。従来のプロファイル設定を
~/.codex/profile-name.config.toml に移動してから、対応する
[profiles.profile-name] テーブルと profile = "profile-name" セレクターを
config.toml から削除してください。
CLI からの一時的な上書き
~/.codex/config.toml を編集するだけでなく、CLI から単一の実行に対して設定を上書きできます。
- 専用フラグが用意されている場合は、それを優先してください(例:
--model)。 - 任意のキーを上書きする必要がある場合は、
-c/--configを使用します。
例:
# Dedicated flag
codex --model gpt-5.6-terra
# Generic key/value override (value is TOML, not JSON)
codex --config model='"gpt-5.6-terra"'
codex --config sandbox_workspace_write.network_access=true
codex --config 'shell_environment_policy.include_only=["PATH","HOME"]'注意事項:
- キーではドット記法を使用してネストされた値を設定できます(例:
mcp_servers.context7.enabled=false)。 --configの値は TOML として解析されます。判断に迷う場合は、シェルが空白で値を分割しないように値を引用符で囲んでください。- 値を TOML として解析できない場合、Codex は文字列として扱います。
設定と状態の保存場所
Codex はローカル状態を CODEX_HOME(デフォルトは ~/.codex)に保存します。
ここには通常、次のファイルがあります。
config.toml(ローカル設定)auth.json(ファイルベースの認証情報ストレージを使用する場合)または OS のキーチェーン/キーリングhistory.jsonl(履歴の永続化が有効な場合)- ログやキャッシュなど、その他のユーザー単位の状態
認証の詳細(認証情報の保存モードを含む)については、認証を参照してください。設定キーの完全な一覧については、設定リファレンスを参照してください。
リポジトリまたはシステムパスにチェックインされる共有のデフォルト、ルール、スキルについては、チーム設定を参照してください。
組み込みの OpenAI プロバイダーを LLM プロキシ、ルーター、またはデータレジデンシーが有効なプロジェクトに接続するだけなら、新しいプロバイダーを定義する代わりに、config.toml で openai_base_url を設定します。これにより、別の model_providers.<id> エントリを必要とせずに、組み込みの openai プロバイダーのベース URL が変更されます。
openai_base_url = "https://us.api.openai.com/v1"プロジェクト設定ファイル(.codex/config.toml)
ユーザー設定に加えて、Codex はリポジトリ内の .codex/config.toml ファイルからプロジェクトスコープの上書きを読み込みます。Codex はプロジェクトルートから現在の作業ディレクトリまでをたどり、見つかったすべての .codex/config.toml を読み込みます。複数のファイルで同じキーが定義されている場合は、作業ディレクトリに最も近いファイルが優先されます。
セキュリティのため、Codex はプロジェクトが信頼されている場合にのみ、プロジェクトスコープの設定ファイルを読み込みます。プロジェクトが信頼されていない場合、Codex は .codex/config.toml、プロジェクトローカルのフック、プロジェクトローカルのルールを含む、プロジェクトの .codex/ レイヤーを無視します。ユーザーおよびシステムのレイヤーは独立しており、引き続き読み込まれます。
プロジェクト設定内の相対パス(例: model_instructions_file)は、config.toml を含む .codex/ フォルダーを基準に解決されます。
プロジェクト設定ファイルでは、認証情報の転送先を変更する設定、ホスト所有アプリのリクエストメタデータを変更する設定、プロバイダー認証を変更する設定、設定プロファイルを選択する設定、またはマシンローカルの通知/テレメトリコマンドを実行する設定を上書きできません。Codex はプロジェクトローカルの .codex/config.toml にある次のキーを無視し、検出時に起動警告を表示します: openai_base_url、chatgpt_base_url、
apps_mcp_product_sku、model_provider、model_providers、notify、
profile、profiles、experimental_realtime_ws_base_url、otel。プロバイダー、通知、テレメトリのキーはユーザーレベルの
~/.codex/config.toml で設定し、設定プロファイルは --profile profile-name
および ~/.codex/profile-name.config.toml で選択してください。
フック
Codex は、アクティブな設定レイヤーの隣にある config.toml ファイル内の
hooks.json ファイルまたはインラインの [hooks] テーブルから、ライフサイクルフックを読み込むこともできます。
実際には、次の 4 つの場所が最も便利です。
~/.codex/hooks.json~/.codex/config.toml<repo>/.codex/hooks.json<repo>/.codex/config.toml
プロジェクトローカルのフックは、プロジェクトの .codex/ レイヤーが信頼されている場合にのみ読み込まれます。
ユーザーレベルのフックは、プロジェクトの信頼状態とは無関係です。
インライン TOML フックは、hooks.json と同じイベント構造を使用します。
[[hooks.PreToolUse]]
matcher = "^Bash$"
[[hooks.PreToolUse.hooks]]
type = "command"
command = '/usr/bin/python3 "$(git rev-parse --show-toplevel)/.codex/hooks/pre_tool_use_policy.py"'
timeout = 30
statusMessage = "Checking Bash command"単一のレイヤーに hooks.json とインラインの [hooks] の両方が含まれている場合、Codex は
両方を読み込み、警告を表示します。レイヤーごとにいずれか一方の形式を使用することを推奨します。
現在のイベント一覧、入力フィールド、出力動作、制限事項については、 フックを参照してください。
エージェントロール(config.toml 内の [agents])
サブエージェントのロール設定(config.toml 内の [agents])については、サブエージェントを参照してください。
プロジェクトルートの検出
Codex は、プロジェクトルートに到達するまで作業ディレクトリから上位へたどることで、プロジェクト設定(.codex/ レイヤーや AGENTS.md など)を検出します。
デフォルトでは、Codex は .git を含むディレクトリをプロジェクトルートとして扱います。この動作をカスタマイズするには、config.toml で project_root_markers を設定します。
# Treat a directory as the project root when it contains any of these markers.
project_root_markers = [".git", ".hg", ".sl"]親ディレクトリの検索を省略し、現在の作業ディレクトリをプロジェクトルートとして扱うには、project_root_markers = [] を設定します。
カスタムモデルプロバイダー
モデルプロバイダーは、Codex がモデルに接続する方法(ベース URL、ワイヤー API、認証、オプションの HTTP ヘッダー)を定義します。カスタムプロバイダーでは、予約済みの組み込みプロバイダー ID である openai、ollama、lmstudio を再利用できません。
追加のプロバイダーを定義し、model_provider でそれらを指定します。
model = "gpt-5.6-terra"
model_provider = "proxy"
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "http://proxy.example.com"
env_key = "OPENAI_API_KEY"
[model_providers.local_ollama]
name = "Ollama"
base_url = "http://localhost:11434/v1"
[model_providers.mistral]
name = "Mistral"
base_url = "https://api.mistral.ai/v1"
env_key = "MISTRAL_API_KEY"カスタムプロバイダーがスタンドアロンの Web 検索エンドポイントをサポートしている場合は、 その機能をプロバイダー設定で宣言します。
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "https://proxy.example.com/v1"
env_key = "OPENAI_API_KEY"
supports_standalone_web_search = trueカスタムプロバイダーでは、この設定のデフォルトは false です。スタンドアロン Web 検索は
開発中であり、デフォルトでは無効です。プロバイダー機能を true に設定しても
有効にはなりません。プロバイダーが互換性のあるエンドポイントをサポートし、
選択したモデルとランタイムもスタンドアロン検索をサポートしている必要があります。
設定された web_search モードと
管理対象の検索制限も引き続き適用されます。
必要に応じてリクエストヘッダーを追加します。
[model_providers.example]
http_headers = { "X-Example-Header" = "example-value" }
env_http_headers = { "X-Example-Features" = "EXAMPLE_FEATURES" }プロバイダーが外部の認証情報ヘルパーから bearer token を取得するよう Codex に要求する場合は、コマンドベースの認証を使用します。
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "https://proxy.example.com/v1"
wire_api = "responses"
[model_providers.proxy.auth]
command = "/usr/local/bin/fetch-codex-token"
args = ["--audience", "codex"]
timeout_ms = 5000
refresh_interval_ms = 300000認証コマンドは stdin を受け取らず、トークンを stdout に出力する必要があります。Codex は前後の空白を削除し、空のトークンをエラーとして扱い、refresh_interval_ms の時点で事前に更新します。認証の再試行後にのみ更新するには、refresh_interval_ms = 0 を設定します。[model_providers.<id>.auth] を env_key、experimental_bearer_token、requires_openai_auth のいずれかと併用しないでください。
Amazon Bedrock プロバイダー
Codex には、組み込みの amazon-bedrock モデルプロバイダーが含まれています。これを
model_provider として直接設定します。カスタムプロバイダーとは異なり、この組み込みプロバイダーでは、
ネストされた AWS プロファイルとリージョンの上書きのみがサポートされます。
model_provider = "amazon-bedrock"
model = "<bedrock-model-id>"
[model_providers.amazon-bedrock.aws]
profile = "default"
region = "eu-central-1"profile を省略すると、Codex は標準の AWS 認証情報チェーンを使用します。
リクエストを処理する、サポート対象の Bedrock リージョンを region に設定します。
設定手順全体、認証オプション、サポートされているモデル、機能の 提供状況については、Amazon Bedrock で ChatGPT Work と Codex を使用するを参照してください。
OSS モード(ローカルプロバイダー)
--oss を渡すと、Codex は Ollama や LM
Studio などのローカルな「オープンソース」プロバイダーに対して実行できます。単一の実行で使用するプロバイダーは
--local-provider で選択するか、oss_provider をデフォルトとして設定します。どちらも設定されていない場合、
対話型 CLI では選択を求めるプロンプトが表示され、codex exec はエラーで終了します。
# Default local provider used with `--oss`
oss_provider = "ollama" # or "lmstudio"Azure プロバイダーとプロバイダー単位の調整
[model_providers.azure]
name = "Azure"
base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
env_key = "AZURE_OPENAI_API_KEY"
query_params = { api-version = "2025-04-01-preview" }
wire_api = "responses"
request_max_retries = 4
stream_max_retries = 10
stream_idle_timeout_ms = 300000組み込みの OpenAI プロバイダーのベース URL を変更するには、openai_base_url を使用してください。組み込みプロバイダー ID は上書きできないため、[model_providers.openai] を作成しないでください。
データレジデンシーを使用する API 組織
データレジデンシーを有効にして作成されたプロジェクトでは、モデルプロバイダーを作成し、base_url を正しいプレフィックスに更新できます。データレジデンシーを使用する ChatGPT ワークスペースでは、カスタムプロバイダーは不要です。ChatGPT でサインインすると、Codex はワークスペースのレジデンシー設定に従います。
model_provider = "openaidr"
[model_providers.openaidr]
name = "OpenAI Data Residency"
base_url = "https://us.api.openai.com/v1" # Replace 'us' with domain prefixモデルの推論、詳細度、制限
model_reasoning_summary = "none" # Disable summaries
model_verbosity = "low" # Shorten responses
model_supports_reasoning_summaries = true # Force reasoning
model_context_window = 128000 # Context window sizemodel_verbosity は、Responses API を使用するプロバイダーにのみ適用されます。Chat Completions プロバイダーはこの設定を無視します。
承認ポリシーとサンドボックスモード
承認の厳格さ(Codex が一時停止するタイミングに影響)とサンドボックスレベル(ファイル/ネットワークアクセスに影響)を選択します。
config.toml を編集する際に留意すべき運用上の詳細については、一般的なサンドボックスと承認の組み合わせ、書き込み可能なルート内の保護されたパス、ネットワークアクセスを参照してください。
Codex と ChatGPT Work は、approval_policy = "untrusted" をサポートしなくなりました。
廃止された untrusted 承認ポリシーからの移行で、
サポートされている設定と、プロジェクトに基づくより厳格な承認について確認してください。
ファイルシステムとネットワークアクセスをまとめて設定するベータ版の権限プロファイルについては、権限を参照してください。
詳細な承認ポリシー(approval_policy = { granular = { ... } })を使用して、プロンプトのカテゴリごとに許可または自動拒否することもできます。これは、一部のケースでは通常の対話型承認を使用しつつ、request_permissions やスキルスクリプトのプロンプトなど、その他のケースは自動的にフェイルクローズさせたい場合に便利です。
approvals_reviewer = "auto_review" を設定すると、対象となる対話型の承認
リクエストが自動レビューに送られます。これにより変更されるのはレビュアーであり、サンドボックスの
境界ではありません。
ローカルレビュアーのポリシー指示には [auto_review].policy を使用します。管理対象の
guardian_policy_config が優先されます。
approval_policy = "on-request" # Other options: never or { granular = { ... } }
approvals_reviewer = "user" # Or "auto_review" for automatic review
sandbox_mode = "workspace-write"
allow_login_shell = false # Optional hardening: disallow login shells for shell tools
# Example granular approval policy:
# approval_policy = { granular = {
# sandbox_approval = true,
# rules = true,
# mcp_elicitations = true,
# request_permissions = false,
# skill_approval = false
# } }
[sandbox_workspace_write]
exclude_tmpdir_env_var = false # Allow $TMPDIR
exclude_slash_tmp = false # Allow /tmp
writable_roots = ["/Users/YOU/.pyenv/shims"]
network_access = false # Opt in to outbound network
[auto_review]
policy = """
Use your organization's automatic review policy.
"""名前付き権限プロファイル
組み込みプロファイル、カスタムプロファイルの構文、ファイルシステムと ネットワークの完全な設定モデルについては、権限を参照してください。
キーの完全な一覧と要件の制約については、 設定リファレンスおよび 管理対象の設定を参照してください。
サンドボックスを完全に無効にします(環境側ですでにプロセスが分離されている場合にのみ使用してください)。
sandbox_mode = "danger-full-access"シェル環境ポリシー
shell_environment_policy は、Codex が起動したコマンドに渡す環境変数を
制御します。inherit = "none" を使用して空の環境から開始するか、
inherit = "core" を使用して絞り込まれた変数セットを継承します。不要なシークレットが起動したコマンドに
渡されないよう、明示的な値とキーベースのフィルターを追加してください。
[shell_environment_policy]
inherit = "core"
set = { MY_FLAG = "1" }
ignore_default_excludes = false
[shell_environment_policy.filters]
"AWS_*" = "exclude"
"AZURE_*" = "exclude"フィルターパターンでは大文字と小文字が区別されず、* と ? がサポートされます。一致する変数を削除するには "exclude"
を使用します。パターンのいずれかで "include" を使用すると、Codex は
include パターンに一致する変数のみを保持します。include によって、すでに除外された変数が復元されることは
ありません。フィルターキーは設定レイヤー間で、大文字と小文字を区別せずに
マージされます。
ignore_default_excludes のデフォルトは true であるため、Codex は
KEY、SECRET、TOKEN を含む変数名を自動的には削除しません。明示的なフィルターを実行する前に
これらの自動除外を適用するには、false に設定します。
Codex は、最初に自動除外、次にカスタム除外、
set の値、最後に include パターンの許可リストを適用します。set は
除外の後に実行されるため、除外された変数を復元できます。ただし、include パターンの許可リストによって、
復元された値が削除される場合があります。
従来の exclude および include_only 配列も、既存の
設定向けに引き続きサポートされています。同じ設定レイヤー内で、いずれかの配列を
[shell_environment_policy.filters] と併用しないでください。Codex は
この組み合わせを拒否します。
MCP server
設定の詳細については、専用の MCP ドキュメントを参照してください。
オブザーバビリティとテレメトリ
OpenTelemetry(OTel)ログのエクスポートを有効にすると、Codex の実行(API リクエスト、SSE/イベント、プロンプト、ツールの承認/結果)を追跡できます。デフォルトでは無効です。[otel] で明示的に有効にします。
[otel]
environment = "staging" # defaults to "dev"
exporter = "none" # set to otlp-http or otlp-grpc to send events
log_user_prompt = false # redact user prompts unless explicitly enabledエクスポーターを選択します。
[otel]
exporter = { otlp-http = {
endpoint = "https://otel.example.com/v1/logs",
protocol = "binary",
headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" }
}}[otel]
exporter = { otlp-grpc = {
endpoint = "https://otel.example.com:4317",
headers = { "x-otlp-meta" = "abc123" }
}}exporter = "none" の場合、Codex はイベントを記録しますが、何も送信しません。エクスポーターは非同期でバッチ処理し、終了時にフラッシュします。イベントメタデータには、サービス名、CLI バージョン、環境タグ、会話 ID、モデル、サンドボックス/承認設定、イベントごとのフィールドが含まれます(設定リファレンスを参照)。
出力される内容
Codex は、実行とツール使用に関する構造化ログイベントを出力します。代表的なイベントタイプは次のとおりです。
codex.conversation_starts(モデル、推論設定、サンドボックス/承認ポリシー)codex.api_request(試行、ステータス/成功、所要時間、エラーの詳細)codex.sse_event(ストリームイベントの種類、成功/失敗、所要時間、およびresponse.completedでのトークン数)codex.websocket_requestおよびcodex.websocket_event(リクエスト所要時間と、メッセージごとの種類/成功/エラー)codex.user_prompt(長さ。明示的に有効にしない限り、内容は秘匿されます)codex.tool_decision(承認/拒否、および決定が設定とユーザーのどちらによるものか)codex.tool_result(所要時間、成功、出力の抜粋)
出力される OTel メトリクス
OTel メトリクスパイプラインが有効な場合、Codex は API、ストリーム、ツールのアクティビティに関するカウンターと所要時間ヒストグラムを出力します。
以下の各メトリクスには、デフォルトのメタデータタグ auth_mode、originator、session_source、model、app.version も含まれます。
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
codex.api_request |
counter | status, success |
HTTP ステータスおよび成功/失敗別の API リクエスト数。 |
codex.api_request.duration_ms |
histogram | status, success |
API リクエストの所要時間(ミリ秒)。 |
codex.sse_event |
counter | kind, success |
イベント種別および成功/失敗別の SSE イベント数。 |
codex.sse_event.duration_ms |
histogram | kind, success |
SSE イベント処理の所要時間(ミリ秒)。 |
codex.websocket.request |
counter | success |
成功/失敗別の WebSocket リクエスト数。 |
codex.websocket.request.duration_ms |
histogram | success |
WebSocket リクエストの所要時間(ミリ秒)。 |
codex.websocket.event |
counter | kind, success |
タイプおよび成功/失敗別の WebSocket メッセージ/イベント数。 |
codex.websocket.event.duration_ms |
histogram | kind, success |
WebSocket メッセージ/イベント処理の所要時間(ミリ秒)。 |
codex.tool.call |
counter | tool, success |
ツール名および成功/失敗別のツール呼び出し数。 |
codex.tool.call.duration_ms |
histogram | tool, success |
ツール名および結果別のツール実行所要時間(ミリ秒)。 |
テレメトリに関するセキュリティとプライバシーの詳しいガイダンスについては、セキュリティを参照してください。
メトリクス
デフォルトでは、Codex は少量の匿名の利用状況および正常性データを OpenAI に定期的に送信します。これは、Codex が正しく動作していない状況を検出し、使用されている機能や設定オプションを把握するために役立ちます。これにより、Codex チームは最も重要な点に注力できます。これらのメトリクスには、個人を特定できる情報(PII)は含まれません。メトリクスの収集は、OTel のログ/トレースのエクスポートとは独立しています。
マシン上の ChatGPT デスクトップアプリ、Codex CLI、IDE 拡張機能のすべてでメトリクス収集を完全に無効にするには、設定で analytics フラグを設定します。
[analytics]
enabled = false各メトリクスには、固有のフィールドに加えて、以下のデフォルトコンテキストフィールドが含まれます。
デフォルトのコンテキストフィールド(すべてのイベント/メトリクスに適用)
auth_mode:swic|api|unknown。model: 使用されたモデルの名前。app.version: Codex のバージョン。
メトリクスカタログ
各メトリクスには、必須フィールドに加えて、上記のデフォルトコンテキストフィールドが含まれます。以下のメトリクス名では、codex. プレフィックスを省略しています。
ほとんどのメトリクス名は codex-rs/otel/src/metrics/names.rs に集約されています。このファイル以外で出力される機能固有のメトリクスも、ここに含まれています。
メトリクスに tool フィールドが含まれる場合、その値は使用された内部ツール(例: apply_patch または shell)を示し、実際のシェルコマンドや、codex が適用しようとしているパッチは含みません。
ランタイムとモデル転送
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
api_request |
counter | status, success |
HTTP ステータスおよび成功/失敗別の API リクエスト数。 |
api_request.duration_ms |
histogram | status, success |
API リクエストの所要時間(ミリ秒)。 |
sse_event |
counter | kind, success |
イベント種別および成功/失敗別の SSE イベント数。 |
sse_event.duration_ms |
histogram | kind, success |
SSE イベント処理の所要時間(ミリ秒)。 |
websocket.request |
counter | success |
成功/失敗別の WebSocket リクエスト数。 |
websocket.request.duration_ms |
histogram | success |
WebSocket リクエストの所要時間(ミリ秒)。 |
websocket.event |
counter | kind, success |
タイプおよび成功/失敗別の WebSocket メッセージ/イベント数。 |
websocket.event.duration_ms |
histogram | kind, success |
WebSocket メッセージ/イベント処理の所要時間(ミリ秒)。 |
responses_api_overhead.duration_ms |
histogram | WebSocket レスポンスにおける Responses API のオーバーヘッド時間。 | |
responses_api_inference_time.duration_ms |
histogram | WebSocket レスポンスにおける Responses API の推論時間。 | |
responses_api_engine_iapi_ttft.duration_ms |
histogram | Responses API エンジンの IAPI における最初のトークンまでの時間。 | |
responses_api_engine_service_ttft.duration_ms |
histogram | Responses API エンジンサービスにおける最初のトークンまでの時間。 | |
responses_api_engine_iapi_tbt.duration_ms |
histogram | Responses API エンジンの IAPI におけるトークン間の時間。 | |
responses_api_engine_service_tbt.duration_ms |
histogram | Responses API エンジンサービスにおけるトークン間の時間。 | |
transport.fallback_to_http |
counter | from_wire_api |
WebSocket から HTTP へのフォールバック数。 |
remote_models.fetch_update.duration_ms |
histogram | リモートモデル定義の取得時間。 | |
remote_models.load_cache.duration_ms |
histogram | リモートモデルキャッシュの読み込み時間。 | |
startup_prewarm.duration_ms |
histogram | status |
結果別の起動時プリウォーム所要時間。 |
startup_prewarm.age_at_first_turn_ms |
histogram | status |
最初の実際のターンで解決された時点の、起動時プリウォーム経過時間。 |
cloud_requirements.fetch.duration_ms |
histogram | ワークスペース管理のクラウド要件の取得時間。 | |
cloud_requirements.fetch_attempt |
counter | 注記を参照 | ワークスペース管理のクラウド要件の取得試行回数。 |
cloud_requirements.fetch_final |
counter | 注記を参照 | ワークスペース管理のクラウド要件取得の最終結果。 |
cloud_requirements.load |
counter | trigger, outcome |
ワークスペース管理のクラウド要件の読み込み結果。 |
cloud_requirements.fetch_attempt メトリクスには、trigger、attempt、outcome、status_code フィールドが含まれます。cloud_requirements.fetch_final メトリクスには、trigger、outcome、reason、attempt_count、status_code フィールドが含まれます。
ターンとツールのアクティビティ
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
turn.e2e_duration_ms |
histogram | ターン全体のエンドツーエンド時間。 | |
turn.ttft.duration_ms |
histogram | ターンで最初のトークンが返るまでの時間。 | |
turn.ttfm.duration_ms |
histogram | ターンで最初のモデル出力項目が返るまでの時間。 | |
turn.network_proxy |
counter | active, tmp_mem_enabled |
ターンで管理対象ネットワークプロキシが有効だったかどうか。 |
turn.memory |
counter | read_allowed, feature_enabled, config_use_memories, has_citations |
ターンごとのメモリ読み取り可否とメモリ引用の使用状況。 |
turn.tool.call |
histogram | tmp_mem_enabled |
ターン内のツール呼び出し数。 |
turn.token_usage |
histogram | token_type, tmp_mem_enabled |
トークンタイプ(total、input、cached_input、output、reasoning_output)別のターンごとのトークン使用量。 |
tool.call |
counter | tool, success |
ツール名および成功/失敗別のツール呼び出し数。 |
tool.call.duration_ms |
histogram | tool, success |
ツール名および結果別のツール実行所要時間(ミリ秒)。 |
tool.unified_exec |
counter | tty |
TTY モード別の統合 exec ツール呼び出し数。 |
approval.requested |
counter | tool, approved |
ツール承認リクエストの結果(approved、approved_with_amendment、approved_for_session、denied、abort)。 |
mcp.call |
counter | 注記を参照 | MCP ツール呼び出しの結果。 |
mcp.call.duration_ms |
histogram | 注記を参照 | MCP ツール呼び出しの所要時間。 |
mcp.tools.list.duration_ms |
histogram | cache |
キャッシュのヒット/ミス状態を含む MCP ツール一覧取得の所要時間。 |
mcp.tools.fetch_uncached.duration_ms |
histogram | キャッシュミスとなった MCP ツール取得の所要時間。 | |
mcp.tools.cache_write.duration_ms |
histogram | Codex Apps の MCP ツールキャッシュ書き込みの所要時間。 | |
hooks.run |
counter | hook_name, source, status |
フック名、ソース、ステータス別のフック実行回数。 |
hooks.run.duration_ms |
histogram | hook_name, source, status |
フック実行の所要時間(ミリ秒)。 |
mcp.call および mcp.call.duration_ms メトリクスには status が含まれます。通常のツール呼び出しの出力には、tool に加え、利用可能な場合は connector_id と connector_name も含まれます。ブロックされた Codex Apps MCP 呼び出しでは、status のみを伴う mcp.call が出力される場合があります。
スレッド、タスク、機能
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
feature.state |
counter | feature, value |
デフォルトと異なる機能値(デフォルト以外の値ごとに 1 行を出力)。 |
status_line |
counter | 設定済みのステータス行で開始されたセッション。 | |
model_warning |
counter | モデルに送信された警告。 | |
thread.started |
counter | is_git |
新規作成されたスレッド。作業ディレクトリが Git リポジトリ内かどうかでタグ付け。 |
conversation.turn.count |
counter | スレッド終了時に記録される、スレッドごとのユーザー/アシスタントのターン数。 | |
thread.fork |
counter | source |
既存スレッドのフォークによって作成された新しいスレッド。 |
thread.rename |
counter | 名前が変更されたスレッド。 | |
thread.side |
counter | source |
作成されたサイド会話。 |
thread.skills.enabled_total |
histogram | 新しいスレッドで有効なスキルの数。 | |
thread.skills.kept_total |
histogram | プロンプトのレンダリング後も有効なまま保持されたスキルの数。 | |
thread.skills.truncated |
histogram | スキルのレンダリングで有効なスキル一覧が切り詰められたかどうか(1 または 0)。 |
|
task.compact |
counter | type |
手動および自動を含む、タイプ(remote または local)別のコンパクション数。 |
task.review |
counter | トリガーされたレビューの数。 | |
task.undo |
counter | トリガーされた取り消し操作の数。 | |
task.user_shell |
counter | ユーザーによるシェル操作の数(例: TUI の !)。 |
|
shell_snapshot |
counter | 注記を参照 | シェルスナップショットの取得が成功したかどうか。 |
shell_snapshot.duration_ms |
histogram | success |
シェルスナップショットの取得時間。 |
skill.injected |
counter | status, skill |
スキル別のスキル注入結果。 |
plugins.startup_sync |
counter | transport, status |
キュレーション済みプラグインの起動時同期試行回数。 |
plugins.startup_sync.final |
counter | transport, status |
キュレーション済みプラグインの起動時同期の最終結果。 |
multi_agent.spawn |
counter | role |
ロール別のエージェント起動数。 |
multi_agent.resume |
counter | エージェントの再開回数。 | |
multi_agent.nickname_pool_reset |
counter | エージェントのニックネームプールのリセット回数。 |
shell_snapshot メトリクスには success が含まれ、失敗時には failure_reason も含まれます。
メモリとローカル状態
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
memory.phase1 |
counter | status |
ステータス別のメモリフェーズ 1 ジョブ数。 |
memory.phase1.e2e_ms |
histogram | メモリフェーズ 1 のエンドツーエンド所要時間。 | |
memory.phase1.output |
counter | 書き込まれたメモリフェーズ 1 の出力数。 | |
memory.phase1.token_usage |
histogram | token_type |
トークンタイプ別のメモリフェーズ 1 のトークン使用量。 |
memory.phase2 |
counter | status |
ステータス別のメモリフェーズ 2 ジョブ数。 |
memory.phase2.e2e_ms |
histogram | メモリフェーズ 2 のエンドツーエンド所要時間。 | |
memory.phase2.input |
counter | メモリフェーズ 2 の入力数。 | |
memory.phase2.token_usage |
histogram | token_type |
トークンタイプ別のメモリフェーズ 2 のトークン使用量。 |
memories.usage |
counter | kind, tool, success |
種類、ツール、成功/失敗別のメモリ使用状況。 |
external_agent_config.detect |
counter | 注記を参照 | 移行項目タイプ別の外部エージェント設定の検出数。 |
external_agent_config.import |
counter | 注記を参照 | 移行項目タイプ別の外部エージェント設定のインポート数。 |
db.backfill |
counter | status |
初期状態 DB バックフィルの結果(upserted、failed)。 |
db.backfill.duration_ms |
histogram | status |
初期状態 DB バックフィルの所要時間。 |
db.error |
counter | stage |
状態 DB 操作中のエラー。 |
external_agent_config.detect および external_agent_config.import メトリクスには migration_type が含まれます。スキルの移行には skills_count も含まれます。
Windows サンドボックス
| メトリクス | タイプ | フィールド | 説明 |
|---|---|---|---|
windows_sandbox.setup_success |
counter | originator, mode |
Windows サンドボックスのセットアップ成功回数。 |
windows_sandbox.setup_failure |
counter | originator, mode |
Windows サンドボックスのセットアップ失敗回数。 |
windows_sandbox.setup_duration_ms |
histogram | result, originator, mode |
Windows サンドボックスのセットアップ所要時間。 |
windows_sandbox.elevated_setup_success |
counter | 昇格された Windows サンドボックスのセットアップ成功回数。 | |
windows_sandbox.elevated_setup_failure |
counter | 注記を参照 | 昇格された Windows サンドボックスのセットアップ失敗回数。 |
windows_sandbox.elevated_setup_canceled |
counter | 注記を参照 | キャンセルされた昇格済み Windows サンドボックスのセットアップ試行回数。 |
windows_sandbox.elevated_setup_duration_ms |
histogram | result |
昇格されたサンドボックスのセットアップ所要時間。 |
windows_sandbox.elevated_prompt_shown |
counter | 昇格されたサンドボックスのセットアッププロンプト表示回数。 | |
windows_sandbox.elevated_prompt_accept |
counter | 昇格されたサンドボックスのセットアッププロンプト承認回数。 | |
windows_sandbox.elevated_prompt_use_legacy |
counter | 昇格プロンプトでユーザーが従来のサンドボックスを選択した回数。 | |
windows_sandbox.elevated_prompt_quit |
counter | 昇格プロンプトからユーザーが終了した回数。 | |
windows_sandbox.fallback_prompt_shown |
counter | フォールバックのサンドボックスプロンプト表示回数。 | |
windows_sandbox.fallback_retry_elevated |
counter | フォールバックプロンプトからユーザーが昇格セットアップを再試行した回数。 | |
windows_sandbox.fallback_use_legacy |
counter | フォールバックプロンプトでユーザーが従来のサンドボックスを選択した回数。 | |
windows_sandbox.fallback_prompt_quit |
counter | フォールバックプロンプトからユーザーが終了した回数。 | |
windows_sandbox.legacy_setup_preflight_failed |
counter | 注記を参照 | 従来の Windows サンドボックスのセットアップ事前チェック失敗。 |
windows_sandbox.setup_elevated_sandbox_command |
counter | 昇格されたサンドボックスのセットアップコマンド呼び出し回数。 | |
windows_sandbox.createprocessasuserw_failed |
counter | error_code, path_kind, exe, level |
Windows の CreateProcessAsUserW 失敗。 |
昇格されたセットアップ失敗メトリクスには、Windows のセットアップ失敗の詳細を取得できる場合、code と message が含まれます。また、共有セットアップパスから出力された場合は、originator が含まれることがあります。windows_sandbox.legacy_setup_preflight_failed メトリクスには、共有セットアップパスから出力された場合、originator が含まれますが、フォールバックプロンプトのプリフライト失敗にはフィールドが一切含まれないことがあります。
フィードバックの制御
デフォルトでは、ローカルクライアントから /feedback を使用してフィードバックを送信できます。マシン上の ChatGPT デスクトップアプリ、Codex CLI、IDE 拡張機能のすべてでフィードバック収集を無効にするには、設定を更新します。
[feedback]
enabled = false無効にすると、/feedback に無効であることを示すメッセージが表示され、Codex はフィードバックの送信を拒否します。
推論イベントを非表示または表示する
(CI ログなどで)ノイズの多い「推論」出力を減らしたい場合は、出力を抑制できます。
hide_agent_reasoning = trueモデルが生の推論内容を出力したときに、それを表示するには次のようにします。
show_raw_agent_reasoning = true生の推論は、ワークフロー上問題がない場合にのみ有効にしてください。一部のモデルやプロバイダー(gpt-oss など)は生の推論を出力しないため、その場合、この設定による見た目上の変化はありません。
通知
Codex が対応イベント(現在は agent-turn-complete のみ)を出力するたびに外部プログラムを起動するには、notify を使用します。組み込みの TUI 通知では対応できないデスクトップトースト、チャット Webhook、CI 更新、その他のサイドチャネル通知に便利です。
notify = ["python3", "/path/to/notify.py"]agent-turn-complete に反応する notify.py の例(省略版):
#!/usr/bin/env python3
import json, subprocess, sys
def main() -> int:
notification = json.loads(sys.argv[1])
if notification.get("type") != "agent-turn-complete":
return 0
title = f"Codex: {notification.get('last-assistant-message', 'Turn Complete!')}"
message = " ".join(notification.get("input-messages", []))
subprocess.check_output([
"terminal-notifier",
"-title", title,
"-message", message,
"-group", "codex-" + notification.get("thread-id", ""),
"-activate", "com.googlecode.iterm2",
])
return 0
if __name__ == "__main__":
sys.exit(main())スクリプトは JSON 引数を 1 つ受け取ります。一般的なフィールドは次のとおりです。
type(現在はagent-turn-complete)thread-id(セッション識別子)turn-id(ターン識別子)cwd(作業ディレクトリ)input-messages(そのターンにつながったユーザーメッセージ)last-assistant-message(最後のアシスタントメッセージのテキスト)
スクリプトをディスク上の任意の場所に配置し、notify でその場所を指定します。
notify と tui.notifications の違い
notifyは外部プログラムを実行します(Webhook、デスクトップ通知、CI フックに適しています)。tui.notificationsは TUI に組み込まれており、必要に応じてイベントタイプ(agent-turn-completeやapproval-requestedなど)で絞り込めます。tui.notification_methodは、TUI がターミナル通知をどのように出力するか(auto、osc9、belのいずれか)を制御します。tui.notification_conditionは、ターミナルがunfocusedまたはalwaysの場合にのみ TUI 通知を発生させるかどうかを制御します。
auto モードでは、Codex は OSC 9 通知(一部のターミナルがデスクトップ通知として解釈するターミナルエスケープシーケンス)を優先し、それ以外の場合は BEL(\x07)にフォールバックします。
正確なキーについては、設定リファレンスを参照してください。
履歴の永続化
デフォルトでは、Codex はローカルセッションのトランスクリプトを CODEX_HOME(例:~/.codex/history.jsonl)に保存します。ローカル履歴の永続化を無効にするには、次のようにします。
[history]
persistence = "none"履歴ファイルのサイズに上限を設けるには、history.max_bytes を設定します。ファイルが上限を超えると、Codex は最も古いエントリを削除し、最新のレコードを維持したままファイルを圧縮します。
[history]
max_bytes = 104857600 # 100 MiBクリック可能な引用
対応するターミナル/エディター統合を使用している場合、Codex はファイルの引用をクリック可能なリンクとして表示できます。Codex が使用する URI スキームを選択するには、file_opener を設定します。
file_opener = "vscode" # or cursor, windsurf, vscode-insiders, none例:/home/user/project/main.py:42 のような引用を、クリック可能な vscode://file/...:42 リンクに書き換えられます。
プロジェクト指示の検出
Codex は AGENTS.md(および関連ファイル)を読み取り、セッションの最初のターンに、量を制限したプロジェクトガイダンスを含めます。この動作は 2 つの設定で制御できます。
project_doc_max_bytes:各AGENTS.mdファイルから読み取る量project_doc_fallback_filenames:ディレクトリ階層にAGENTS.mdがない場合に追加で試すファイル名
詳しい手順については、AGENTS.md を使用したカスタム指示を参照してください。
デスクトップ
このセクションのオプションは、ChatGPT デスクトップアプリにのみ適用されます。
カスタムファイルハンドラーを追加する
ユーザーレベルの ~/.codex/config.toml で、desktop.custom_file_handlers の下にエントリを追加すると、ChatGPT デスクトップアプリがデフォルトでは対応していないエディターや内部ランチャーでファイルを開けます。各エントリは、アプリの Open in メニューにエディターの選択肢を追加します。command が既存の絶対パスであるか、アプリの PATH から解決できる場合、その選択肢がアプリに表示されます。
次の例では、ファイルをハンドラーに渡す 3 つの方法を示します。
# Append the opened path directly after the command.
[desktop.custom_file_handlers.vscodium]
label = "VSCodium"
icon = "/Users/you/.codex/icons/vscodium.png"
command = "codium"
# Place fixed arguments before the opened path.
[desktop.custom_file_handlers.textedit]
label = "TextEdit"
icon = "/Users/you/.codex/icons/textedit.png"
command = "/usr/bin/open"
args = ["-a", "TextEdit"]
# Append one JSON argument with the path and editor context.
[desktop.custom_file_handlers.company_editor]
label = "Company Editor"
icon = "/opt/company/editor/icon.png"
command = "/opt/company/bin/editor"
input = "json_argument"config.toml を保存してから、ChatGPT デスクトップアプリを再起動します。
ハンドラー ID は TOML テーブルヘッダーの最後のセグメントです。長さは 1~64 文字で、ASCII の英字または数字で始まり、それ以外の文字には ASCII の英字、数字、ピリオド、アンダースコア、ハイフンのみを使用できます。アプリでは ID に custom: プレフィックスが付けられます。たとえば、company_editor は custom:company_editor になります。ピリオドを含む ID は、TOML がネストされたテーブルとして解釈しないように引用符で囲んでください。例:
[desktop.custom_file_handlers."company.editor"]
label = "Company Editor"
icon = "/opt/company/editor/icon.png"
command = "/opt/company/bin/editor"各ハンドラーでは、次のフィールドを使用できます。
| フィールド | 必須 | 説明 |
|---|---|---|
label |
はい | アプリ内での表示名。 |
icon |
はい | apps/vscode.png などの組み込みアプリアイコン、base64 data:image/... URL、file: URI、またはローカル画像の絶対パス。未対応のソースではデフォルトの VS Code アイコンが使用されます。 |
command |
はい | 検出して起動する実行ファイルのパスまたはコマンド名。 |
args |
いいえ | command とファイル入力の間に挿入される文字列配列。デフォルトは [] です。 |
input |
いいえ | アプリがファイル入力を渡す方法:path、json_argument、json_stdin のいずれか。デフォルトは path です。 |
supports_ssh |
いいえ | SSH ワークスペース内のファイルに対してハンドラーを表示するかどうか。デフォルトは false です。ハンドラーがリモートホストとパスの詳細を必要とする場合は、json_stdin を使用します。 |
input の値は、args の後に続く内容を制御します。
pathは、パスを最後のコマンド引数として追加します。json_argumentは、target、path、appPath、locationを含む JSON オブジェクトを追加します。locationの値は、1 から始まるlineとcolumnの値を持つオブジェクト、またはnullです。json_stdinは、引数を追加する代わりに JSON オブジェクトを標準入力へ書き込みます。さらにhostConfig、remoteWorkspaceRoot、remotePathが含まれます。これらのフィールドは、該当しない場合はnullになります。
たとえば、ユーザーがソース内の特定位置を開くと、company_editor は次の引数を受け取ることができます。
{
"target": "custom:company_editor",
"path": "/repo/src/index.ts",
"appPath": null,
"location": { "line": 12, "column": 3 }
}カスタムハンドラーを優先エディターとして選択すると、組み込みエディターを選択した場合と同じ方法(プロジェクトごとの設定を含む)で選択内容が保存されます。
TUI オプション
サブコマンドなしで codex を実行すると、対話型ターミナル UI(TUI)が起動します。Codex では、[tui] の下に次のような TUI 固有の設定が用意されています。
tui.notifications:通知を有効/無効にする(または特定のタイプに限定する)tui.notification_method:ターミナル通知にauto、osc9、belのいずれを使用するかを選択するtui.notification_condition:通知を発生させるタイミングとしてunfocusedまたはalwaysを選択するtui.animations:ASCII アニメーションとシマーエフェクトを有効/無効にするtui.alternate_screen:代替画面の使用を制御する(ターミナルのスクロールバックを維持するにはneverに設定する)tui.show_tooltips:ウェルカム画面のオンボーディングツールチップを表示または非表示にする
tui.notification_method のデフォルトは auto です。auto モードでは、ターミナルが対応しているように見える場合、Codex は OSC 9 通知(一部のターミナルがデスクトップ通知として解釈するターミナルエスケープシーケンス)を優先し、それ以外の場合は BEL(\x07)にフォールバックします。
キーの完全な一覧については、設定リファレンスを参照してください。