AGENTS.mdAGENTS.md: lokasyon at kung paano ito binabasa ng mga tool
Ang AGENTS.md ay isang plain Markdown file na naglalaman ng mga instruction para sa proyekto. Karamihan sa mga coding agent ay nagbabasa nito nang walang kailangang karagdagang setup. Iniambag ito ng OpenAI sa Agentic AI Foundation sa ilalim ng Linux Foundation, at mahigit 60k open-source na proyekto ang gumagamit nito.
Lokasyon
- AGENTS.md sa root ng repository, para sa buong proyekto.
- Mga nested na AGENTS.md sa mga subdirectory o package; ginagamit ng mga agent ang file na pinakamalapit sa kanila sa directory tree.
- OpenAI Codex: isang global na ~/.codex/AGENTS.override.md o, kung walang laman o wala ito, ~/.codex/AGENTS.md.
- Cline: isang global na ~/.agents/AGENTS.md.
- Tumatanggap din ang Claude Code ng .claude/AGENTS.md.
Format
Plain Markdown na walang frontmatter o kinakailangang field; puwedeng gumamit ng anumang heading. Walang itinakdang limitasyon sa laki ng format, pero hihinto ang OpenAI Codex sa pagbabasa kapag umabot na sa project_doc_max_bytes, na 32 KiB bilang default.
# 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.
Pagkakasunod-sunod at pagsasama
Mas sinusunod ang AGENTS.md na pinakamalapit sa file na ine-edit, at nangingibabaw ang tahasang instruction sa chat kaysa sa anumang file. Pinagdudugtong ng OpenAI Codex ang tig-isang file mula sa bawat directory, mula sa project root pababa hanggang sa working directory. Kaya nasa hulihan ang mas malalapit na file at mas mataas ang prayoridad ng mga ito. Bilang default, hindi binabasa ng Claude Code ang AGENTS.md kapag may CLAUDE.md.
Mga tool na nagbabasa nito
| Tool | Suporta |
|---|---|
| OpenAI Codex | Built-in. Nagbabasa ito ng global na file, pagkatapos ay hanggang tig-isang file mula sa bawat directory, mula sa root hanggang sa working directory. 32 KiB ang default na limitasyon. |
| Claude Code | Built-in mula v2.1.277, pero kung walang CLAUDE.md o CLAUDE.local.md lang. Maliban kung itakda sa claude-md-and-agents-md. |
| Cursor | Built-in; gumagana sa root at mga nested na directory. Isinasama ang mga nested na file sa mga parent file, at nangingibabaw ang mas espesipikong file. |
| GitHub Copilot (cloud agent, code review, VS Code) | Built-in saanman sa repository; nangingibabaw ang pinakamalapit na file. |
| Devin Desktop (formerly Windsurf) | Built-in. Laging ginagamit ang root file; nalalapat ang file sa isang subdirectory sa mismong directory na iyon. |
| Cline | Built-in, at tumatanggap din ng global na ~/.agents/AGENTS.md; i-on o i-off ito sa panel ng Rules. |
| Gemini CLI | Opsyonal: idagdag ang AGENTS.md sa context.fileName sa .gemini/settings.json. |
| Aider | Opsyonal: idagdag ang read: AGENTS.md sa .aider.conf.yml. |
| OpenClaw | Built-in bilang kinakailangang file ng mga operating instruction sa workspace ng agent. |
| Listed on agents.md (not individually re-verified) | Isa ito sa 23 tool sa listahan ng agents.md, kabilang ang Amp, Jules, Zed, Warp, goose, opencode at JetBrains Junie; hindi namin sinuri ang mga ito nang paisa-isa. |
Mga tip
- Pinapalitan ang pangalan ng lumang AGENT.md? Iminumungkahi ng agents.md ang mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md para patuloy na gumana ang dalawang pangalan.
- Ilista ang mga command para sa test at lint: sinusubukan ng mga agent na patakbuhin ang mga check na makita nila at ayusin ang mga error bago matapos.
- Sa monorepo, gumawa ng maikling AGENTS.md para sa bawat package sa halip na pahabain nang husto ang isang root file.
- Sa OpenAI Codex, mas mataas ang prayoridad ng AGENTS.override.md kaysa sa AGENTS.md sa parehong directory.
Bumuo ng AGENTS.md at mga katugmang rule file para sa limang tool gamit ang iisang form. Buksan ang AGENTS.md generator →