既存のリポジトリにCodexを導入しよう

Codexのインストールと認証が終わったら、あとはリポジトリに「Codexが読みやすい下地」を用意するだけです。ここでは 30 分以内で済む、労力のわりに効果が大きいタスクを 3 つに絞って紹介します。

1. 最新 & ビルド可能な状態を整える（5 分）

  • まずはリポジトリを最新コミットまで同期し、ローカルビルドやテストコマンドを 1 度通して「動作が安定した状態」を作ります。
  • 依存パッケージのインストールやキャッシュ削除など、日頃のメンテナンスをここでまとめて実施すると効率的です。
  • 「クリーンな状態のリポジトリ」こそがCodexへの最良のコンテキスト なので、未追跡ファイルや失敗したビルドの残骸は先に片付けておきましょう。

2. agents.md を整備しコンテキストを共有する（10 分）

  1. リポジトリのルートに agents.md を置き、以下の情報を箇条書きでまとめます。
    • プロダクトの概要と用途
    • 技術スタック（フレームワーク、主要ライブラリ、言語仕様）
    • npm run dev や npm run build など主要コマンド
    • テストやリンターの実行方法、実行前の前提条件
  2. codex /init コマンドが利用できる場合は、リポジトリ直下で実行すると agents.md の雛形を自動生成できます。コマンドが未対応のバージョンでも、上記 4 項目を手動で書き出せば同じ効果が得られます。
  3. Codexに相談するときは「詳細は agents.md を参照してください」と添えるだけで文脈が伝わり、追加説明の手間が減ります。
  4. ホームディレクトリ配下の ~/codex/agents.md は、全プロジェクト共通の個人用メモとして機能します。よく使う方針やコーディングスタイルをここに書いておくと、CLIはリポジトリ固有の agents.md と併せて読み込み、どこからでも同じガイダンスを受けられます。

3. 触れてほしくないファイルをはっきりさせる（5 分）

  • Codex CLIは基本的にGitで追跡されているファイルを読みます。秘匿情報や生成ファイルは .gitignore で除外されているかを再確認しましょう。
  • .env などどうしても存在する必要があるファイルは、「編集禁止」と書いたコメントやサンプルファイル（例: .env.sample）を用意し、その扱いを agents.md に明記します。
  • CI/CD設定やインフラ定義ファイルを守りたい場合も、agents.md の「注意点」セクションに「変更前にレビュー必須」と書き添えるだけで誤提案を防ぎやすくなります。

以上を終えれば、Codexに「このリポジトリで何をしたいか」を簡潔に伝えられる状態になります。まずは軽いチケットからCodexに手伝ってもらい、効果を感じたら徐々にテンプレや自動化を拡充していきましょう。