Contents
公式拡張機能の取得と前提条件
Codex IDE の拡張機能は VS Marketplace と GitHub リリースページから入手できます。まずは 取得先の正確性 と インストールに必要な環境 を確認しましょう。
入手方法(VS Marketplace と GitHub)
公式が提供している 2 つの配布チャネルを紹介します。どちらも同一バイナリで、署名付き .vsix ファイルですので安全にダウンロードできます。
| 配布先 | URL(2024‑06 時点) | 主な取得手順 |
|---|---|---|
| VS Marketplace | https://marketplace.visualstudio.com/items?itemName=openai.codex-ide | Marketplace の「Install」ボタンをクリックすると自動的に VS Code にインストールされます。 |
| GitHub Releases | https://github.com/openai/codex-ide/releases | 「Assets」から codex‑ide-x.y.z.vsix をダウンロードし、VS Code のコマンドパレットで Extensions: Install from VSIX… を選択します。 |
※ Marketplace の拡張子名は openai.codex-ide が正式です(執筆時点の最新情報)。リンク切れや名称変更があった場合は公式ドキュメントを参照してください。
VS Code と Node.js のバージョン要件
Codex IDE は以下のランタイムを前提に動作します。公式ページでは VS Code 1.86 以降(2023 年 11 月リリース)と記載されています。また、内部で codex-cli を呼び出すため Node.js LTS 系 (v20.x 系) が推奨 ですが、最低でも Node.js 16.14+ がインストールされていれば動作します。
|
1 2 3 4 5 6 |
# VS Code バージョン確認(ターミナル・PowerShell 共通) code --version # Node.js バージョン確認 node -v |
バージョンが要件に満たない場合は、VS Code の公式サイトまたは Node.js の LTS ダウンロードページから最新版を取得してください。
OpenAI API キーの取得と権限
Codex IDE が呼び出す OpenAI API には シークレットキー が必要です。現在の OpenAI ポータルではキーに個別の「Read & Write」スコープは存在せず、作成されたキーはデフォルトで全ての API エンドポイントへのアクセス権を持ちます(組織レベルで制限したい場合は管理コンソールから設定します)。
- OpenAI ポータル https://platform.openai.com/account/api-keys にサインイン。
- 「Create new secret key」ボタンをクリックし、表示されたキーを安全な場所にコピー。
- キーは 環境変数
OPENAI_API_KEYまたは.codexrcで参照します。
⚠️ キーは決してコードリポジトリや公開設定ファイルに平文で書き込まないでください。
OS 別インストール手順と環境変数設定
以下では、Windows・macOS・Linux の代表的なディストリビューションごとに、拡張機能のインストールから環境変数永続化までを具体例で示します。各セクションは必ず導入文が先頭にあります。
Windows でのインストール例
PowerShell を管理者権限で実行し、順番にコマンドを入力してください。
環境変数はシステムレベル(Machine)に永続化することで、再起動後も有効になります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
# 1. VS Code の拡張機能を Marketplace からインストール code --install-extension openai.codex-ide # 2. Node.js LTS (v20) が未インストールなら Chocolatey 経由で導入 if (-not (Get-Command node -ErrorAction SilentlyContinue)) { choco install nodejs-lts -y } # 3. API キーをシステム環境変数に永続登録 $apiKey = 'YOUR_OPENAI_API_KEY' # ← 実際のキーに置き換えてください [System.Environment]::SetEnvironmentVariable('OPENAI_API_KEY', $apiKey, 'Machine') # 4. PATH に VS Code のコマンドが通っているか確認(必要なら手動で追加) $codePath = "${env:ProgramFiles}\Microsoft VS Code\bin" if (-not ($env:PATH -split ';' | Where-Object { $_ -eq $codePath })) { [Environment]::SetEnvironmentVariable('PATH', "$env:PATH;$codePath", 'Machine') } |
ポイント
codeコマンドは VS Code のインストール時に「Shell command: Install ‘code’ command in PATH」を選択して有効化してください。
キーを直接スクリプトに書くのは危険です。実運用では Windows Credential Manager か Azure Key Vault と組み合わせることを推奨します。
macOS でのインストール例
macOS の標準シェル(zsh)を想定し、Homebrew を利用した手順です。環境変数は ~/.zprofile に書き込むことで ログインシェルすべて に適用できます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
# 1. Homebrew が未導入なら公式スクリプトでインストール if ! command -v brew >/dev/null; then /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" fi # 2. Node.js LTS (v20) を Homebrew から導入 brew install node@20 # 3. VS Code の拡張機能を Marketplace 経由でインストール code --install-extension openai.codex-ide # 4. API キーをシェルプロファイルに永続化(~/.zprofile が推奨) echo 'export OPENAI_API_KEY="YOUR_OPENAI_API_KEY"' >> ~/.zprofile source ~/.zprofile # 現ターミナルで即時反映 # 5. `code` コマンドが PATH に無い場合は手動でシンボリックリンク作成 if ! command -v code >/dev/null; then sudo ln -s "/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code" /usr/local/bin/code fi |
ポイント
Homebrew のnode@20はシンボリックリンクが自動で作成されません。brew link --force node@20で PATH に追加できます。
シークレットは macOS キーチェーン に保存し、security find-generic-password -s openai_api_keyで取得する方法もあります。
Linux(Ubuntu/Debian 系)でのインストール例
APT リポジトリから Node.js LTS を取得し、環境変数は /etc/environment に書き込むことでシステム全体に適用します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# 1. NodeSource のセットアップスクリプトで v20.x 系を追加 curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - sudo apt-get install -y nodejs # 2. VS Code の拡張機能インストール(Marketplace) code --install-extension openai.codex-ide # 3. API キーをシステム環境変数に永続化 sudo sh -c 'echo "OPENAI_API_KEY=\"YOUR_OPENAI_API_KEY\"" >> /etc/environment' # 4. 現在のシェルで即時反映(再ログインでも OK) source /etc/environment # 5. `code` コマンドが無い場合は VS Code の公式 .deb パッケージからインストール if ! command -v code >/dev/null; then wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > /tmp/microsoft.gpg sudo install -o root -g root -m 644 /tmp/microsoft.gpg /etc/apt/trusted.gpg.d/ sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main" > /etc/apt/sources.list.d/vscode.list' sudo apt-get update sudo apt-get install -y code fi |
ポイント
sudo権限が必要です。サーバー環境でユーザー単位に限定したい場合は~/.bashrcへexport OPENAI_API_KEY=...を追記してください。
Docker コンテナ内で使用する場合は、ビルド時にENV OPENAI_API_KEY=...として設定すると便利です。
Codex‑CLI のセットアップと VS Code 連携
Codex‑CLI はローカルでプロンプト実行やスクリプト自動生成を行うコマンドラインツールです。以下ではインストール手順、設定ファイル作成、VS Code との統合方法を順に示します。
npm パッケージのインストール
Node.js が導入されていれば、npm 経由でグローバルインストールできます。
公式ドキュメント(2024‑06)では @openai/codex-cli が最新パッケージ名です。
|
1 2 3 4 |
npm install -g @openai/codex-cli # インストール完了後にバージョン確認 codex --version |
.codexrc 設定ファイルの作成手順
プロジェクトルートかホームディレクトリに配置することで、CLI が自動的に読み込みます。
環境変数展開 を利用すればキー情報を平文で保存せずに済みます。
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "apiKey": "${OPENAI_API_KEY}", "model": "gpt-4o-mini", "maxTokens": 1024, "temperature": 0.2, "excludePatterns": [ "**/secrets/**", "**/*.env" ] } |
excludePatternsは Glob 形式で記述し、機密ファイルを補完対象から除外します。- 複数プロジェクトで異なる設定が必要な場合は、それぞれのフォルダーに個別
.codexrcを置くことができます。
VS Code 側の統合設定
VS Code の settings.json(ユーザー設定またはワークスペース設定)に下記項目を追加してください。
公式ドキュメントでは codex.path は省略可能ですが、環境によってはフルパス指定が必要になるケースがあります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ // CLI がグローバルインストールされている前提 "codex.path": "codex", // .codexrc の自動検出場所(ワークスペース優先) "codex.configFile": "${workspaceFolder}/.codexrc", // VS Code 起動時に自動で CLI を初期化 "codex.enableOnStartup": true, // 補完トリガーの細かい調整(任意) "codex.suggestTriggerCharacters": ["."] } |
設定を保存したら VS Code を再起動 してください。拡張機能が CLI と連携し、ステータスバーに「Codex Ready」と表示されます。
主な機能一覧(公式ドキュメント参照)
| 機能 | 呼び出し方法 | 主な効果 |
|---|---|---|
| コード補完 | エディタで Ctrl+Space または自動トリガー |
関数本体やロジックの生成、型情報を考慮した提案 |
| リファクタリング | コマンドパレット → Codex: Refactor |
変数名統一・重複コード削除・関数抽出などの自動提案 |
| ドキュメント生成 | コメントブロック上で Codex: Generate Docs |
関数/クラスの docstring を自然言語で作成 |
| インラインエラー修正 | エラーメッセージ表示中に Alt+Enter |
推奨パッチを提示し、ワンクリックで適用可能 |
| テストコード生成 | コマンドパレット → Codetests: Generate Tests |
対象関数のユニットテストテンプレート(Jest, PyTest 等)を自動作成 |
| スニペット保存 | Codex: Save Snippet |
生成したコードを個人用スニペットとして登録 |
補足:上記機能はすべて同一 API キーで利用でき、モデルやトークン数の上限は
.codexrcの設定に従います。
初回起動・認証フローと主要機能体験
拡張機能をインストールしたら、まずは 認証 と 基本的な補完テスト を行いましょう。ここでは手順ごとに簡潔な説明を付加しています。
API キー入力と保存フロー
- VS Code 左下に表示される 「Codex: Sign in」 ボタンをクリック。
- ポップアップが開くので、先ほど取得した
OPENAI_API_KEYを貼り付けて Save。 - キーは内部的に
.codexrcの${OPENAI_API_KEY}にマッピングされ、以降の再入力は不要です。
注意:キーが正しく設定されたかはターミナルで
echo $OPENAI_API_KEY(PowerShell は$env:OPENAI_API_KEY)を実行し、値が表示されることを確認してください。
補完テスト用サンプルコード
以下の Python スクリプトを新規作成し、関数本体部分で Ctrl+Space を押すと Codex が自動生成した実装が候補として表示されます。
|
1 2 3 4 |
def fibonacci(n: int) -> int: """n 番目のフィボナッチ数を返す""" # ここに Codex に続きの実装を書かせるプロンプト例 |
- 期待結果:
if n <= 1: return nから始まる再帰実装、またはイテレーティブ版が提示されます。 - 補完候補を選択すれば、コードが即座に挿入されます。
代表的な機能の体験例
| 機能 | 実行手順 | デモンストレーション |
|---|---|---|
| リファクタリング | Ctrl+Shift+P → Codex: Refactor → 「変数名統一」選択 |
oldName がプロジェクト全体で newName に置換される |
| ドキュメント生成 | 関数コメント行で右クリック → Codex: Generate Docs |
自然言語で書かれた docstring が自動挿入 |
| テストコード生成 | 任意関数上で Ctrl+Shift+P → Codetests: Generate Tests |
pytest 用のテスト関数が新しいファイルに作成 |
| インラインエラー修正 | エラーメッセージが赤線で表示された箇所で Alt+Enter |
修正案(例:型ミスマッチ解消)がプレビューされ、適用可能 |
これらの操作はすべて 同一 API キー で行われ、モデルやトークン上限は .codexrc の設定に従います。
安全対策・ベストプラクティス とトラブルシューティング
AI 補完は強力ですが、誤用やコスト増大を防ぐためのガイドラインが重要です。以下では 使用量モニタリング、シークレット除外設定、よくあるエラーと対処法 を中心に解説します。
API 使用量のモニタリング
| 手段 | 方法 | 補足 |
|---|---|---|
| OpenAI ダッシュボード | 「Usage」ページでトークン消費を日次・月次で確認 | アラートは「Settings → Usage alerts」で設定可能 |
| Codex‑CLI | codex usage --last 30d |
ローカルから簡易集計が取得でき、スクリプト化も容易 |
| 自動通知 | CloudWatch / GCP Monitoring と Webhook を組み合わせる | 大規模利用時は外部監視ツールでコスト上限を設定 |
シークレット除外とプロジェクト単位有効化
.codexrc の excludePatterns に機密ファイルやディレクトリパスを追加すると、Codex がそれらの内容を補完対象にしません。さらに VS Code のワークスペース設定で拡張機能自体の有効/無効を制御できます。
|
1 2 3 4 5 6 7 8 9 |
// .codexrc(例) { "excludePatterns": [ "**/.env", "**/config/*.yml", "**/secrets/**" ] } |
|
1 2 3 4 5 6 7 8 9 10 11 |
// VS Code workspace settings(.vscode/settings.json) { "codex.enable": false, // デフォルトで無効化 "[javascript]": { "codex.enable": true // JavaScript ファイルだけ有効化 }, "[python]": { "codex.enable": true } } |
この設定により、機密情報が誤って AI に送信されるリスク を大幅に低減できます。
よくあるエラーと対処法
| エラー | 想定原因 | 推奨解決策 |
|---|---|---|
| 拡張機能がロードされない | VS Code が 1.86 未満、または Node.js が PATH に無い | code --version ≥ 1.86 を確認し、Node.js (node -v) が正しくパスに含まれるか検証 |
| 認証エラー (401/403) | 環境変数未設定、キー文字列が破損、または組織レベルで API アクセスがブロックされている | echo $OPENAI_API_KEY で値を確認し、ポータルの「API Keys」ページで権限とステータスをチェック |
| Node バージョン不整合 | 複数 Node がインストールされ、古いバイナリが優先されている | which node(macOS/Linux)または $env:PATH の順序を確認し、必要ならシンボリックリンクや nvm use 20 で固定 |
CLI が見つからない (codex: command not found) |
npm グローバルインストールディレクトリが PATH に含まれていない | npm root -g の出力を確認し、export PATH=$PATH:<path>/bin をシェルプロファイルへ追記 |
トークン上限エラー (Rate limit exceeded) |
短時間に過剰リクエスト、または月間予算超過 | codex usage で現在の消費量を確認し、スロットリングやバックオフ実装を検討 |
拡張機能のアップデート手順とリリースノート確認
- Marketplace 経由:VS Code の拡張機能ビューで「更新」通知が出たらクリック。
- CLI から強制再インストール:
|
1 2 |
code --install-extension openai.codex-ide --force |
- リリースノートの確認:GitHub Releases ページ(
https://github.com/openai/codex-ide/releases)に詳細が掲載されています。主要変更点はCHANGELOG.mdでも追跡可能です。
ベストプラクティス:アップデート前に現在の
.codexrcのバックアップを取得し、重大な設定変更がないか確認してから適用してください。
まとめ
- 公式拡張機能は Marketplace(openai.codex-ide)または GitHub Releases から安全に入手。
- VS Code ≥ 1.86 と Node.js LTS (v20 系) が推奨、ただし最低 Node.js 16+ は必須。
- OpenAI API キーはシークレットとして環境変数
OPENAI_API_KEYに設定(権限スコープの記述は不要)。 - OS ごとのインストール手順と永続的な環境変数登録方法 を正確に実施。
- Codex‑CLI と
.codexrcの連携、VS Code 設定 で補完・リファクタリング・ドキュメント生成をフル活用。 - 使用量モニタリングとシークレット除外設定 によってコストと情報漏洩リスクを最小化。
- エラー発生時は公式ドキュメント・GitHub Issues を参照し、上記対処法で速やかに復旧。
これらの手順に沿って環境を整備すれば、Codex IDE の AI 補完機能を安全かつ効果的に活用できます。ぜひ実務プロジェクトでも試してみてください。