openai codex cliの使い方

概要

• openaiが開発したterminalで動作するコーディングサポートエージェント
• 2023年時点のcodex(コード補完AI)とは別物
• コードの編集に限ると、Web版のChatGPTよりも優れている

特徴

• 大きなファイルはスライディングしながら読み込む
• 出力が大きく、1ページに収まりきらない場合は、tmuxのスクロールモードを利用する等で確認できる
• esc を二回連続押すことで編集作業を中断できる

インストール

npm

$ npm install -g @openai/codex

bun

$ bun install -g @openai/codex

環境変数でキーを渡す

$ export OPENAI_API_KEY=sk-...

インストラクション

• ~/.codex/instructions.md: グローバル設定
• project/codex.md: プロジェクト独自設定

設定

• ~/.codex/config.yaml: 設定ファイルの場所

model: o4-mini
approvalMode: suggest
fullAutoErrorMode: ask-user
notify: true
safeCommands:
  - npm test
  - yarn lint

破壊的変更を防ぐ

• ブランチを切る
• git add . && git commit -m 'before codex' でコミット
• codexを実行
• おかしくなったら git reset --hard HEAD で戻す

対話モードでよく使うプロンプト

• foo.py で何をやっているか教えて
• src/* を読み込んでどのようなことを行うコードなのか教えて
• ありがとう、今までの改善すべき点をまとめて codex-review.md に書き出して

codexが苦手なこと

• 同じようなコードの関数が複数あると、指定した関数と別の関数を修正してしまう
  • コマンドでスライドして読み込んでいるためだと考えられる

トラブルシューティング

• ネットワークに問題が無いのに、エラーで処理が止まる場合
  • 原因
    • どうやらf-stringの中に { が二回連続していると、エラーになることがある
  • 対応
    • jinja2のテンプレートでEnvironment(variable_start_string='[[', variable_end_string=']]', autoescape=False) を使う

参考

• github.com/openai/codex