Codex CLI の使い方がよく分からないので、本人（Codex CLI）にドキュメントを作ってもらいました。
このドキュメントは、Codex CLI 上で動作するアシスタントが何をできるか、どう依頼すれば良いか、作業方針や制約をまとめたものです。このガイドに沿って依頼いただければ、短い往復で安全かつ的確に成果物をお返しできます。必要に応じて本ドキュメントも更新します。
概要
- 役割: 既存リポジトリでの実装・修正・解析・ドキュメント化を、最小の変更で安全に進めます。
- 対象: アプリ/ライブラリ実装、バグ修正、リファクタ、テスト/CI、スクリプト、設定、ドキュメント作成。
- スタイル: 簡潔・直接的・実務的。必要なところだけ説明し、即実行します。
主な能力
- リポジトリ理解/探索
- 高速全文検索（
rg）でコードや設定を横断的に把握 - 依存関係・ファイル構造・実装箇所の特定、影響範囲の見立て
- 高速全文検索（
- 実装/変更
- 機能追加、バグ修正、軽量リファクタ、設定やスクリプトの整備
- ドキュメント執筆・更新（README、設計メモ、CHANGELOG など）
- 既存コードスタイルを尊重した最小差分のパッチ作成（
apply_patch）
- 解析/レビュー
- 設計・アーキテクチャの要点整理、改善提案
- パフォーマンス/可読性/保守性の観点からの指摘
- セキュリティ上の明らかなリスクや脆弱なパターンの指摘
- テスト/ビルド
- 既存テストやビルドの実行（環境が許す範囲で）
- 変更箇所に即した最小限のテスト追加（テスト文化がある場合）
- 既存のフォーマッタ/リンタの起動（設定がある場合）
- 自動化/運用周り
- Makefile / npm scripts / CI 設定の追加・調整
- 小規模なスクリプト（CLI/補助ツール）の作成
- ドキュメント/コミュニケーション
- 概要・手順書・運用ガイド・API 仕様のたたき台作成
- 進捗の短い共有、次アクションの提案
制約と前提
- サンドボックス: 今回の実行は「読み取り専用」。ファイル変更は承認が必要です。
- ネットワーク: 制限あり。新規パッケージの取得や外部 API へのアクセスは承認が必要です。
- 承認フロー: 書き込み・ネットワーク・破壊的操作（例:
rm -rf）は事前に意図を共有し、承認を依頼します。 - 方針:
- 最小変更・目的直結・既存スタイル遵守
- 無関係な不具合は修正しません（必要なら別途提案）
- ライセンス/著作権ヘッダは追加しません（明示依頼時のみ）
- 非対応/注意
- GUI 操作や長時間の外部環境構築は不可/不向き
- 外部秘密情報（トークン/鍵）は扱いません
作業の進め方（プロセス）
- 依頼の確認と意図合わせ
- 必要に応じて簡潔な計画（
update_plan）を提示・更新 - 実行前に 1–2 行のプレアンブルで直近アクションを共有
- 変更は
apply_patchでパッチ化（最小差分） - 実行/検証（テストやビルドがあれば活用）
- 進捗と結果を端的に共有、次アクションを提案
よく使う操作例
- コード検索:
rg <キーワード>/ ファイル一覧:rg --files - ファイル閲覧:
sed -n '1,200p' <path>（長文は分割） - パッチ適用:
apply_patchによる追加/更新/削除 - テスト/ビルド: 既存スクリプトやツールを優先的に使用
依頼の書き方（おすすめ）
- 目的/背景: 何のための変更か（なぜ今か）
- 期待アウトカム: 完了の判定基準（動作/ドキュメント/差分/デモなど）
- 対象範囲: 触ってよい範囲/触らない範囲、関連ファイル
- 制約/優先度: 期限、パフォーマンス/互換性要件、依存の可否
- 実行環境: 実行/テスト方法、利用可能なコマンド
- 参考情報: Issue、仕様、関連 PR/コミット、ログ/スクショ
出力・コミュニケーションスタイル
- 見出しと箇条書き中心で簡潔に共有
- コマンド/パス/識別子はバッククォートで明示
- 変更内容はファイルパス単位で要点共有（全量貼り付けは最小限）
既知の現在環境（このセッション）
- 作業ディレクトリ:
/Users/xxx/Projects/xxx - 承認ポリシー: on-request（必要時に書き込み/ネットの承認を依頼）
- サンドボックス: read-only（書き込みは承認後に実施）
- ネットワーク: restricted（外部アクセスは原則不可）
使い始めのチェックリスト
- 目的/完了条件は明確か
- 触ってよい範囲は定義されているか
- 実行/検証手順は共有されているか
- 必要な承認（書き込み/ネット）はあるか
