- AGENTS.md berfungsi sebagai pelengkap README dan merupakan file khusus yang berisi konteks serta panduan yang dibutuhkan agen coding AI saat bekerja di sebuah proyek
- Sudah digunakan di lebih dari 20.000 proyek open source untuk merangkum informasi seperti build/test/code style yang tidak terlalu diperlukan manusia tetapi penting bagi agen
- Menyediakan instruksi khusus agen di lokasi yang jelas dan dapat diprediksi, sehingga README tetap ringkas sambil meningkatkan efisiensi kolaborasi
- Satu AGENTS.md kompatibel dengan berbagai agen dan tool, dan pada monorepo skala besar dimungkinkan menggunakan AGENTS.md terpisah untuk tiap subproyek
- Merupakan standar terbuka yang dibuat lewat kolaborasi berbagai ekosistem seperti OpenAI Codex, Cursor, dan Google Jules
Why AGENTS.md?
- README.md adalah dokumentasi untuk manusia, menyediakan quick start, penjelasan proyek, dan panduan kontribusi
- AGENTS.md adalah dokumen pendamping untuk agen yang memuat konteks rinci seperti aturan build/test/kode tanpa membuat README menjadi rumit
- Alasan dipisahkan ke file tersendiri
- Memberikan lokasi instruksi yang dapat diprediksi untuk dirujuk agen
- README tetap ringkas dengan fokus pada kontributor manusia
- Menyediakan instruksi presisi khusus agen yang melengkapi dokumentasi yang sudah ada
- Mengadopsi nama standar terbuka yang bisa dipakai siapa saja, bukan format proprieter
- Satu AGENTS.md dapat kompatibel dengan banyak agen coding AI dan tool
How to use AGENTS.md?
- 1. Buat file AGENTS.md
- Letakkan di root repositori (banyak agen mendukung pembuatan otomatis)
- 2. Tulis poin-poin utama
- Ringkasan proyek
- Perintah build dan test
- Pedoman code style
- Cara melakukan pengujian
- Pertimbangan keamanan
- 3. Sertakan instruksi tambahan
- Hal-hal yang ingin disampaikan ke anggota tim seperti aturan commit/PR, perhatian keamanan, dataset besar, dan langkah deployment
- 4. Dukungan monorepo
- AGENTS.md dapat ditempatkan untuk setiap package
- Agen akan membaca file terdekat dan mengikuti instruksi yang sesuai untuk subproyek tersebut
- Contoh: repositori OpenAI memiliki 88 AGENTS.md
FAQ
- Item wajib: tidak ada, bebas menggunakan format Markdown umum
- Saat terjadi konflik: AGENTS.md terdekat diprioritaskan, prompt eksplisit dari pengguna diterapkan paling akhir
- Apakah dieksekusi otomatis: perintah test yang tertulis di file dapat dijalankan agen untuk mencoba memperbaiki error
- Kemungkinan pembaruan: bisa diubah kapan saja, dikelola sebagai dokumen hidup
- Migrasi dokumentasi yang ada: ganti nama file lalu pertahankan kompatibilitas dengan symbolic link
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Belum ada komentar.