Codex CLI実践ガイド - ターミナルワークフローへの統合

1
2
3
4
5
6
7
8

# 基本的な実行
codex exec "このリポジトリの構成を要約して"

# 結果をファイルに保存
codex exec "直近10コミットのリリースノートを生成して" | tee release-notes.md

# 最終メッセージをファイルに出力
codex exec -o result.txt "READMEを更新して"

1
2
3
4
5
6
7
8

# 読み取り専用（デフォルト）
codex exec "コードベースを分析して"

# ファイル編集を許可
codex exec --full-auto "リンターエラーを修正して"

# より広いアクセスを許可（制御された環境でのみ使用）
codex exec --sandbox danger-full-access "依存関係を更新して"

1

codex exec --json "リポジトリ構成を要約して" | jq .

1
2
3
4

{"type":"thread.started","thread_id":"0199a213-81c0-7800-8aa1-bbab2a035a53"}
{"type":"turn.started"}
{"type":"item.completed","item":{"id":"item_3","type":"agent_message","text":"..."}}
{"type":"turn.completed","usage":{"input_tokens":24763,"output_tokens":122}}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

# スキーマファイルを用意
cat > schema.json << 'EOF'
{
  "type": "object",
  "properties": {
    "project_name": { "type": "string" },
    "programming_languages": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "required": ["project_name", "programming_languages"],
  "additionalProperties": false
}
EOF

# スキーマに従った出力を生成
codex exec "プロジェクトメタデータを抽出して" \
  --output-schema ./schema.json \
  -o ./project-metadata.json

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#!/bin/bash
# review.sh - 変更されたファイルのコードレビューを自動実行

set -e

# 変更されたファイルを取得
CHANGED_FILES=$(git diff --name-only HEAD~1)

if [ -z "$CHANGED_FILES" ]; then
    echo "レビュー対象のファイルがありません"
    exit 0
fi

echo "レビュー対象ファイル:"
echo "$CHANGED_FILES"

# Codexでレビューを実行
codex exec --sandbox read-only \
    "以下のファイルの変更をレビューしてください。
    潜在的なバグ、パフォーマンス問題、セキュリティリスクを指摘してください。
    
    変更されたファイル:
    $CHANGED_FILES"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/bin/bash
# diagnose-test-failure.sh - テスト失敗時の自動診断

set -e

TEST_OUTPUT=$(npm test 2>&1) || true

if echo "$TEST_OUTPUT" | grep -q "FAIL"; then
    echo "テスト失敗を検出しました。Codexで診断を実行します..."
    
    codex exec --sandbox read-only \
        "以下のテスト失敗を分析し、原因と修正案を提示してください:
        
        $TEST_OUTPUT"
else
    echo "すべてのテストが成功しました"
fi

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

#!/bin/bash
# generate-release-notes.sh - コミット履歴からリリースノートを生成

VERSION=$1
PREVIOUS_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")

if [ -z "$PREVIOUS_TAG" ]; then
    COMMIT_RANGE="HEAD"
else
    COMMIT_RANGE="$PREVIOUS_TAG..HEAD"
fi

COMMITS=$(git log $COMMIT_RANGE --pretty=format:"%s" --no-merges)

codex exec --sandbox read-only \
    "以下のコミットメッセージからバージョン $VERSION のリリースノートを生成してください。
    機能追加、バグ修正、破壊的変更をカテゴリ分けしてください。
    
    コミット:
    $COMMITS" \
    -o "RELEASE_NOTES_${VERSION}.md"

echo "リリースノートを生成しました: RELEASE_NOTES_${VERSION}.md"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

#!/bin/bash
# .git/hooks/prepare-commit-msg

COMMIT_MSG_FILE=$1
COMMIT_SOURCE=$2

# マージコミットやamendの場合はスキップ
if [ "$COMMIT_SOURCE" = "merge" ] || [ "$COMMIT_SOURCE" = "commit" ]; then
    exit 0
fi

# ステージされた変更を取得
STAGED_DIFF=$(git diff --cached --stat)

if [ -z "$STAGED_DIFF" ]; then
    exit 0
fi

# Codexでコミットメッセージを提案
SUGGESTED_MSG=$(codex exec --sandbox read-only \
    "以下のgit diffから、Conventional Commits形式のコミットメッセージを1行で提案してください:
    
    $STAGED_DIFF" 2>/dev/null)

if [ -n "$SUGGESTED_MSG" ]; then
    echo "# Codex suggested: $SUGGESTED_MSG" >> "$COMMIT_MSG_FILE"
fi

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

#!/bin/bash
# .git/hooks/pre-push

echo "プッシュ前のコード品質チェックを実行中..."

# 直近のコミットの変更を分析
RESULT=$(codex exec --sandbox read-only \
    "プッシュ対象の変更を分析し、以下の問題がないかチェックしてください:
    1. 明らかなバグやエラー
    2. セキュリティ上の問題
    3. パフォーマンスの懸念
    
    問題がなければ'OK'とだけ回答してください。
    問題がある場合は詳細を説明してください。" 2>/dev/null)

if echo "$RESULT" | grep -qi "^OK$"; then
    echo "チェック完了: 問題なし"
    exit 0
else
    echo "潜在的な問題が検出されました:"
    echo "$RESULT"
    
    read -p "プッシュを続行しますか? (y/N): " CONFIRM
    if [ "$CONFIRM" != "y" ] && [ "$CONFIRM" != "Y" ]; then
        echo "プッシュを中止しました"
        exit 1
    fi
fi

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

#!/bin/bash
# .git/hooks/post-merge

echo "マージ後のコードベース整理を確認中..."

codex exec --sandbox read-only \
    "マージ後の変更を確認し、以下について提案してください:
    1. 不要になった可能性のあるコード
    2. 更新が必要なドキュメント
    3. 追加が推奨されるテスト" | head -50

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

name: Codex auto-fix on CI failure

on:
  workflow_run:
    workflows: ["CI"]
    types: [completed]

permissions:
  contents: write
  pull-requests: write

jobs:
  auto-fix:
    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
    runs-on: ubuntu-latest
    env:
      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
      FAILED_HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
      FAILED_HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ env.FAILED_HEAD_SHA }}
          fetch-depth: 0

      - uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install dependencies
        run: |
          if [ -f package-lock.json ]; then npm ci; else npm i; fi

      - name: Install Codex
        run: npm i -g @openai/codex

      - name: Authenticate Codex
        run: codex login --api-key "$OPENAI_API_KEY"

      - name: Run Codex
        run: |
          codex exec --full-auto --sandbox workspace-write \
            "リポジトリを読み込み、テストスイートを実行し、
            すべてのテストを通過させるために必要な最小限の変更を特定し、
            その変更のみを実装して停止してください。
            無関係なファイルをリファクタリングしないでください。"

      - name: Verify tests
        run: npm test --silent

      - name: Create pull request
        if: success()
        uses: peter-evans/create-pull-request@v6
        with:
          branch: codex/auto-fix-${{ github.event.workflow_run.run_id }}
          base: ${{ env.FAILED_HEAD_BRANCH }}
          title: "fix: Codexによるテスト失敗の自動修正"
          body: |
            このPRはCodex CLIによって自動生成されました。
            CI失敗を検出し、テストを通過させるための修正を適用しています。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

name: Codex pull request review

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  codex:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    outputs:
      final_message: ${{ steps.run_codex.outputs.final-message }}
    steps:
      - uses: actions/checkout@v5
        with:
          ref: refs/pull/${{ github.event.pull_request.number }}/merge

      - name: Pre-fetch base and head refs
        run: |
          git fetch --no-tags origin \
            ${{ github.event.pull_request.base.ref }} \
            +refs/pull/${{ github.event.pull_request.number }}/head

      - name: Run Codex
        id: run_codex
        uses: openai/codex-action@v1
        with:
          openai-api-key: ${{ secrets.OPENAI_API_KEY }}
          prompt-file: .github/codex/prompts/review.md
          output-file: codex-output.md
          safety-strategy: drop-sudo
          sandbox: workspace-write

  post_feedback:
    runs-on: ubuntu-latest
    needs: codex
    if: needs.codex.outputs.final_message != ''
    steps:
      - name: Post Codex feedback
        uses: actions/github-script@v7
        with:
          github-token: ${{ github.token }}
          script: |
            await github.rest.issues.createComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.payload.pull_request.number,
              body: process.env.CODEX_FINAL_MESSAGE,
            });
        env:
          CODEX_FINAL_MESSAGE: ${{ needs.codex.outputs.final_message }}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# .gitlab-ci.yml
