プロバイダー、ポリシー、連携をより細かく制御する必要がある場合は、これらのオプションを使用します。すぐに始めるには、設定の基本を参照してください。
プロジェクトのガイダンス、再利用可能な機能、カスタムスラッシュコマンド、サブエージェントのワークフロー、連携について詳しくは、カスタマイズを参照してください。設定キーについては、設定リファレンスを参照してください。
プロファイル
プロファイルを使うと、名前を付けた設定レイヤーを保存し、
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.5"
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 に移行してから、
config.toml から対応する [profiles.profile-name] テーブルと
profile = "profile-name" セレクターを
削除してください。
CLI からの 1 回限りのオーバーライド
~/.codex/config.toml を編集する方法のほか、CLI から 1 回の実行に限って設定をオーバーライドすることもできます:
- 専用フラグがある場合は、そちらを優先してください(例:
--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/ レイヤーを無視します。これには .codex/config.toml、プロジェクトローカルのフック、プロジェクトローカルのルールが含まれます。ユーザー用とシステム用のレイヤーは別に扱われ、引き続き読み込まれます。
プロジェクト設定内の相対パス(例: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 は、アクティブな設定レイヤーと同じ場所にある hooks.json ファイル、または
config.toml ファイル内のインライン [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"
カスタムプロバイダーがスタンドアロンのウェブ検索エンドポイントに対応している場合は、 プロバイダーの設定でその機能を宣言します:
[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 です。
スタンドアロンのウェブ検索は開発中で、デフォルトでは無効です。プロバイダーの機能を true に設定するだけでは有効になりません。
プロバイダーが互換性のあるエンドポイントに対応し、
選択したモデルとランタイムもスタンドアロン検索に対応している必要があります。
設定済みの web_search モードと、管理ポリシーによる検索制限も、
引き続き適用されます。
必要に応じてリクエストヘッダーを追加します:
[model_providers.example]
http_headers = { "X-Example-Header" = "example-value" }
env_http_headers = { "X-Example-Features" = "EXAMPLE_FEATURES" }
プロバイダーが、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 認証情報チェーンを使用します。
region には、リクエストを処理するサポート対象の Bedrock リージョンを設定します。
セットアップの全手順、認証オプション、対応モデル、機能の提供状況については、 Amazon Bedrock での ChatGPT Work と Codex の利用を参照してください。
OSS モード(ローカルプロバイダー)
--oss を指定すると、Codex は Ollama や LM Studio などのローカルの「オープンソース」プロバイダーを利用できます。
1 回の実行で使用するプロバイダーを --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 size
model_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.
"""
名前付き権限プロファイル
組み込みプロファイル、カスタムプロファイルの構文、ファイルシステムとネットワークの設定モデル全体については、 権限を参照してください。
キーの完全な一覧と要件による制約については、 設定リファレンスと 管理対象の設定を参照してください。
workspace-write モードでも、環境によっては、ワークスペースのほかの部分に書き込める場合でも
.git/ と .codex/ は読み取り専用のままです。そのため、
git commit などのコマンドを実行するには、サンドボックスの外で実行するための承認が
引き続き必要になる場合があります。Codex に特定のコマンドを実行させたくない場合(たとえば、サンドボックス外での git
commit をブロックする場合)は、
ルールを使用してください。
サンドボックスを完全に無効にするには、次のように設定します(環境側ですでにプロセスを分離している場合にのみ使用してください)。
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 は対象に含めるパターンに一致する変数のみを残します。
対象に含める設定によって、すでに除外された変数が復元されることはありません。
フィルターキーは、設定レイヤー間で大文字と小文字を区別せずにマージされます。
ignore_default_excludes のデフォルトは true なので、Codex は
名前に KEY、SECRET、TOKEN を含む変数を自動的には除外しません。
明示的なフィルターを適用する前にこれらを自動除外するには、false に設定してください。
Codex は、まず自動除外、次にカスタム除外、
set による値の設定、最後に対象に含めるパターンの許可リストを適用します。
set は除外の後に実行されるため、除外された変数を復元できます。
ただし、復元された値も、対象に含めるパターンの許可リストによって除外される場合があります。
既存の設定では、従来の exclude 配列と include_only 配列も引き続きサポートされます。
どちらの配列も、同じ設定レイヤー内で
[shell_environment_policy.filters] と組み合わせないでください。
Codex はこの組み合わせを拒否します。
MCP サーバー
設定の詳細は、専用の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 | カウンター | status、success | HTTP ステータスおよび成功/失敗別の API リクエスト数。 |
codex.api_request.duration_ms | ヒストグラム | status、success | API リクエストの所要時間(ミリ秒)。 |
codex.sse_event | カウンター | kind、success | イベントの種類および成功/失敗別の SSE イベント数。 |
codex.sse_event.duration_ms | ヒストグラム | kind、success | SSE イベントの処理時間(ミリ秒)。 |
codex.websocket.request | カウンター | success | 成功/失敗別の WebSocket リクエスト数。 |
codex.websocket.request.duration_ms | ヒストグラム | success | WebSocket リクエストの所要時間(ミリ秒)。 |
codex.websocket.event | カウンター | kind、success | 種類および成功/失敗別の WebSocket メッセージ/イベント数。 |
codex.websocket.event.duration_ms | ヒストグラム | kind、success | WebSocket メッセージ/イベントの処理時間(ミリ秒)。 |
codex.tool.call | カウンター | tool、success | ツール名と成功/失敗別のツール呼び出し回数。 |
codex.tool.call.duration_ms | ヒストグラム | tool、success | ツール名と結果別のツール実行時間(ミリ秒)。 |
テレメトリに関するセキュリティとプライバシーの詳細なガイダンスは、セキュリティを参照してください。
メトリクス
デフォルトでは、Codex は使用状況と稼働状態に関する少量の匿名データを定期的に OpenAI に送信します。このデータは、Codex が正常に動作していない場合の検出や、利用されている機能と構成オプションの把握に役立ち、Codex チームが特に重要な改善に注力できるようにします。これらのメトリクスには、個人を特定できる情報(PII)は含まれません。メトリクスの収集は、OTel のログ/トレースのエクスポートとは独立しています。
マシン上の ChatGPT デスクトップアプリ、Codex CLI、IDE 拡張機能のすべてでメトリクスの収集を完全に無効にするには、構成で分析フラグを次のように設定します。
[analytics]
enabled = false
各メトリクスには、固有のフィールドに加えて、以下のデフォルトのコンテキストフィールドが含まれます。
デフォルトのコンテキストフィールド(すべてのイベント/メトリクスに適用)
auth_mode:swic|api|unknownmodel: 使用したモデルの名前app.version: Codex のバージョン
メトリクス一覧
各メトリクスには、必須フィールドに加えて、上記のデフォルトのコンテキストフィールドが含まれます。以下のメトリクス名では、接頭辞 codex. を省略しています。
ほとんどのメトリクス名は codex-rs/otel/src/metrics/names.rs に集約されていますが、このファイル以外で出力される機能固有のメトリクスもここに記載しています。
メトリクスに tool フィールドが含まれる場合、その値は使用された内部ツール(例:apply_patch または shell)を示します。実際のシェルコマンドや、codex が適用しようとしているパッチの内容は含まれません。
ランタイムとモデル通信
| メトリクス | 種類 | フィールド | 説明 |
|---|---|---|---|
api_request | カウンター | status、success | HTTP ステータスと成功/失敗別の API リクエスト数。 |
api_request.duration_ms | ヒストグラム | status、success | API リクエストの所要時間(ミリ秒)。 |
sse_event | カウンター | kind、success | イベントの種類と成功/失敗別の SSE イベント数。 |
sse_event.duration_ms | ヒストグラム | kind、success | SSE イベントの処理時間(ミリ秒)。 |
websocket.request | カウンター | success | 成功/失敗別の WebSocket リクエスト数。 |
websocket.request.duration_ms | ヒストグラム | success | WebSocket リクエストの所要時間(ミリ秒)。 |
websocket.event | カウンター | kind、success | 種類と成功/失敗別の WebSocket メッセージ/イベント数。 |
websocket.event.duration_ms | ヒストグラム | kind、success | WebSocket メッセージ/イベントの処理時間(ミリ秒)。 |
responses_api_overhead.duration_ms | ヒストグラム | WebSocket レスポンスから得られる Responses API のオーバーヘッド時間。 | |
responses_api_inference_time.duration_ms | ヒストグラム | WebSocket レスポンスから得られる Responses API の推論時間。 | |
responses_api_engine_iapi_ttft.duration_ms | ヒストグラム | Responses API エンジンの IAPI における最初のトークンまでの所要時間。 | |
responses_api_engine_service_ttft.duration_ms | ヒストグラム | Responses API エンジンサービスにおける最初のトークンまでの所要時間。 | |
responses_api_engine_iapi_tbt.duration_ms | ヒストグラム | Responses API エンジンの IAPI におけるトークン間の所要時間。 | |
responses_api_engine_service_tbt.duration_ms | ヒストグラム | Responses API エンジンサービスにおけるトークン間の所要時間。 | |
transport.fallback_to_http | カウンター | from_wire_api | WebSocket から HTTP へのフォールバック回数。 |
remote_models.fetch_update.duration_ms | ヒストグラム | リモートのモデル定義の取得にかかる時間。 | |
remote_models.load_cache.duration_ms | ヒストグラム | リモートモデルのキャッシュの読み込みにかかる時間。 | |
startup_prewarm.duration_ms | ヒストグラム | status | 結果別の起動時の事前ウォームアップ所要時間。 |
startup_prewarm.age_at_first_turn_ms | ヒストグラム | status | 最初の実際のターンで起動時の事前ウォームアップが解決された時点での経過時間。 |
cloud_requirements.fetch.duration_ms | ヒストグラム | ワークスペースで管理されるクラウド要件の取得所要時間。 | |
cloud_requirements.fetch_attempt | カウンター | 注を参照 | ワークスペースで管理されるクラウド要件の取得試行回数。 |
cloud_requirements.fetch_final | カウンター | 注を参照 | ワークスペースで管理されるクラウド要件の最終的な取得結果。 |
cloud_requirements.load | カウンター | 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 | ヒストグラム | ターンの開始から終了までの総所要時間。 | |
turn.ttft.duration_ms | ヒストグラム | ターンの最初のトークンが出力されるまでの時間。 | |
turn.ttfm.duration_ms | ヒストグラム | ターンの最初のモデル出力項目が得られるまでの時間。 | |
turn.network_proxy | カウンター | active、tmp_mem_enabled | そのターンで管理対象のネットワークプロキシが有効だったかどうか。 |
turn.memory | カウンター | read_allowed、feature_enabled、config_use_memories、has_citations | ターンごとのメモリの読み取り可否とメモリ引用の使用状況。 |
turn.tool.call | ヒストグラム | tmp_mem_enabled | ターン内のツール呼び出し回数。 |
turn.token_usage | ヒストグラム | token_type、tmp_mem_enabled | トークンの種類(total、input、cached_input、output、または reasoning_output)別の、ターンごとのトークン使用量。 |
tool.call | カウンター | tool、success | ツール名と成功・失敗別のツール呼び出し回数。 |
tool.call.duration_ms | ヒストグラム | tool、success | ツール名と結果別のツール実行時間(ミリ秒)。 |
tool.unified_exec | カウンター | tty | TTY モード別の統合 exec ツール呼び出し回数。 |
approval.requested | カウンター | tool、approved | ツールの承認リクエストの結果(approved、approved_with_amendment、approved_for_session、denied、abort)。 |
mcp.call | カウンター | 注を参照 | MCP ツールの呼び出し結果。 |
mcp.call.duration_ms | ヒストグラム | 注を参照 | MCP ツールの呼び出し所要時間。 |
mcp.tools.list.duration_ms | ヒストグラム | cache | MCP ツール一覧の取得所要時間。キャッシュのヒット・ミスの状態も含みます。 |
mcp.tools.fetch_uncached.duration_ms | ヒストグラム | キャッシュミス時の MCP ツール取得所要時間。 | |
mcp.tools.cache_write.duration_ms | ヒストグラム | Codex アプリの MCP ツールキャッシュへの書き込み所要時間。 | |
hooks.run | カウンター | hook_name、source、status | フック名、ソース、ステータス別のフック実行回数。 |
hooks.run.duration_ms | ヒストグラム | hook_name、source、status | フックの実行時間(ミリ秒)。 |
mcp.call と mcp.call.duration_ms のメトリクスには status が含まれます。通常のツール呼び出し時の出力には tool も含まれ、取得できる場合は connector_id と connector_name も含まれます。ブロックされた Codex アプリの MCP 呼び出しでは、status だけを含む mcp.call が出力されることがあります。
スレッド、タスク、機能
| メトリクス | 種類 | フィールド | 説明 |
|---|---|---|---|
feature.state | カウンター | feature、value | デフォルトと異なる機能の設定値(デフォルト以外の設定ごとに 1 行出力)。 |
status_line | カウンター | ステータス行が設定された状態でのセッション開始。 | |
model_warning | カウンター | モデルに送信された警告。 | |
thread.started | カウンター | is_git | 新しいスレッドの作成。作業ディレクトリが Git リポジトリ内にあるかどうかをタグで記録します。 |
conversation.turn.count | カウンター | スレッドごとのユーザーとアシスタントのターン数。スレッド終了時に記録します。 | |
thread.fork | カウンター | source | 既存のスレッドをフォークして作成された新しいスレッド。 |
thread.rename | カウンター | スレッド名の変更。 | |
thread.side | カウンター | source | サイド会話の作成。 |
thread.skills.enabled_total | ヒストグラム | 新しいスレッドで有効になっているスキルの数。 | |
thread.skills.kept_total | ヒストグラム | プロンプトのレンダリング後に保持された有効なスキルの数。 | |
thread.skills.truncated | ヒストグラム | スキルのレンダリングによって、有効なスキルの一覧が切り詰められたかどうか(1 または 0)。 | |
task.compact | カウンター | type | 手動と自動を含む、種類別(remote または local)のコンパクション回数。 |
task.review | カウンター | レビューが開始された回数。 | |
task.undo | カウンター | 元に戻す操作が実行された回数。 | |
task.user_shell | カウンター | ユーザーによるシェル操作の回数(TUI での ! など)。 | |
shell_snapshot | カウンター | 注記を参照 | シェルのスナップショット取得に成功したかどうか。 |
shell_snapshot.duration_ms | ヒストグラム | success | シェルのスナップショット取得にかかった時間。 |
skill.injected | カウンター | status、skill | スキルごとのスキル挿入結果。 |
plugins.startup_sync | カウンター | transport、status | 起動時に行う厳選プラグインの同期の試行回数。 |
plugins.startup_sync.final | カウンター | transport、status | 起動時に行う厳選プラグインの同期の最終結果。 |
multi_agent.spawn | カウンター | role | ロール別のエージェント起動回数。 |
multi_agent.resume | カウンター | エージェントの再開回数。 | |
multi_agent.nickname_pool_reset | カウンター | エージェントのニックネームプールのリセット回数。 |
shell_snapshot メトリクスには success が含まれ、失敗時には failure_reason も含まれます。
メモリとローカルの状態
| メトリクス | 種類 | フィールド | 説明 |
|---|---|---|---|
memory.phase1 | カウンター | status | 稼働状況別のメモリフェーズ 1 のジョブ数。 |
memory.phase1.e2e_ms | ヒストグラム | メモリフェーズ 1 全体の所要時間。 | |
memory.phase1.output | カウンター | メモリフェーズ 1 で書き込まれた出力数。 | |
memory.phase1.token_usage | ヒストグラム | token_type | メモリフェーズ 1 のトークン種別ごとの使用量。 |
memory.phase2 | カウンター | status | 稼働状況別のメモリフェーズ 2 のジョブ数。 |
memory.phase2.e2e_ms | ヒストグラム | メモリフェーズ 2 全体の所要時間。 | |
memory.phase2.input | カウンター | メモリフェーズ 2 の入力数。 | |
memory.phase2.token_usage | ヒストグラム | token_type | メモリフェーズ 2 のトークン種別ごとの使用量。 |
memories.usage | カウンター | kind、tool、success | 種別、ツール、成功・失敗別のメモリ使用状況。 |
external_agent_config.detect | カウンター | 注を参照 | 移行項目の種別ごとの外部エージェント設定の検出数。 |
external_agent_config.import | カウンター | 注を参照 | 移行項目の種別ごとの外部エージェント設定のインポート数。 |
db.backfill | カウンター | status | 状態 DB の初回バックフィルの結果(upserted、failed)。 |
db.backfill.duration_ms | ヒストグラム | status | 状態 DB の初回バックフィルの所要時間。 |
db.error | カウンター | stage | 状態 DB のオペレーション中に発生したエラー。 |
external_agent_config.detect と external_agent_config.import のメトリクスには migration_type が含まれます。スキルの移行では skills_count も含まれます。
Windows サンドボックス
| メトリクス | 種類 | フィールド | 説明 |
|---|---|---|---|
windows_sandbox.setup_success | カウンター | originator、mode | Windows サンドボックスのセットアップ成功数。 |
windows_sandbox.setup_failure | カウンター | originator、mode | Windows サンドボックスのセットアップ失敗数。 |
windows_sandbox.setup_duration_ms | ヒストグラム | result、originator、mode | Windows サンドボックスのセットアップ所要時間。 |
windows_sandbox.elevated_setup_success | カウンター | 管理者権限での Windows サンドボックスのセットアップ成功数。 | |
windows_sandbox.elevated_setup_failure | カウンター | 注を参照 | 管理者権限での Windows サンドボックスのセットアップ失敗数。 |
windows_sandbox.elevated_setup_canceled | カウンター | 注を参照 | 管理者権限での Windows サンドボックスのセットアップ試行がキャンセルされた回数。 |
windows_sandbox.elevated_setup_duration_ms | ヒストグラム | result | 管理者権限での Windows サンドボックスのセットアップ所要時間。 |
windows_sandbox.elevated_prompt_shown | カウンター | 管理者権限でのサンドボックスのセットアップを求めるプロンプトの表示回数。 | |
windows_sandbox.elevated_prompt_accept | カウンター | 管理者権限でのサンドボックスのセットアップを求めるプロンプトが受け入れられた回数。 | |
windows_sandbox.elevated_prompt_use_legacy | カウンター | 管理者権限でのセットアップを求めるプロンプトで、ユーザーが従来のサンドボックスを選択した回数。 | |
windows_sandbox.elevated_prompt_quit | カウンター | ユーザーによる権限昇格プロンプトでの終了。 | |
windows_sandbox.fallback_prompt_shown | カウンター | フォールバック用サンドボックスのプロンプトの表示。 | |
windows_sandbox.fallback_retry_elevated | カウンター | ユーザーによるフォールバックのプロンプトからの権限昇格セットアップの再試行。 | |
windows_sandbox.fallback_use_legacy | カウンター | ユーザーによるフォールバックのプロンプトでの従来のサンドボックスの選択。 | |
windows_sandbox.fallback_prompt_quit | カウンター | ユーザーによるフォールバックのプロンプトでの終了。 | |
windows_sandbox.legacy_setup_preflight_failed | カウンター | 注記を参照 | 従来の Windows サンドボックスのセットアップ事前チェックの失敗。 |
windows_sandbox.setup_elevated_sandbox_command | カウンター | 権限昇格サンドボックスのセットアップコマンドの呼び出し。 | |
windows_sandbox.createprocessasuserw_failed | カウンター | 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 など、一部のモデルやプロバイダーは未加工の推論を出力しません。その場合、この設定による表示上の変化はありません。
通知
notify を使用すると、Codex が対応するイベント(現在は agent-turn-complete のみ)を出力するたびに、外部プログラムを起動できます。デスクトップのトースト通知、チャットの Webhook、CI の更新通知など、組み込みの TUI 通知では対応できない別経路の通知に便利です。
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 引数を受け取ります。主なフィールドは次のとおりです。
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は、TUI 通知をターミナルにフォーカスがないときだけ出すか(unfocused)、 常に出すか(always)を制御します。
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 デスクトップアプリがデフォルトでは対応していない
エディタや社内ランチャーでファイルを開けます。各エントリは、
アプリの 次のアプリで開く メニューにエディタの選択肢を追加します。
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 モードでは、ターミナルが OSC 9 通知(一部のターミナルがデスクトップ通知として解釈するターミナルエスケープシーケンス)に対応していると判断された場合、Codex はこれを優先して使用します。それ以外の場合は、BEL(\x07)にフォールバックします。
キーの全一覧は、構成リファレンスを参照してください。