OpenAI Codex CLI: ターミナルコマンドラインAIコーディングアシスタント OpenAIがリリース

はじめに

OpenAI Codex CLIは、OpenAIによって開発された、ターミナルに慣れ親しんだ開発者のためのオープンソースのターミナルコーディングツールです。Codex CLIはOpenAIの最新モデル（o3やo4-miniなど）を使用し、多言語プログラミングをサポートし、セキュリティを確保するためにネットワークアクセスやディレクトリ操作を制限するセキュアなサンドボックス環境を提供します。このプロジェクトは完全にオープンソースであり、コミュニティによる貢献を奨励し、迅速な開発、タスクの自動化、プログラミングの学習に適しています。

機能一覧

• コード生成：Python、JavaScriptなどの多言語コードを自然言語に基づいて生成します。
• ファイル操作：ファイルの作成と編集、Gitコミットとバージョン管理をサポート。
• コマンド実行：サンドボックス内でコードやコマンドを実行し、結果をリアルタイムで表示する。
• マルチモーダル入力：スクリーンショットとチャート入力をサポートし、対応するコードを生成します。
• セキュリティサンドボックス：デフォルトでネットワークを無効にし、セキュリティのためにカレントディレクトリのみを操作する。
• 自動承認：手動、自動編集、完全自動の3つのモードを提供。
• オープンソース開発：ユーザーがコードを閲覧したり、PRコントリビューション機能を投稿したりできる。
• プロジェクトドキュメント：グローバルおよびプロジェクトレベルのMarkdownコマンドのサポート、カスタム動作。

ヘルプの使用

設置プロセス

Codex CLIを使用するには、以下のインストール手順を完了してください：

1. システム要件::
   • OS：macOS 12+、Ubuntu 20.04+/Debian 10+、またはWindows 11（WSL2経由）。
   • Node.js: バージョン >= 22 (LTS バージョン推奨)。
   • Git: バージョン >= 2.23 (バージョン管理のため、推奨)。
   • RAM: 少なくとも4GB、8GBを推奨。
   • OpenAI APIキー：OpenAIのウェブサイトから取得する。
2. インストール手順::
   • npm経由でグローバルにインストールする（推奨）：

     npm install -g @openai/codex
     

   • またはソースコードからビルドする：

     git clone https://github.com/openai/codex.git
     cd codex/codex-cli
     npm install
     npm run build
     

   • APIキーを設定します：

     export OPENAI_API_KEY="your-api-key-here"
     

     恒久的な設定にするには、シェル・コンフィギュレーション・ファイル（例えば ~/.zshrc もしかしたら ~/.bashrc):

     echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
     source ~/.zshrc
     

   • インストールを確認する：

     codex --help
     

     ヘルプメッセージが表示されれば、インストールは成功です。

3. Linux Dockerの設定::
   • セキュリティ強化のためにDockerを推奨する：

     ./run_in_container.sh
     

   • Dockerがインストールされていることを確認してください。スクリプトは自動的にカレントディレクトリをマウントし、OpenAI APIアクセスのみを許可するようにファイアウォールを設定します。
4. ほら::
   • 使用しないでください。 sudo npm install -gはnpmのパーミッションを修正する必要がある：

     sudo chown -R $(whoami) ~/.npm
     

   • を避けるために、APIキーが有効であることを確認してください。 401 もしかしたら 429 エラー。

使用方法

Codex CLIは、ターミナルコマンド操作による自然言語とサンドボックス環境を組み合わせることで、効率的なコーディング体験を提供します。以下、主な機能の使い方の流れです：

1.コード生成

• ワークフロー::
  • 交流パターン：

    codex
    

    Create Python function to compute a Fibonacci series（フィボナッチ級数を計算するPython関数を作成する）」のようなプロンプトを入力する。

  • シングル・コマンド・モード：

    codex "生成 JavaScript 过滤数组函数"
    

  • Codex CLIはコードを生成し、プレビューを表示します。
  • 輸入 y を入力して保存する。 n 不合格。
• 高度なオプション::
  • モデルを指定する：

    codex --model o4-mini "生成 Go HTTP 服务器"
    

  • 非対話モード：

    codex -q "生成 SQL 查询" > output.sql
    

• 注目の機能::
  • Python、JavaScript、TypeScript、Go、SQLなどをサポート。
  • ユーザー認証でFlaskアプリケーションを生成する」といった複雑なタスクを処理できる。

2.ファイル操作とGitの統合

• ワークフロー::
  • ファイルを編集する

    codex "在 src/app.js 中添加登录功能"
    

  • Codex CLIはコードの差分を表示し、確認して保存する。
  • Gitにコミットする：

    codex "提交更改，消息为 '添加登录功能'"
    