stages:
  - test
  - codex-review

test:
  stage: test
  script:
    - npm ci
    - npm test

codex-review:
  stage: codex-review
  image: node:20
  only:
    - merge_requests
  script:
    - npm i -g @openai/codex
    - codex login --api-key "$OPENAI_API_KEY"
    - |
      codex exec --sandbox read-only \
        "このマージリクエストの変更をレビューし、
        改善点やリスクがあれば指摘してください。" \
        -o review-result.md
  artifacts:
    paths:
      - review-result.md
    expire_in: 1 week

1
2
3
4
5
6

# GitHub Actionsの場合
env:
  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

# 単一実行時に異なるAPIキーを使用
- run: CODEX_API_KEY=${{ secrets.DIFFERENT_KEY }} codex exec "タスク"

1
2
3

# ~/.codex/config.toml
# file | keyring | auto
cli_auth_credentials_store = "keyring"

1
2

# デバイスコード認証
codex login --device-auth

1
2
3

# ローカルからリモートに認証情報をコピー
ssh user@remote 'mkdir -p ~/.codex'
scp ~/.codex/auth.json user@remote:~/.codex/auth.json

1
2
3
4

# /etc/codex/requirements.toml
# 危険なモードを禁止
allowed_approval_policies = ["untrusted", "on-request", "on-failure"]
allowed_sandbox_modes = ["read-only", "workspace-write"]

