ドキュメントが一新されました!旧ドキュメントは doc.newapi.pro
New APINew API
利用ガイドインストールAPI リファレンスAIアプリケーションヘルプ&サポートビジネス協力

OpenAI Codex CLI

プロジェクト紹介

Codex CLI は、OpenAIが提供する、お使いのコンピューター上でローカルに動作するコーディングエージェントです。

デモンストレーション

introduce-01.webp

特徴

機能カテゴリ特徴
ターミナルベースのコーディングアシスタントCodex CLI は、コマンドラインでコードを編集し、パッチを生成し、コマンドを実行するためのターミナルベースのインタラクティブなコーディングアシスタントです。
ツール駆動型アーキテクチャapply_patchshellupdate_planmulti_tool_use などのツールを提供し、リポジトリファイルと操作を制御可能に修正します。
アトミックパッチ編集専用のパッチ形式を使用して apply_patch でファイルをアトミックに追加/更新/削除し、監査とロールバックを容易にします。
サンドボックスと承認サンドボックスポリシー(例:workspace-writeread-only)と承認モード(on-requeston-failurenever)をサポートし、書き込みおよびネットワークアクセス権限を制御します。
計画追跡update_plan はステップをリストアップし、ステータスを追跡するために使用され、明確な進捗を維持するために常に1つの in_progress ステップのみが存在する必要があります。
インタラクション規範重要な操作の前に短い前置き説明を送り、友好的で簡潔なトーンを保ち、進捗状況を更新します。
セキュリティ制約厳格なルール(無関係なファイルを勝手に変更しない、著作権ヘッダーを追加しない、破壊的なコマンドを実行しない)に従い、機密性の高い操作にはユーザーの承認が必要です。
テストとフォーマット変更後に関連するテストとフォーマットツールを実行することを推奨しますが、現在のタスクと無関係な問題の修正は責任を負いません。
出力とスタイル最終出力はCLIレンダリング仕様(例:** 見出し、バッククォートでパス/コマンドを示す)に従い、スキャンしやすい簡潔な構造を維持します。
並列実行multi_tool_use.parallel を介して複数のツールを並列実行し、効率を向上させることができます。

AIモデル設定方法

Windowsでの設定ガイド

1. ターミナルを開く

windows_open_terminal

2. WSLのインストール

Windowsで最高のパフォーマンスを得るには、Windows Subsystem for Linux (WSL2) をインストールして使用してください。

WSL2をインストールし、Windowsコンピューターを再起動する

wsl --install

インストール完了後にWindowsコンピューターを再起動してください。

Windowsでの注意事項

  • CMDではなくPowerShellの使用を推奨します
  • 権限の問題が発生した場合は、管理者として実行してみてください
  • 一部のウイルス対策ソフトウェアが誤検知する可能性があるため、ホワイトリストに追加する必要があります

windows-img-03.webp

Node Version Manager (NVM) をダウンロードする

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

windows-img-04.webp

NVMでNode.js 22をインストールする

タブバーで新しいPowerShellウィンドウを開き、WSLを起動します:

wsl

Node.jsをインストールする(バージョン番号は時限性があるため、OpenAI公式サイトの要件に従って対応するバージョンをインストールしてください):

nvm install 22

windows-img-05.webp

3. Codex CLIのインストール

Codex CLIをインストールする

npm i -g @openai/codex

このコマンドは、npm公式リポジトリから最新バージョンのCodex CLIをダウンロードしてインストールします。

windows-img-06.webp

4. 設定ファイルを変更する

Codex CLI設定ファイルをワンクリックで変更する

iex (irm 'https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.ps1')

windows-configure

5. Codex CLIの使用を開始する

これでCodex CLIを使い始めることができます!

Codex CLIを起動する

WSL2を起動する:

wsl

Codex CLIを直接起動する:

codex

特定のプロジェクトで使用する:

cd mnt/c/path/to/your/project
codex

Enterキーを押してCodex CLIを起動する。

windows-img-09.webp

windows-img-10.webp

Codex CLIの権限を設定します:1. Codexがファイルを直接変更することを許可する;2. Codexがファイルを変更する際に手動での承認が必要

モデルを選択する

/model

windows-img-11.webp

windows-img-12.webp

windows-img-13.webp

windows-img-14.webp

注意:インターフェースアドレスを変更すると、すべてのモデル(公式プリセットモデルを含む)はカスタムアクセスポイントを呼び出し、公式アカウントのクォータは使用されません。

macOSでの設定ガイド

1. Homebrewのインストール (既にインストール済みの場合はスキップ)

HomebrewはmacOSに不足しているパッケージのマネージャーです。

公式サイト:https://brew.sh

macos-img-01.webp

Homebrewをインストールする

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

macos-img-02.webp

macos-img-03.webp

macos-img-04.webp

2. Node.js環境のインストール

Node.js環境のインストール手順

Homebrewを更新する:

brew update

Node.jsをインストールする:

brew install node

macOSでの注意事項

  • 権限の問題が発生した場合は、sudoの使用が必要になる場合があります
  • 初回実行時にはシステム環境設定で許可が必要になる場合があります
  • TerminalまたはiTerm2の使用を推奨します

macos-img-05.webp

macos-img-06.webp

インストールが成功したかを確認する

