Command line options
概要
Codex CLI のコマンドとグローバルフラグの索引。CLI は既定値の多くを ~/.codex/config.toml から継承し、コマンドラインで渡した -c key=value の上書きがその呼び出しで優先する。
仕様
グローバルフラグ
基底の codex コマンドに適用される。多くはサブコマンドにも伝播するが例外がある(codex exec --oss ... のようにサブコマンド側のヘルプに従う)。
| フラグ | 型 | 既定 | 説明 |
|---|---|---|---|
PROMPT | string | — | セッションを開始する任意のテキスト。省略すると TUI を未入力で起動する |
--image, -i | path[,path...] | — | 最初のプロンプトに画像を添付する。カンマ区切りかフラグの繰り返し |
--model, -m | string | — | 設定のモデルを上書きする |
--oss | boolean | false | ローカルのオープンソースモデルプロバイダを使う。--local-provider、設定済みの oss_provider の順に見て、無ければ LM Studio と Ollama のどちらかを尋ねる |
--local-provider | lmstudio | ollama | — | --oss で使うローカルプロバイダ。この実行に限り oss_provider を上書きする |
--profile, -p | string | — | $CODEX_HOME/profile-name.config.toml をベースの user config に重ねる |
--sandbox, -s | read-only|workspace-write|danger-full-access | — | モデル生成の shell コマンドに対する sandbox ポリシー |
--ask-for-approval, -a | untrusted|on-request|never | — | コマンド実行前に人間の承認で止まるタイミング |
--dangerously-bypass-approvals-and-sandbox(--yolo) | boolean | false | 承認も sandbox も無しで全コマンドを実行する。外部で堅牢化された環境の中でのみ使う |
--dangerously-bypass-hook-trust | boolean | false | この呼び出しに限り、永続的な hook trust なしに有効な hook を実行する。hook のソースを外部で検証済みの自動化のみを想定 |
--cd, -C | path | — | エージェントがリクエスト処理を始める前の作業ディレクトリ |
--search | boolean | false | ライブ web search を有効にする(既定の "cached" の代わりに web_search = "live") |
--add-dir | path | — | メインのワークスペースに加えて書き込みを許すディレクトリ。繰り返し可 |
--no-alt-screen | boolean | false | TUI の alternate screen を無効にする(この実行に限り tui.alternate_screen を上書き) |
--remote | ws://host:port | wss://host:port | unix:// | unix://PATH | — | リモートの app-server エンドポイントに接続する。対応するのは codex、codex resume、codex fork、codex archive、codex delete、codex unarchive のみ。他のサブコマンドは remote モードを拒否する |
--remote-auth-token-env | ENV_VAR | — | --remote 接続時に送るベアラトークンを読む環境変数。--remote が必須で、トークンは wss:// URL かローカル限定の ws:// URL にのみ送られる |
--strict-config | boolean | false | この Codex バージョンが認識しないフィールドが config.toml にあるときエラーにする。対応するのは codex、exec、review、resume、fork、app-server、mcp-server、exec-server などのランタイムコマンド |
--enable | feature | — | フィーチャーフラグを強制有効化(-c features.<name>=true に変換)。繰り返し可 |
--disable | feature | — | フィーチャーフラグを強制無効化(-c features.<name>=false に変換)。繰り返し可 |
--config, -c | key=value | — | 設定値を上書きする。値は可能なら TOML として解釈され、そうでなければリテラル文字列 |
コマンド一覧と成熟度
Maturity ラベル(Experimental / Beta / Stable)は Feature Maturity の定義に従う。
| コマンド | 成熟度 | 説明 |
|---|---|---|
codex | stable | ターミナル UI を起動する |
codex app-server | experimental | ローカル開発・デバッグ用の app server を stdio / WebSocket / Unix socket で起動する |
codex remote-control | experimental | ローカル app-server の remote control の実行・管理、短命なペアリングコードの発行 |
codex app | stable | macOS / Windows で ChatGPT desktop app を起動する |
codex debug app-server send-message-v2 | experimental | 組み込みのテストクライアントで V2 メッセージを 1 通送って app-server をデバッグする |
codex debug models | experimental | Codex が見ている生のモデルカタログを出力する |
codex debug prompt-input | experimental | モデルから見えるプロンプト入力リストを JSON で描画する |
codex apply(codex a) | stable | Codex cloud chat が生成した最新の diff をローカルの作業ツリーへ適用する |
codex review | stable | 未コミット変更・base ブランチ diff・コミット・カスタム指示の非対話レビュー |
codex archive / codex unarchive | stable | 保存済みの対話セッションをアーカイブ/復元する |
codex delete | stable | 保存済みの対話セッションを完全に削除する |
codex cloud(codex cloud-tasks) | experimental | TUI を開かずに cloud chat を閲覧・実行する |
codex completion | stable | Bash / Zsh / Fish / PowerShell の補完スクリプトを生成する |
codex doctor | stable | インストール・設定・認証・ランタイム・Git・ターミナル・app-server・スレッド在庫の診断レポート |
codex features | stable | フィーチャーフラグの一覧と、config.toml への永続的な有効・無効化 |
codex exec(codex e) | stable | 非対話実行。stdout または JSONL に出力し、過去セッションの resume もできる |
codex execpolicy | experimental | execpolicy のルールファイルを評価する |
codex login | stable | ChatGPT OAuth、device auth、API キー、stdin 経由のアクセストークンで認証する |
codex logout | stable | 保存済みの認証情報を消す |
codex mcp | stable | MCP サーバーの管理(list / add / remove / authenticate) |
codex plugin | stable | 設定済みマーケットプレイスから plugin をインストール・一覧・削除する |
codex plugin marketplace | stable | Git またはローカルソースの plugin マーケットプレイスを追加・一覧・アップグレード・削除する |
codex mcp-server | stable | Codex 自身を stdio 上の MCP サーバーとして動かす |
codex resume | stable | 対話セッションを ID で継続、または直近のチャットを再開する |
codex fork | stable | 過去の対話セッションを新しいチャットに fork する(元のトランスクリプトは残る) |
codex sandbox | stable | Codex が提供する macOS / Linux / Windows のサンドボックス内で任意コマンドを実行する |
codex update | stable | インストール済みリリースが self-update に対応しているとき、更新を確認・適用する |
主なコマンドの詳細
codex(対話): サブコマンド無しで TUI を起動する。グローバルフラグと画像添付を受け付ける。web search は既定で cached モードで、--searchでライブに切り替える。低摩擦なローカル作業には--sandbox workspace-write --ask-for-approval on-request--remote ws://host:port/wss://host:portでcodex app-server --listen ws://IP:PORTに接続する。ローカル Unix socket は--remote unix://(既定)か--remote unix://PATH
codex app-server: 主に開発・デバッグ用で、予告なく変わりうる。--listen stdio://が既定の JSONL-over-stdio(--stdioはそのエイリアス)。--listen ws://IP:PORTで WebSocket。サーバーが受け付ける listen URL はws://。クライアントがwss://で繋ぐ場合は TLS 終端かセキュアプロキシを使う。--listen unix://または--listen unix:///absolute/path.sock。クライアントバインディング用のスキーマ生成では--experimentalで gated なフィールドとメソッドを含められる--code-mode-host wss://...でローカルホストを起動せずリモートの Code Mode ホストに接続する。この outbound 接続は--listenとは別で、app-server プロセス内の全スレッドで共有される。ws://は localhost か SSH フォワードされたホストにのみ使う
codex remote-control: フォアグラウンドで remote control を開始する。start/stopでデーモンを管理し、pairで短命な手動ペアリングコードを出す。--jsonで機械可読出力(pairの JSON にはpairingCode、manualPairingCode、environmentId、expiresAt)。ローカルのプロトコルクライアントを作る用途ではcodex app-server --listenの代わりにはならないcodex apply: 認証済みで、そのチャットへのアクセス権が必要。パッチしたファイルを出力し、git applyが失敗すると非ゼロで終了するcodex review: レビュー対象をちょうど 1 つ選ぶか、カスタム指示をプロンプトとして渡す。--uncommitted、--base、--commit、カスタムPROMPTは互いに競合する。--titleは--commitとだけ併用するcodex archive/codex unarchive/codex delete: セッション ID または名前で指定する。セッション ID が名前より優先される。--forceはセッション UUID とのみ使える。名前付きセッションは、曖昧な名前を誤削除しないよう常に確認を求めるcodex cloud list: プレーンテキストではタスク URL と状態を出力する。--jsonの payload はtasks配列と任意のcursor。各タスクはid、url、title、status、updated_at、environment_id、environment_label、summary、is_review、attempt_totalを含むcodex features:$CODEX_HOME/config.tomlのフィーチャーフラグを管理する。enable/disableは将来のセッションにも効くよう永続化する。featuresサブコマンドは--profileを受け付けないcodex execpolicy:checkが 1 個以上の--rulesを受け取り、最も厳しい判定と一致したルールを JSON で出す。--prettyで整形。このコマンドは現在 previewcodex login: フラグ無しでは ChatGPT OAuth のためにブラウザを開く。codex login statusは資格情報があるとき0で終了するcodex mcp:addは stdio と streamable HTTP の両方に対応。OAuth のlogin/logoutは streamable HTTP サーバー、かつサーバーが OAuth に対応している場合にのみ動くcodex plugin marketplace add:owner/repoやowner/repo@refの GitHub 短縮形、HTTP(S) の Git URL、SSH の Git URL、ローカルのマーケットプレイスルートを受け付ける。--refで Git ref を固定、--sparse PATHの繰り返しで Git ベースのリポジトリを sparse checkout するcodex resume:--lastは現在の作業ディレクトリにスコープされる。--allで全体から探す。作業ディレクトリがセッションの保存ディレクトリと異なる場合はどちらを使うか尋ねる。tui.resume_cwdを"current"または"session"にすると尋ねずに済む。明示的な--cd(-C)はtui.resume_cwdより優先するcodex fork: 既定でセッションピッカーを開く。--lastで直近をフォークする。ディレクトリが異なる場合の扱いはcodex resumeと同じcodex update: debug ビルドではリリースビルドを入れるよう促すメッセージを出す
フラグの組み合わせに関する指針
- ワークスペース内で完結する無人のローカル作業には
--sandbox workspace-writeを使い、専用のサンドボックス VM の中でない限り--dangerously-bypass-approvals-and-sandboxは避ける - 書き込み可能ディレクトリを増やしたいときは
--sandbox danger-full-accessを強いるのではなく--add-dirを使う - CI では
--jsonと--output-last-messageを組み合わせて、機械可読な進捗と最終的な自然言語の要約の両方を得る
対話モードのショートカット
| 操作 | 動作 |
|---|---|
@ | ワークスペース内のファイルを検索してパスをプロンプトに追加する |
Up / Down | 下書き履歴を復元する |
Ctrl+R | プロンプト履歴を検索する。Enter で採用、Esc で取り消し |
Ctrl+O または /copy | 直近の完了した Codex 出力をコピーする |
行頭の ! | 現在の承認・sandbox 設定のもとでローカルの shell コマンドを実行する |
Tab(Codex 実行中) | 次のターン用にフォローアップのプロンプト・slash コマンド・shell コマンドをキューに入れる |
Enter(Codex 実行中) | 現在のターンに新しい指示を注入する |
Esc 2 回(composer が空のとき) | 直前のユーザーメッセージを編集し、その時点からチャットを fork する |
Ctrl+C または /exit | セッションを閉じる |
設定
codex --sandbox workspace-write --ask-for-approval on-request
codex --model gpt-5.6-terra -C ./services/payments
codex resume --last
codex exec --json --output-last-message out.txt "Run the tests"
codex completion zsh > "${fpath[1]}/_codex"
関連
facts/codex/slash-commands.mdfacts/codex/config-basics.mdfacts/codex/non-interactive-mode.mdfacts/codex/sandbox.mdfacts/codex/approvals-and-security.mdfacts/codex/mcp.mdfacts/codex/plugins.mdfacts/codex/models.md