1
2
3
4
5
6
7

# /etc/codex/managed_config.toml
# 組織のデフォルト設定
approval_policy = "on-request"
sandbox_mode    = "workspace-write"

[sandbox_workspace_write]
network_access = false

1
2
3
4
5

# シンプルなタスクにはminiモデルを使用
codex exec -m gpt-5.1-codex-mini "このファイルのタイポを修正して"

# 複雑なタスクには標準モデルを使用
codex exec -m gpt-5.2-codex "アーキテクチャを分析して改善案を提示して"

1
2
3
4
5

# 悪い例: 曖昧で広範なプロンプト
codex exec "このプロジェクトを改善して"

# 良い例: 具体的で焦点を絞ったプロンプト
codex exec "src/utils/validation.ts の validateEmail 関数のエラーハンドリングを改善して"

1
2
3
4

# ~/.codex/config.toml
# 必要なMCPサーバーのみを有効化
[mcp]
servers = ["essential-server"]

1
2

# セッション中に使用量を確認
/status

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

import { Codex } from "@openai/codex-sdk";

const codex = new Codex();
const thread = codex.startThread();

// 最初のタスクを実行
const result = await thread.run(
  "CI失敗の診断と修正計画を作成して"
);
console.log(result);

// 同じスレッドで続行
const fixResult = await thread.run("計画を実行して");
console.log(fixResult);

// 過去のスレッドを再開
const threadId = "<thread-id>";
const resumedThread = codex.resumeThread(threadId);
const resumeResult = await resumedThread.run("続きから作業を再開して");
console.log(resumeResult);