AGENTS.mdAGENTS.md: ตำแหน่งไฟล์และวิธีที่เครื่องมืออ่าน
AGENTS.md เป็นไฟล์คำสั่งของโปรเจกต์ในรูปแบบ Markdown ธรรมดา ซึ่ง coding agent ส่วนใหญ่อ่านได้โดยไม่ต้องตั้งค่าเพิ่มเติม OpenAI มอบไฟล์นี้ให้ Agentic AI Foundation ภายใต้ Linux Foundation และมีโปรเจกต์โอเพนซอร์สกว่า 60k แห่งใช้งาน
ตำแหน่งไฟล์
- AGENTS.md ที่ root ของ repository ใช้กับทั้งโปรเจกต์
- ไฟล์ AGENTS.md ที่ซ้อนอยู่ในไดเรกทอรีย่อยหรือแพ็กเกจ โดย agent จะใช้ไฟล์ที่อยู่ใกล้ที่สุดในโครงสร้าง
- OpenAI Codex: ใช้ ~/.codex/AGENTS.override.md ระดับ global หรือใช้ ~/.codex/AGENTS.md หากไฟล์นั้นว่างหรือไม่มีอยู่
- Cline: ใช้ ~/.agents/AGENTS.md ระดับ global
- Claude Code รองรับ .claude/AGENTS.md ด้วย
รูปแบบ
Markdown ธรรมดา ไม่มี frontmatter หรือฟิลด์บังคับ ใช้หัวข้อแบบใดก็ได้ รูปแบบนี้ไม่ได้กำหนดขนาดสูงสุด แต่ OpenAI Codex จะหยุดอ่านเมื่อถึง project_doc_max_bytes ซึ่งค่าเริ่มต้นคือ 32 KiB
# Acme web app
Customer-facing web app with an admin area and a REST API.
## Commands
- Install: `pnpm install`
- Test: `pnpm test`
- Lint and type-check: `pnpm lint && pnpm tsc --noEmit`
## Code style
- TypeScript strict mode; no `any` in new code.
- Keep database access in `src/db/`.
## Never
- Never commit secrets or .env files.
- Never edit files under `src/generated/` by hand.
ลำดับความสำคัญและการผสาน
AGENTS.md ที่อยู่ใกล้ไฟล์ที่กำลังแก้ไขที่สุดจะมีผลเหนือกว่า และคำสั่งที่ระบุไว้ในแชตจะมีผลเหนือกว่าไฟล์ทุกไฟล์ OpenAI Codex นำไฟล์หนึ่งไฟล์จากแต่ละไดเรกทอรีมาต่อกัน ตั้งแต่ root ของโปรเจกต์ไปจนถึงไดเรกทอรีทำงาน ดังนั้นไฟล์ที่อยู่ใกล้กว่าจะอยู่ท้ายสุดและมีความสำคัญกว่า โดยค่าเริ่มต้น Claude Code จะไม่อ่าน AGENTS.md หากมี CLAUDE.md อยู่
เครื่องมือที่อ่านไฟล์นี้
| เครื่องมือ | การรองรับ |
|---|---|
| OpenAI Codex | รองรับโดยตรง อ่านไฟล์ระดับ global แล้วอ่านได้ไม่เกินหนึ่งไฟล์ต่อไดเรกทอรี ไล่จาก root ไปยังไดเรกทอรีทำงาน โดยค่าเริ่มต้นจำกัดที่ 32 KiB |
| Claude Code | รองรับโดยตรงตั้งแต่ v2.1.277 แต่จะใช้เฉพาะเมื่อไม่มี CLAUDE.md หรือ CLAUDE.local.md เว้นแต่จะตั้งค่าเป็น claude-md-and-agents-md |
| Cursor | รองรับโดยตรงทั้งไฟล์ที่ root และไฟล์ที่ซ้อนอยู่ ไฟล์ที่ซ้อนอยู่จะใช้ร่วมกับไฟล์ในไดเรกทอรีแม่ โดยไฟล์ที่เจาะจงกว่าจะมีผลเหนือกว่า |
| GitHub Copilot (cloud agent, code review, VS Code) | รองรับโดยตรงในทุกตำแหน่งของ repository โดยไฟล์ที่อยู่ใกล้ที่สุดจะมีผล |
| Devin Desktop (formerly Windsurf) | รองรับโดยตรง ไฟล์ที่ root จะมีผลเสมอ ส่วนไฟล์ในไดเรกทอรีย่อยจะมีผลกับไดเรกทอรีนั้น |
| Cline | รองรับโดยตรง และรองรับ ~/.agents/AGENTS.md ระดับ global ด้วย เปิดหรือปิดได้ในแผง Rules |
| Gemini CLI | ต้องเปิดใช้เอง: เพิ่ม AGENTS.md ลงใน context.fileName ใน .gemini/settings.json |
| Aider | ต้องเปิดใช้เอง: เพิ่ม read: AGENTS.md ลงใน .aider.conf.yml |
| OpenClaw | รองรับโดยตรงในฐานะไฟล์คำสั่งการทำงานที่จำเป็นใน workspace ของ agent |
| Listed on agents.md (not individually re-verified) | เป็นหนึ่งในเครื่องมือ 23 รายการในรายชื่อของ agents.md ซึ่งรวมถึง Amp, Jules, Zed, Warp, goose, opencode และ JetBrains Junie เราไม่ได้ตรวจสอบเครื่องมือเหล่านี้ทีละรายการ |
เคล็ดลับ
- กำลังเปลี่ยนชื่อ AGENT.md เดิมใช่ไหม? agents.md แนะนำให้ใช้ mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md เพื่อให้ทั้งสองชื่อยังใช้งานได้
- ระบุคำสั่งทดสอบและ lint: agent จะพยายามเรียกใช้การตรวจสอบที่พบ และแก้ไขข้อผิดพลาดก่อนเสร็จงาน
- ใน monorepo ให้เพิ่ม AGENTS.md สั้น ๆ แยกแต่ละแพ็กเกจ แทนการขยายไฟล์ที่ root ให้ยาวขึ้น
- ใน OpenAI Codex ไฟล์ AGENTS.override.md จะมีผลเหนือกว่า AGENTS.md ในไดเรกทอรีเดียวกัน
สร้าง AGENTS.md และไฟล์กฎที่ตรงกันสำหรับเครื่องมือ 5 รายการจากแบบฟอร์มเดียว เปิดตัวสร้าง AGENTS.md →