OpenAI Codex CLIの完全なコマンドリファレンスと設定ガイドです。
はじめに
OpenAI Codex CLIは、ターミナルから直接AIアシスタントを利用できる強力なコマンドラインツールです。コード生成、デバッグ、リファクタリングなど、様々なソフトウェア開発タスクをAIの支援を受けながら実行できます。
本記事では、Codex CLIの全機能を網羅的に解説します:
-
コマンドライン操作: インタラクティブモードと非インタラクティブモード(
codex exec)の両方に対応し、スクリプトやCI/CDパイプラインへの統合も可能です -
柔軟な設定システム:
~/.codex/config.tomlによる設定ファイル、プロファイル機能による設定の切り替え、CLIフラグによる一時的なオーバーライドをサポートします -
セキュリティ機能: サンドボックスモード(
read-only、workspace-write、danger-full-access)と承認ポリシーにより、安全な実行環境を提供します - 拡張性: Model Context Protocol (MCP) サーバーとの連携、カスタムモデルプロバイダーの設定、OpenTelemetryによる監視など、高度なカスタマイズが可能です
- マルチプラットフォーム: macOS(Seatbelt)とLinux(Landlock)でのサンドボックス実行、VSCode拡張機能との統合をサポートします
この記事は、OpenAI公式ドキュメントの内容を日本語で完全に網羅しています。初めてCodex CLIを使用する方から、高度な設定を行いたい方まで、幅広くご活用いただけます。
目次
- インストール
- クイックスタート
- 主要機能
- グローバルフラグ
- コマンド一覧
- コマンド詳細
- ローカル設定 (config.toml)
- プロファイル
- 機能フラグ
- 高度な設定
- 設定オプション完全リファレンス
- 安全性に関する推奨事項
インストール
システム要件
| プラットフォーム | サポート状況 |
|---|---|
| macOS | 公式サポート |
| Linux | 公式サポート |
| Windows | 実験的サポート(WSL推奨) |
インストール方法
npm を使用
npm i -g @openai/codex
Homebrew を使用
brew install codex
最新版へのアップデート
npm i -g @openai/codex@latest
認証要件
Codex CLIを使用するには、以下のいずれかの認証方法が必要です:
- ChatGPTアカウント(推奨): Plus、Pro、Business、Edu、Enterpriseプランのいずれか
- APIキー: より細かい制御が必要な場合
クイックスタート
1. インタラクティブモードの起動
codex
初回起動時に認証プロンプトが表示されます。
2. プロンプト付きで起動
codex "explain this codebase"
3. 特定のディレクトリで作業
codex --cd /path/to/project
4. 終了
Ctrl+C または /exit コマンドで終了します。
主要機能
インタラクティブモード
codex コマンドでフルスクリーンのターミナルUIを起動します。
できること:
- プロンプト、コードスニペット、スクリーンショットを直接コンポーザーに送信
- Codexが変更を加える前に計画を確認し、インラインで承認/拒否
-
Ctrl+Cまたは/exitで終了
codex
セッション管理
ローカルにトランスクリプトが保存されるため、以前のセッションを継続できます。
# セッションピッカーを表示
codex resume
# 最新のセッションを自動的に再開
codex resume --last
# 特定のセッションを再開
codex resume <SESSION_ID>
非インタラクティブでの再開:
codex exec resume --last "Fix the race conditions you found"
codex exec resume 7f9f9a2e-1b3c-4c7a-9b0e-.... "Implement the plan"
作業ディレクトリのオーバーライド:
codex resume --cd /different/path
codex resume --add-dir ../additional/path
モデル選択
デフォルトモデルはプラットフォームによって異なります:
| プラットフォーム | デフォルトモデル |
|---|---|
| macOS / Linux | gpt-5-codex |
| Windows | gpt-5 |
セッション中にモデルを切り替え:
/model
起動時にモデルを指定:
codex --model gpt-5-codex
画像入力
PNG および JPEG 形式のスクリーンショットやデザイン仕様を受け付けます。
# 単一の画像
codex -i screenshot.png "Explain this error"
# 複数の画像
codex --image img1.png,img2.jpg "Summarize these diagrams"
コードレビュー
/review コマンドで専用のレビューモードを起動します。4つのプリセットオプションがあります:
| オプション | 説明 |
|---|---|
| ベースブランチとの比較 | ローカルブランチを選択し、upstreamとのマージベースを見つけて差分を表示 |
| コミットされていない変更のレビュー | staged、unstaged、untracked コンテンツを検査 |
| コミットのレビュー | 最近のコミットをリストし、選択したSHAの変更セットを読み取り |
| カスタムレビュー指示 | 「アクセシビリティの退行に焦点を当てて」などのカスタム指示を受け付け |
Web検索
Web検索を有効にするには、~/.codex/config.toml で設定するか、--search フラグを使用します。
設定ファイルでの有効化:
[features]
web_search_request = true
[sandbox_workspace_write]
network_access = true
CLIフラグでの有効化:
codex --search "latest React 19 features"
承認モード
/approvals コマンドで3つのセキュリティレベルを切り替えられます:
| モード | 説明 |
|---|---|
| Auto(デフォルト) | ファイルの読み取り、編集、作業ディレクトリ内でのコマンド実行が可能。ネットワークや外部スコープへのアクセスには承認を求める |
| Read Only | 閲覧のみ。変更やコマンド実行には承認が必要 |
| Full Access | ネットワークを含むマシンへの無制限アクセス。慎重に使用すること |
すべてのアクションはトランスクリプトに記録され、レビューやロールバックが可能です。
スクリプト自動化
exec サブコマンドで非インタラクティブな自動化が可能です。
codex exec "fix the CI failure"
シェルスクリプトと統合してカスタムワークフロー(変更ログの更新、issueトリアージ、編集チェックなど)を実現できます。
Codex Cloud連携
ターミナルからCodex Cloudタスクと連携できます。
# Codex Cloudを起動
codex cloud
# 環境IDを指定してタスクを実行
codex cloud exec --env ENV_ID "Summarize open bugs"
複数のソリューションをリクエスト(1〜4回の試行):
codex cloud exec --env ENV_ID --attempts 3 "Summarize open bugs"
環境IDはCLIピッカー(Ctrl+O)またはダッシュボードから取得できます。失敗時は非ゼロで終了するため、CI統合も安全です。
スラッシュコマンド
ビルトインコマンド:
| コマンド | 説明 |
|---|---|
/review |
コードレビューモードを起動 |
/plan |
計画モードを起動 |
/model |
モデルを切り替え |
/approvals |
承認モードを切り替え |
/exit |
セッションを終了 |
チーム固有のタスク用にカスタムコマンドを作成することもできます。
MCP連携
Model Context Protocol (MCP) サーバーを設定して、追加のツールを利用できます。
設定ファイルでの設定:
[mcp_servers.context7]
command = "npx"
args = ["-y", "@upstash/context7-mcp"]
MCPサーバーの確認:
codex mcp
Codexはサーバーを自動的に起動し、ビルトインツールと一緒にそれらのツールを公開します。
Tips & ショートカット
| 操作 | 説明 |
|---|---|
@ を入力 |
ファジーファイル検索。Tab/Enterでパスをメッセージに挿入 |
Esc を2回押す |
前のユーザーメッセージを編集(コンポーザーが空の場合)。Escを押し続けると履歴を遡り、Enterでフォーク |
--cd フラグ |
cd を実行せずに任意のディレクトリから起動: codex --cd <path>
|
--add-dir フラグ |
追加の書き込み可能ルートを公開: codex --cd apps/frontend --add-dir ../backend --add-dir ../shared
|
グローバルフラグ
すべてのコマンドで使用可能なフラグです。
| フラグ | 型 | 説明 |
|---|---|---|
PROMPT |
string | セッションを開始するオプションのテキスト指示 |
--image, -i |
path[,path...] | 初期プロンプトに1つ以上の画像ファイルを添付 |
--model, -m |
string | 設定されたモデルをオーバーライド(例: gpt-5-codex) |
--oss |
boolean | ローカルのオープンソースモデルプロバイダーを使用 |
--profile, -p |
string |
~/.codex/config.toml から読み込む設定プロファイル名 |
--sandbox, -s |
read-only | workspace-write | danger-full-access
|
サンドボックスポリシーを選択 |
--ask-for-approval, -a |
untrusted | on-failure | on-request | never
|
Codexが人間の承認を求めるタイミングを制御 |
--full-auto |
boolean | 無人ローカル作業のショートカット |
--dangerously-bypass-approvals-and-sandbox, --yolo |
boolean | 承認やサンドボックスなしですべてのコマンドを実行 |
--cd, -C |
path | エージェントの作業ディレクトリを設定 |
--search |
boolean | Web検索を有効化 |
--add-dir |
path | 追加のディレクトリに書き込みアクセスを付与 |
--enable |
feature | 機能フラグを強制的に有効化(繰り返し可能) |
--disable |
feature | 機能フラグを強制的に無効化(繰り返し可能) |
--config, -c |
key=value | 設定値をオーバーライド |
コマンド一覧
| コマンド | ステータス | 目的 |
|---|---|---|
codex |
stable | ターミナルUIを起動 |
codex exec / codex e
|
stable | 非インタラクティブでCodexを実行 |
codex login |
stable | OAuthまたはAPIキーで認証 |
codex logout |
stable | 保存された認証情報を削除 |
codex resume |
stable | 以前のインタラクティブセッションを継続 |
codex apply / codex a
|
stable | Codex Cloudタスクで生成された最新のdiffを適用 |
codex sandbox |
platform-specific | Codex提供のサンドボックス内で任意のコマンドを実行 |
codex completion |
stable | シェル補完スクリプトを生成 |
codex mcp |
experimental | Model Context Protocolサーバーを管理 |
codex mcp-server |
experimental | Codex自体をMCPサーバーとして実行 |
codex app-server |
experimental | Codexアプリサーバーを起動 |
codex cloud |
experimental | Codex Cloudタスクを閲覧または実行 |
コマンド詳細
codex (インタラクティブモード)
ターミナルUIを起動し、プロンプトと画像を受け付けます。
codex [PROMPT] [OPTIONS]
すべてのグローバルフラグが使用可能です。
codex exec
非インタラクティブでCodexを実行します。スクリプトやCI/CDパイプラインに最適です。
codex exec [PROMPT] [OPTIONS]
codex e [PROMPT] [OPTIONS]
オプション
| フラグ | 型 | 説明 |
|---|---|---|
PROMPT |
string | - | タスクの初期指示。- を使用してstdinからパイプ可能 |
--image, -i |
path[,path...] | 最初のメッセージに画像を添付(繰り返し可能) |
--model, -m |
string | この実行で使用するモデルをオーバーライド |
--oss |
boolean | ローカルのオープンソースプロバイダーを使用 |
--sandbox, -s |
read-only | workspace-write | danger-full-access
|
モデル生成コマンドのサンドボックスポリシー |
--profile, -p |
string | 設定プロファイルを選択 |
--full-auto |
boolean | 低摩擦自動化プリセットを適用 |
--dangerously-bypass-approvals-and-sandbox, --yolo |
boolean | 承認プロンプトとサンドボックスをバイパス |
--cd, -C |
path | タスク実行前にワークスペースルートを設定 |
--skip-git-repo-check |
boolean | Gitリポジトリ外での実行を許可 |
--output-schema |
path | 期待される最終レスポンス形状を記述するJSONスキーマファイル |
--color |
always | never | auto
|
stdoutのANSIカラーを制御 |
--json, --experimental-json |
boolean | 改行区切りのJSONイベントを出力 |
--output-last-message, -o |
path | アシスタントの最終メッセージをファイルに書き込み |
-c, --config |
key=value | インライン設定オーバーライド(繰り返し可能) |
codex exec resume
セッションを再開します。
codex exec resume [SESSION_ID] [OPTIONS]
| 引数/フラグ | 型 | 説明 |
|---|---|---|
SESSION_ID |
uuid | 指定されたセッションを再開 |
--last |
boolean | ピッカーをスキップして最新の会話を自動的に再開 |
PROMPT |
string | - | オプションのフォローアップ指示 |
codex login / logout
codex login
OAuthまたはAPIキーを使用して認証します。
codex login [OPTIONS]
| フラグ | 型 | 説明 |
|---|---|---|
--with-api-key |
boolean | stdinからAPIキーを読み取り |
codex login status
認証状態を確認します。
codex login status
認証情報が存在する場合、終了コード0で終了します。
codex logout
保存された認証情報を削除します。
codex logout
codex resume
以前のインタラクティブセッションを継続します。
codex resume [SESSION_ID] [OPTIONS]
| 引数/フラグ | 型 | 説明 |
|---|---|---|
SESSION_ID |
uuid | 指定されたセッションを再開。--last と併用で省略可能 |
--last |
boolean | ピッカーをスキップして最新の会話を自動的に再開 |
PROMPT |
string | - | 再開後すぐに送信されるオプションのフォローアップ指示 |
すべてのグローバルフラグ(モデルやサンドボックスオーバーライドを含む)を継承します。
codex apply
Codex Cloudタスクで生成されたdiffを適用します。
codex apply [TASK_ID]
codex a [TASK_ID]
| 引数 | 型 | 説明 |
|---|---|---|
TASK_ID |
string | diffを適用するCodex CloudタスクのID |
codex sandbox
OS レベルの制限付きでコマンドを実行します。
macOS (Seatbelt)
codex sandbox seatbelt [OPTIONS] COMMAND...
| フラグ | 型 | 説明 |
|---|---|---|
--full-auto |
boolean | 承認なしで現在のワークスペースと /tmp への書き込みアクセスを付与 |
-c, --config |
key=value | サンドボックス実行に設定オーバーライドを渡す(繰り返し可能) |
COMMAND... |
var-args | macOS Seatbelt下で実行するシェルコマンド |
Linux (Landlock)
codex sandbox landlock [OPTIONS] COMMAND...
| フラグ | 型 | 説明 |
|---|---|---|
--full-auto |
boolean | Landlockサンドボックス内で現在のワークスペースと /tmp への書き込みアクセスを付与 |
-c, --config |
key=value | サンドボックス起動前に適用される設定オーバーライド(繰り返し可能) |
COMMAND... |
var-args | Landlock + seccomp下で実行するコマンド |
codex completion
シェル補完スクリプトを生成します。
codex completion [SHELL]
| 引数 | 型 | 説明 |
|---|---|---|
SHELL |
bash | zsh | fish | power-shell | elvish
|
補完を生成するシェル |
補完スクリプトのインストール
Bash:
codex completion bash
Zsh:
codex completion zsh
~/.zshrc に追加:
eval "$(codex completion zsh)"
注意:
compdefエラーが発生する場合は、evalの前に以下を追加してください:autoload -Uz compinit && compinit
Fish:
codex completion fish
codex mcp
Model Context Protocol (MCP) サーバーを管理します。
サブコマンド一覧
| サブコマンド | 構文 | 説明 |
|---|---|---|
list |
codex mcp list [--json] |
設定されたMCPサーバーを一覧表示 |
get |
codex mcp get <name> [--json] |
特定のサーバー設定を表示 |
add |
codex mcp add <name> -- <command...> または --url <value>
|
stdioランチャーまたはHTTP URLを使用してサーバーを登録 |
remove |
codex mcp remove <name> |
保存されたMCPサーバー定義を削除 |
login |
codex mcp login <name> [--scopes scope1,scope2] |
streamable HTTPサーバーのOAuthログインを開始 |
logout |
codex mcp logout <name> |
保存されたOAuth認証情報を削除 |
codex mcp add オプション
| フラグ | 型 | 説明 |
|---|---|---|
COMMAND... |
stdio transport | MCPサーバーを起動する実行ファイルと引数 |
--env KEY=VALUE |
repeatable | stdioサーバー用の環境変数割り当て |
--url |
https://… | streamable HTTPサーバーを登録 |
--bearer-token-env-var |
ENV_VAR | ベアラートークンとして送信される値を持つ環境変数 |
注意: OAuth操作(login, logout)にはRMCPクライアント機能が必要です。
codex cloud
Codex Cloudタスクを閲覧または実行します。
codex cloud [QUERY] [OPTIONS]
| 引数/フラグ | 型 | 説明 |
|---|---|---|
QUERY |
string | タスクプロンプト。省略した場合、Codexは詳細をインタラクティブに求めます |
--env |
ENV_ID | ターゲットのCodex Cloud環境ID(必須) |
--attempts |
1-4 | アシスタントの試行回数(best-of-N) |
ローカル設定 (config.toml)
設定ファイルの場所
設定ファイルは ~/.codex/config.toml に配置され、CLIとIDE拡張機能の両方で共有されます。
基本設定例
デフォルトモデル
model = "gpt-5"
CLI: codex --model gpt-5
モデルプロバイダー
model_provider = "ollama"
CLI: codex --config model_provider="ollama"
承認プロンプト
approval_policy = "on-request"
CLI: codex --ask-for-approval on-request
サンドボックスレベル
sandbox_mode = "workspace-write"
CLI: codex --sandbox workspace-write
推論深度
model_reasoning_effort = "high"
CLI: codex --config model_reasoning_effort="high"
コマンド環境
[shell_environment_policy]
include_only = ["PATH", "HOME"]
CLI: codex --config shell_environment_policy.include_only='["PATH","HOME"]'
プロファイル
設定セットをバンドルして、手動編集なしで切り替えられます。
model = "gpt-5-codex"
approval_policy = "on-request"
[profiles.deep-review]
model = "gpt-5-pro"
model_reasoning_effort = "high"
approval_policy = "never"
[profiles.lightweight]
model = "gpt-4.1"
approval_policy = "untrusted"
使用方法:
codex --profile deep-review
解決順序
- 明示的なCLIフラグ(最優先)
- プロファイル値
- ルートレベルの設定
- ビルトインのデフォルト
機能フラグ
[features] テーブルで実験的な機能を設定します。
[features]
streamable_shell = true
web_search_request = true
view_image_tool = true
サポートされる機能フラグ
| キー | デフォルト | ステージ | 説明 |
|---|---|---|---|
unified_exec |
false | Experimental | PTYバックドexecツール |
streamable_shell |
false | Experimental | ストリーマブルexec-command/write-stdinペア |
rmcp_client |
false | Experimental | HTTP MCPサーバーのOAuthサポート |
apply_patch_freeform |
false | Beta | フリーフォームパッチ適用ツール |
view_image_tool |
true | Stable | ローカル画像添付機能 |
web_search_request |
false | Stable | モデル発行のWeb検索 |
experimental_sandbox_command_assessment |
false | Experimental | モデルベースのサンドボックスリスク評価 |
ghost_commit |
false | Experimental | ターンごとのゴーストコミット |
enable_experimental_windows_sandbox |
false | Experimental | Windows制限トークンサンドボックス |
機能の有効化
設定ファイル:
[features]
feature_name = true
CLI(一時的):
codex --enable feature_name
複数の機能:
codex --enable feature_a --enable feature_b
高度な設定
カスタムモデルプロバイダー
model = "gpt-4o"
model_provider = "openai-chat-completions"
[model_providers.openai-chat-completions]
name = "OpenAI using Chat Completions"
base_url = "https://api.openai.com/v1"
env_key = "OPENAI_API_KEY"
wire_api = "chat"
query_params = {}
[model_providers.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.example]
http_headers = { "X-Example-Header" = "example-value" }
env_http_headers = { "X-Example-Features" = "EXAMPLE_FEATURES" }
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"
プロバイダーごとのチューニング
[model_providers.openai]
request_max_retries = 4
stream_max_retries = 10
stream_idle_timeout_ms = 300000
モデル推論、冗長性、制限
model_reasoning_summary = "none"
model_verbosity = "low"
model_supports_reasoning_summaries = true
model_context_window = 128000
model_max_output_tokens = 4096
承認ポリシーとサンドボックスモード
approval_policy = "untrusted"
sandbox_mode = "workspace-write"
[sandbox_workspace_write]
exclude_tmpdir_env_var = false
exclude_slash_tmp = false
writable_roots = ["/Users/YOU/.pyenv/shims"]
network_access = false
サンドボックスを完全に無効化:
sandbox_mode = "danger-full-access"
シェル環境テンプレート
[shell_environment_policy]
inherit = "none"
set = { PATH = "/usr/bin", MY_FLAG = "1" }
ignore_default_excludes = false
exclude = ["AWS_*", "AZURE_*"]
include_only = ["PATH", "HOME"]
パターンは大文字小文字を区別しないglob(*, ?, [A-Z])を使用します。デフォルトの除外はincludes/excludesの前にKEY/SECRET/TOKENをフィルタリングします。
MCPサーバー
最小限のSTDIO例:
[mcp_servers.context7]
command = "npx"
args = ["-y", "@upstash/context7-mcp"]
OpenTelemetry設定
[otel]
environment = "staging"
exporter = "none"
log_user_prompt = false
OTLP HTTPエクスポーター:
[otel]
exporter = { otlp-http = {
endpoint = "https://otel.example.com/v1/logs",
protocol = "binary",
headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" }
}}
OTLP gRPCエクスポーター:
[otel]
exporter = { otlp-grpc = {
endpoint = "https://otel.example.com:4317",
headers = { "x-otlp-meta" = "abc123" }
}}
通知
notify = ["python3", "/path/to/notify.py"]
Python通知ハンドラの例:
#!/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())
設定オプション完全リファレンス
基本設定
| キー | 型/値 | 詳細 |
|---|---|---|
model |
string | モデル識別子(例: gpt-5-codex) |
model_provider |
string |
model_providers からのプロバイダーID(デフォルト: openai) |
model_context_window |
number | 利用可能なコンテキストウィンドウトークン数 |
model_max_output_tokens |
number | 最大リクエスト補完トークン数 |
approval_policy |
untrusted | on-failure | on-request | never
|
Codexが承認を求めるタイミング |
sandbox_mode |
read-only | workspace-write | danger-full-access
|
ファイルシステム/ネットワークアクセスポリシー |
サンドボックス設定
| キー | 型/値 | 詳細 |
|---|---|---|
sandbox_workspace_write.writable_roots |
array<string> | workspace-writeモードでの追加書き込み可能パス |
sandbox_workspace_write.network_access |
boolean | サンドボックスでのアウトバウンドネットワークを有効化 |
sandbox_workspace_write.exclude_tmpdir_env_var |
boolean | 書き込み可能ルートから $TMPDIR を除外 |
sandbox_workspace_write.exclude_slash_tmp |
boolean | 書き込み可能ルートから /tmp を除外 |
通知とインストラクション
| キー | 型/値 | 詳細 |
|---|---|---|
notify |
array<string> | JSON通知ペイロードを受け取るコマンド |
instructions |
string | 予約済み; experimental_instructions_file または AGENTS.md を推奨 |
MCPサーバー設定
| キー | 型/値 | 詳細 |
|---|---|---|
mcp_servers.<id>.command |
string | MCP stdioサーバーランチャーコマンド |
mcp_servers.<id>.args |
array<string> | MCPサーバーコマンドへの引数 |
mcp_servers.<id>.env |
map<string,string> | MCPサーバー用の環境変数 |
mcp_servers.<id>.env_vars |
array<string> | 追加のホワイトリスト環境変数 |
mcp_servers.<id>.cwd |
string | MCPプロセスの作業ディレクトリ |
mcp_servers.<id>.url |
string | MCPサーバーのHTTPエンドポイント |
mcp_servers.<id>.bearer_token_env_var |
string | ベアラートークンをソースとする環境変数 |
mcp_servers.<id>.http_headers |
map<string,string> | MCPリクエスト用の静的HTTPヘッダー |
mcp_servers.<id>.env_http_headers |
map<string,string> | 環境ソースのHTTPヘッダー |
mcp_servers.<id>.enabled |
boolean | 削除せずにMCPサーバーを切り替え |
mcp_servers.<id>.startup_timeout_sec |
number | MCPサーバー起動タイムアウトオーバーライド(デフォルト: 10秒) |
mcp_servers.<id>.tool_timeout_sec |
number | ツールごとのタイムアウトオーバーライド(デフォルト: 60秒) |
mcp_servers.<id>.enabled_tools |
array<string> | MCPサーバーからのツール許可リスト |
mcp_servers.<id>.disabled_tools |
array<string> | ツール拒否リスト(許可リスト後に適用) |
機能フラグ
| キー | 型/値 | 詳細 |
|---|---|---|
features.unified_exec |
boolean | PTYバックドexecツール(experimental) |
features.streamable_shell |
boolean | ストリーマブルシェルペア(experimental) |
features.rmcp_client |
boolean | OAuthを持つRust MCPクライアント(experimental) |
features.apply_patch_freeform |
boolean | フリーフォームパッチツール(beta) |
features.view_image_tool |
boolean | ローカル画像表示(stable; デフォルト: true) |
features.web_search_request |
boolean | モデルWeb検索(stable) |
features.experimental_sandbox_command_assessment |
boolean | モデルベースリスク評価(experimental) |
features.ghost_commit |
boolean | ターンごとゴーストコミット(experimental) |
features.enable_experimental_windows_sandbox |
boolean | Windows制限トークンサンドボックス(experimental) |
モデルプロバイダー設定
| キー | 型/値 | 詳細 |
|---|---|---|
model_providers.<id>.name |
string | プロバイダー表示名 |
model_providers.<id>.base_url |
string | APIベースURL |
model_providers.<id>.env_key |
string | APIキー環境変数 |
model_providers.<id>.wire_api |
chat | responses
|
プロトコルタイプ(デフォルト: chat) |
model_providers.<id>.query_params |
map<string,string> | 追加クエリパラメータ |
model_providers.<id>.http_headers |
map<string,string> | 静的リクエストヘッダー |
model_providers.<id>.env_http_headers |
map<string,string> | 環境ソースヘッダー |
model_providers.<id>.request_max_retries |
number | HTTPリトライ回数(デフォルト: 4) |
model_providers.<id>.stream_max_retries |
number | SSEリトライ回数(デフォルト: 5) |
model_providers.<id>.stream_idle_timeout_ms |
number | ストリームアイドルタイムアウト(ms)(デフォルト: 300000) |
モデル推論設定
| キー | 型/値 | 詳細 |
|---|---|---|
model_reasoning_effort |
minimal | low | medium | high
|
サポートされるモデルの推論努力 |
model_reasoning_summary |
auto | concise | detailed | none
|
推論サマリー詳細レベル |
model_verbosity |
low | medium | high
|
レスポンス冗長性(Responses APIのみ; デフォルト: medium) |
model_supports_reasoning_summaries |
boolean | 未知のモデルに推論メタデータを強制 |
model_reasoning_summary_format |
none | experimental
|
推論サマリー形式オーバーライド |
シェル環境ポリシー
| キー | 型/値 | 詳細 |
|---|---|---|
shell_environment_policy.inherit |
all | core | none
|
ベースライン環境継承 |
shell_environment_policy.ignore_default_excludes |
boolean | KEY/SECRET/TOKENフィルタリングを保持 |
shell_environment_policy.exclude |
array<string> | 変数削除globパターン |
shell_environment_policy.include_only |
array<string> | 変数ホワイトリストパターン |
shell_environment_policy.set |
map<string,string> | 明示的な環境オーバーライド |
その他の設定
| キー | 型/値 | 詳細 |
|---|---|---|
project_doc_max_bytes |
number |
AGENTS.md からの最大バイト数 |
project_doc_fallback_filenames |
array<string> | 代替プロジェクトドキュメントファイル名 |
profile |
string | 起動時のデフォルトプロファイル |
profiles.<name>.* |
various | プロファイルスコープの設定オーバーライド |
history.persistence |
save-all | none
|
セッショントランスクリプト保存 |
history.max_bytes |
number | 将来の使用のために予約 |
file_opener |
vscode | vscode-insiders | windsurf | cursor | none
|
引用URIスキーム(デフォルト: vscode) |
OpenTelemetry設定
| キー | 型/値 | 詳細 |
|---|---|---|
otel.environment |
string | OpenTelemetry環境タグ(デフォルト: dev) |
otel.exporter |
none | otlp-http | otlp-grpc
|
OpenTelemetryエクスポーター選択 |
otel.log_user_prompt |
boolean | 生のユーザープロンプトをエクスポート |
TUI設定
| キー | 型/値 | 詳細 |
|---|---|---|
tui |
table | TUI固有オプション |
tui.notifications |
boolean | array<string>
|
デスクトップ通知(オプションでイベントフィルタ) |
実験的・非推奨設定
| キー | 型/値 | 詳細 |
|---|---|---|
hide_agent_reasoning |
boolean | 推論出力を抑制 |
show_raw_agent_reasoning |
boolean | 生の推論コンテンツを表示 |
chatgpt_base_url |
string | ChatGPTログインフローベースURLオーバーライド |
experimental_instructions_file |
string (path) | 実験的インストラクションファイル置換 |
experimental_use_rmcp_client |
boolean | 非推奨; [features].rmcp_client を使用 |
experimental_use_exec_command_tool |
boolean | 非推奨; [features].unified_exec を使用 |
projects.<path>.trust_level |
string | プロジェクトを信頼済みとしてマーク(値: "trusted") |
tools.web_search |
boolean | 非推奨; [features].web_search_request を使用 |
tools.view_image |
boolean | 非推奨; [features].view_image_tool を使用 |
forced_login_method |
chatgpt | api
|
認証方法を制限 |
forced_chatgpt_workspace_id |
string (uuid) | ChatGPTログイン用ワークスペースID |
安全性に関する推奨事項
-
--full-autoの使用: 無人ローカル作業には--full-autoを設定しますが、専用のサンドボックスVM内でない限り--dangerously-bypass-approvals-and-sandboxと組み合わせないでください。 -
ディレクトリアクセス: Codexに追加のディレクトリへの書き込みアクセスを付与する必要がある場合は、
--sandbox danger-full-accessを強制するのではなく、--add-dirを使用してください。 -
CI/CDでの使用: CIでマシンリーダブルな進捗をキャプチャするには、
--jsonと--output-last-messageを組み合わせてください。 -
MCP OAuthログイン:
codex mcp loginにはRMCPクライアント機能フラグが必要です。
IDE拡張機能のカスタマイズ
config.toml 以外に、IDE拡張機能設定は右上隅のギアアイコンからアクセスできます:
- Codex Settings > Open config.toml をクリックして設定ファイルにアクセス
- IDE settings をクリックして拡張機能固有のオプションを設定
- Keyboard shortcuts をクリックしてカスタムトリガーやコンテキスト追加を定義
関連リソース
このドキュメントは以下のOpenAI公式ドキュメントに基づいています: