AGENTS.md - コーディングエージェントをガイドするためのシンプルでオープンなフォーマット

AGENTS.mdは、20,000以上のオープンソースプロジェクトで利用されている、コーディングエージェントをガイドするために設計されたシンプルでオープンなフォーマットです。これは、AIコーディングエージェントがプロジェクトで効果的に作業するためのコンテキストと指示を提供するための専用スペースとして機能します。このフォーマットは、コーディングエージェントの特定のニーズに焦点を当てることで、従来のREADME.mdファイルを補完します。

1. セットアップコマンド

   • 依存関係をインストール: pnpm install
   • 開発サーバーを起動: pnpm dev
   • テストを実行: pnpm test

2. コードスタイルガイドライン

   • TypeScriptの厳格モード
   • シングルクォート、セミコロンなし
   • 関数型プログラミングパターンを好む

3. エージェントの互換性

   AGENTS.mdは、さまざまなAIコーディングエージェントとシームレスに動作します。

   エージェント名	説明
   Codex	AIコーディングエージェントのための汎用CLIツール。
   Amp	GoogleのAIコーディングエージェント。
   Jules	Googleの別のAIコーディングエージェント。
   Cursor	生産性を向上させるためのAIコーディングツール。
   Factory	コーディングエージェントを構築・管理するためのツール。
   Roo	様々なプログラミングタスクのためのAIコーディングアシスタント。
   CodeAider	コード支援と生成のためのAIツール。
   Gemini CLI	コーディングタスクのためのGoogleのCLIツール。
   Kilo Code	ストリームライン化された開発のためのAIコーディングエージェント。
   OpenCode	協力プロジェクトのためのオープンソースコーディングエージェント。
   Phoenix	コーディング効率を向上させるためのAIツール。
   Zed	様々なプログラミング言語のためのAIコーディングアシスタント。

4. ネストされたAGENTS.mdファイル

   大規模なモノレポでは、サブプロジェクト内にネストされたAGENTS.mdファイルを使用して、各パッケージに特化した指示を提供できます。

1. リポジトリのルートにAGENTS.mdファイルを作成します。
2. プロジェクトの概要、ビルドコマンド、テスト指示など、エージェントが効果的に作業するためのセクションを含めます。
3. コミットメッセージやセキュリティに関する考慮事項など、新しい貢献者に関連する追加の指示を追加します。
4. 大規模なプロジェクトでは、特定のサブプロジェクトのためにネストされたAGENTS.mdファイルを利用して、ローカライズされたガイダンスを提供します。

AGENTS.mdに必須フィールドはありますか？

いいえ、AGENTS.mdは柔軟で、必要に応じて任意の見出しを使用して構成できます。エージェントは提供されたテキストを解析します。

指示が矛盾した場合はどうなりますか？

編集されたファイルに最も近いAGENTS.mdファイルが優先され、明示的なユーザープロンプトが矛盾する指示を上書きします。

エージェントはテストコマンドを自動的に実行しますか？

はい、AGENTS.mdにテストコマンドがリストされている場合、エージェントはそれらを実行し、失敗を修正しようとします。

AGENTS.mdは後で更新できますか？

もちろん、AGENTS.mdは必要に応じて修正できる生きたドキュメントとして扱うべきです。

価格データはまだ利用できません; 詳細については公式ウェブサイトをご覧ください。

1. AGENTS.mdは、コーディングエージェントに対して構造化されたフォーマットを効果的に提供し、プロジェクトの要件を理解し、タスクを効率的に実行する能力を高めます。
2. README.mdファイルからの分離は、人間の貢献者に対して明確さを維持しつつ、AIエージェントに詳細なガイダンスを提供します。
3. ただし、AGENTS.mdの採用には、従来のドキュメント慣行に慣れたチーム内での文化的変化が必要かもしれません。
4. 全体として、AGENTS.mdはAIコーディングエージェントを使用してワークフローを効率化したい開発者にとって貴重なツールですが、その成功は一貫した使用と更新に依存します。