• 注目の機能::
  • Gitコマンドを自動的に処理する (addそしてcommit).
  • などのバッチ操作をサポート：

    codex "重命名所有 *.jpeg 为 *.jpg 并更新引用"
    

  • 3つの承認モードが用意されている：
    • suggestデフォルトでは、すべての変更は手動で確認する必要があります。
    • auto-editファイルの変更を自動的に適用します。
    • full-auto全自動のため、使用には注意が必要：

      codex --approval-mode full-auto "更新 README"
      

3.コードを実行する

• ワークフロー::
  • コードを実行する：

    codex "运行 src/main.py"
    

  • Codex CLIはサンドボックス内で実行され、結果を表示する。
  • 依存関係が見つからない場合は、インストールを促す：

    codex "安装 numpy 并运行 script.py"
    

• 注目の機能::
  • macOSはApple Seatbeltサンドボックスを使用し、LinuxはDockerを使用する。
  • 偶発的なアクセスを防ぐため、ネットワークはデフォルトで無効になっています。
  • エラーの詳細を表示するデバッグ出力をサポート。

4.マルチモーダル入力

• ワークフロー::
  • 画像のパスを入力します：

    codex "根据 ui.png 实现界面代码"
    

  • Codex CLIは画像を解析してHTML/CSSやフロントエンドコードを生成します。
• 注目の機能::
  • UIデザインからコードへの変換をサポート。
  • ダイアグラムやフローチャートを処理してロジックコードを生成することができる。

5.設定とカスタマイズ

• 設定ファイル::
  • グローバル設定：~/.codex/config.yaml::

    model: o4-mini
    fullAutoErrorMode: ask-user
    

  • インストラクションファイル：~/.codex/instructions.md::

    - 使用 Python 3.9
    - 禁止自动提交 Git
    

  • プロジェクトレベルの設定 codex.md::

    - 优先使用 TypeScript
    - 运行测试前执行 npm run lint
    

• プロジェクトのドキュメントを無効にする::

  codex --no-project-doc

• 承認モード切り替え::

  codex --approval-mode auto-edit
  

6.CI/CDインテグレーション

• ワークフロー::
  • GitHub Actionsで実行します：

    - name: 更新文档
    run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit -q "更新 CHANGELOG"
    

  • マナーモードを設定します：

    export CODEX_QUIET_MODE=1
    

• 注目の機能::
  • 自動処理に適した非インタラクティブモードをサポート。
  • スクリプトを書きやすいようにJSON形式で出力します：

    codex -q --json "生成配置"
    

ほら

• ディレクトリがGitによって追跡されていることを確認する。full-auto モードでは、Git 以外のディレクトリで警告が表示されます。
• APIキーのクォータをチェックしてください。
• このプロジェクトは実験的なもので、不安定な機能があるかもしれないので、GitHubでアップデートを確認することをお勧めする。

アプリケーションシナリオ

1. ラピッドプロトタイピング
   開発者は、自然言語でコードフレームワークを素早く生成できる。例えば、"Create an Express application with a database "と入力すると、Codex CLIはアイデアの検証に適したルート、モデル、設定ファイルを生成する。
2. 自動化されたタスク
   Codex CLIは、「すべてのファイルの著作権表示を更新して投稿する」といった繰り返し作業を簡素化します。ファイルを自動的に編集し、スクリプトを実行し、バッチ操作でGitにプッシュします。
3. プログラミング学習
   初心者は「Pythonでクイックソート」と入力すると、Codex CLIがコードを生成し、ロジックを説明します。
4. オープンソース・コラボレーション
   開発者はGitHubを通じてCodex CLIの開発に参加し、バグフィックスや新機能を提出することができる。
5. CI/CDパイプライン
   CI環境では、Codex CLIが自動的にドキュメントを更新し、テストケースを生成し、より効率的な開発のためにlintバグを修正することができます。

品質保証

1. Codex CLIと2021年Codexモデルとの違いは？
   Codex CLIは、最新のOpenAIモデル（o3、o4-mini）に基づく、より強力でオープンソースのエンドポイントツールであり、2021年に廃止されるCodexモデルとは独立している。
2. 安全な運転を確保するには？
   Codex CLIはデフォルトでサンドボックスで実行され、macOSではApple Seatbeltを、LinuxではDockerを使用し、システムリスクを回避するためにネットワークを無効にし、ディレクトリへのアクセスを制限する。
3. どのようなプログラミング言語に対応していますか？
   Python、JavaScript、TypeScript、Go、SQLなどがサポートされており、使用するOpenAIモデルによって決定され、コマンドで言語を指定できる。
4. Codex CLIは無料ですか？
   Codex CLI自体は無料ですが、OpenAIのAPIキーが必要で、APIコールにコストがかかる場合があります。
5. Codex CLIがファイルを変更しないようにするには？
   利用する suggest モードでは、すべての変更を手動で確認する必要がある：

   codex --approval-mode suggest