インストールが完了したら、ターミナルを開き、以下のコマンドを入力してください:

node --version
npm --version

バージョン番号が表示されれば、インストールは成功です。

3. Codex CLIのインストール

Codex CLIをインストールする

ターミナルを開き、以下のコマンドを実行してください:

# Codex CLIをグローバルにインストール
npm install -g @openai/codex

権限の問題が発生した場合は、sudoを使用できます:

sudo npm install -g @openai/codex

macos-img-07.webp

Codex CLIのインストールを確認する

インストールが完了したら、以下のコマンドを入力してインストールが成功したかを確認してください:

codex --version

バージョン番号が表示されれば、おめでとうございます!Codex CLIは正常にインストールされました。

4. 設定ファイルを変更する

Codex CLI設定ファイルをワンクリックで変更する

curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.sh | bash

macos-configure

5. Codex CLIの使用を開始する

これでCodex CLIを使い始めることができます!

Codex CLIを起動する

Codex CLIを直接起動する:

codex

特定のプロジェクトで使用する:

cd /path/to/your/project
codex

Enterキーを押してCodex CLIを起動する。

macos-img-09.webp

macos-img-10.webp

Codex CLIの権限を設定します:1. Codexがファイルを直接変更することを許可する;2. Codexがファイルを変更する際に手動での承認が必要

macos-img-11.webp

macos-img-12.webp

macos-img-13.webp

macos-img-14.webp

注意:インターフェースアドレスを変更すると、すべてのモデル(公式プリセットモデルを含む)はカスタムアクセスポイントを呼び出し、公式アカウントのクォータは使用されません。

6. macOSのよくある問題解決

インストール時に権限エラーが表示される

以下の解決策を試してください:

  • sudoを使用してインストール:sudo npm install -g @openai/codex
  • またはnpmをユーザーディレクトリを使用するように設定:npm config set prefix ~/.npm-global

macOSのセキュリティ設定が実行をブロックする

システムがCodex CLIの実行をブロックする場合:

  • 「システム環境設定」→「セキュリティとプライバシー」を開く
  • 「それでも開く」または「許可」をクリックする
  • またはTerminalで実行:sudo spctl --master-disable

Linuxでの設定ガイド

1. Node.js環境のインストール

Codex CLIの実行にはNode.js環境が必要です。

Node.js環境のインストール手順

NodeSourceリポジトリを追加する:

sudo curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -

Node.jsをインストールする:

sudo apt-get install -y nodejs

Linuxでの注意事項

  • 一部のディストリビューションでは追加の依存関係のインストールが必要になる場合があります
  • 権限の問題が発生した場合は、sudoを使用してください
  • ユーザーがnpmのグローバルディレクトリに書き込み権限を持っていることを確認してください

linux-img-01.webp

linux-img-02.webp

インストールが成功したかを確認する

インストールが完了したら、ターミナルを開き、以下のコマンドを入力してください:

node --version
npm --version

バージョン番号が表示されれば、インストールは成功です。

2. Codex CLIのインストール

Codex CLIをインストールする

ターミナルを開き、以下のコマンドを実行してください:

# Codex CLIをグローバルにインストール
npm install -g @openai/codex

権限の問題が発生した場合は、sudoを使用できます:

sudo npm install -g @openai/codex

linux-img-03.webp

Codex CLIのインストールを確認する

インストールが完了したら、以下のコマンドを入力してインストールが成功したかを確認してください:

codex --version

バージョン番号が表示されれば、おめでとうございます!Codex CLIは正常にインストールされました。

3. 設定ファイルを変更する

Codex CLI設定ファイルをワンクリックで変更する

curl -fsSL https://raw.githubusercontent.com/QuantumNous/new-api-docs/refs/heads/main/helper/codex-cli-setup.sh | bash

macos-configure

4. Codex CLIの使用を開始する

これでCodex CLIを使い始めることができます!

Codex CLIを起動する

Codex CLIを直接起動する:

codex

特定のプロジェクトで使用する:

# プロジェクトディレクトリに移動
cd /path/to/your/project

# Codex CLIを起動
codex

Enterキーを押してCodex CLIを起動する。

linux-img-05.webp

linux-img-06.webp

Codex CLIの権限を設定します:1. Codexがファイルを直接変更することを許可する;2. Codexがファイルを変更する際に手動での承認が必要

linux-img-07.webp

linux-img-08.webp

linux-img-09.webp

linux-img-10.webp

注意:インターフェースアドレスを変更すると、すべてのモデル(公式プリセットモデルを含む)はカスタムアクセスポイントを呼び出し、公式アカウントのクォータは使用されません。

5. Linuxのよくある問題解決

インストール時に権限エラーが表示される

以下の解決策を試してください:

  • sudoを使用してインストール:sudo npm install -g @openai/codex
  • またはnpmをユーザーディレクトリを使用するように設定:npm config set prefix ~/.npm-global
  • その後PATHに追加:export PATH=~/.npm-global/bin:$PATH

依存ライブラリが不足している

一部のLinuxディストリビューションでは追加の依存関係のインストールが必要です:

# Ubuntu/Debian
sudo apt install build-essential

# CentOS/RHEL
sudo dnf groupinstall "Development Tools"

このガイドはいかがですか?

最終更新