AGENTS.md generator
Punan ang isang form para makakuha ng AGENTS.md na naglalaman ng iyong mga command, convention at mahigpit na limitasyon. Makakakuha ka rin ng isang path-scoped rule na naka-format para sa Cursor, GitHub Copilot, Claude Code, Cline at Devin Desktop, pati na ng mga bridge file para sa mga tool na hindi awtomatikong nakakakita ng AGENTS.md.
Kung saan hinahanap ng bawat tool ang mga instruction file nito →
# Acme web app
Web app para sa mga customer, na may admin area at maliit na REST API.
## Stack
Next.js, React, TypeScript, pnpm
## Mga command
- Pag-install: `pnpm install`
- Patakbuhin nang lokal: `pnpm dev`
- Subukan: `pnpm test`
- Lint at type-check: `pnpm lint && pnpm tsc --noEmit`
- Build: `pnpm build`
## Estilo ng code
- Sundin ang formatting na ipinapatupad ng linter, at huwag baguhin ang mga file na hindi mo ginalaw.
- Mas piliin ang maliliit na function na malinaw ang input at output; panatilihin sa mga edge ang mga side effect.
- Magtanong muna bago magdagdag ng bagong dependency.
- Ipaliwanag sa mga comment kung bakit kailangan ang code na hindi agad malinaw, hindi kung ano ang ginagawa ng bawat linya.
## Pagsubok
- Magdagdag o mag-update ng test para sa bawat behavior na babaguhin mo.
- Patakbuhin ang test command at ayusin ang mga failure bago sabihing tapos ka na.
- Huwag mag-delete o mag-skip ng bumabagsak na test para lang pumasa ang buong test suite.
## Mga commit at pull request
- Gumamit ng pandiwang pautos sa mga commit subject, at panatilihin itong wala pang 72 character.
- Isang pagbabago lang ang ilagay sa bawat pull request at sabihin sa description kung paano mo ito sinubukan.
- Patakbuhin ang lint at mga test bago ang bawat commit.
## Huwag kailanman
- Huwag kailanman mag-commit ng mga secret, API key o .env file.
- Huwag kailanman mano-manong i-edit ang mga generated file sa ilalim ng src/generated/; i-regenerate ang mga ito.
- Huwag kailanman magpatakbo ng mga mapanirang database command sa production.
- Huwag kailanman mag-force-push sa main o mag-rewrite ng shared history.
Iisang rule para sa limang tool
---
description: Mga convention para sa mga file na tumutugma sa glob na ito
globs: app/**/*.tsx
alwaysApply: false
---
Sundin ang mga pattern na ginagamit na ng mga katabing file sa folder na ito. Dapat may docstring at test sa katugmang test file ang bawat exported function.
---
applyTo: "app/**/*.tsx"
---
Sundin ang mga pattern na ginagamit na ng mga katabing file sa folder na ito. Dapat may docstring at test sa katugmang test file ang bawat exported function.
---
paths:
- "app/**/*.tsx"
---
Sundin ang mga pattern na ginagamit na ng mga katabing file sa folder na ito. Dapat may docstring at test sa katugmang test file ang bawat exported function.
---
paths:
- "app/**/*.tsx"
---
Sundin ang mga pattern na ginagamit na ng mga katabing file sa folder na ito. Dapat may docstring at test sa katugmang test file ang bawat exported function.
---
trigger: glob
globs: app/**/*.tsx
---
Sundin ang mga pattern na ginagamit na ng mga katabing file sa folder na ito. Dapat may docstring at test sa katugmang test file ang bawat exported function.
Ano ang nagpapabisa sa isang instruction file
Ilagay sa unahan ang mga eksaktong command
Ilista agad sa simula ng file ang mga totoong command para sa pag-install, pag-test at lint, kasama ang mga flag. Tukuyin nang eksakto ang stack at mga bersyon, at magpakita ng maikling code sample kung malabo ang paliwanag sa salita.
Magbigay ng malinaw na mga ipinagbabawal na gawain
Sabihin nang direkta kung ano ang hindi dapat gawin ng agent, gaya ng pakikialam sa mga secret, vendored code o production. Ang pinakakaraniwang kapaki-pakinabang na limitasyong nakita sa mga file na sinuri ng GitHub ay huwag kailanman mag-commit ng mga secret.
Gawing mabe-verify ang bawat instruction
Mabe-verify ang “Patakbuhin ang npm test bago mag-commit”; hindi mabe-verify ang “I-test ang mga pagbabago mo”. Alisin ang mga magkasalungat na instruction, dahil maaaring sundin ng model ang alinman sa dalawang linyang hindi magkatugma.
Panatilihing maikli at hatiin ayon sa path
Iminumungkahi ng Anthropic na huwag lumampas sa 200 linya bawat file, at ng Cursor na huwag lumampas sa 500 bawat rule. Ilipat ang mga gabay para sa isang partikular na bahagi sa isang rule na may saklaw na path para lang ito ma-load kapag may kinalaman ang mga file na iyon. Nakakatulong ang mga import na ayusin ang file, pero hindi nito binabawasan ang gastos sa context.
Huwag isama ang alam na ng agent
Sa isang pag-aaral ng apat na coding agent, hindi palaging nagpapataas ng tagumpay sa mga gawain ang mga context file, at nagdagdag ang mga ito ng mahigit 20% sa gastos sa inference. Bahagyang nakabawas sa performance ang mga file na isinulat ng LLM, at hindi nakatulong ang mga pangkalahatang-ideya ng repository. Kaya limitahan ang file sa mga requirement na hindi agad halata, gaya ng mga partikular na tool.
Magdagdag ng mga rule kapag paulit-ulit ang mga pagkakamali
Magsimula sa kaunti at magdagdag ng linya kapag nakita mong nagawa ng agent ang parehong pagkakamali nang mahigit isang beses. Ituro ang isang umiiral na file bilang halimbawa sa halip na mag-paste ng buong style guide.
Mga tanong tungkol sa AGENTS.md
Binabasa ba ng Claude Code ang AGENTS.md?
Oo, mula sa v2.1.277. Bilang default, binabasa lang nito ang AGENTS.md o .claude/AGENTS.md kapag walang CLAUDE.md, .claude/CLAUDE.md o CLAUDE.local.md sa working directory o sa mas mataas na directory. Ilo-load ng setting na claude-md-and-agents-md ang pareho, at gagana sa lahat ng bersyon ang CLAUDE.md na may @AGENTS.md.
Kailangan ba ng frontmatter o mga partikular na heading ang AGENTS.md?
Hindi. Plain Markdown ang AGENTS.md na walang kailangang field, at puwede kang gumamit ng anumang heading. Iminumungkahi ng site na agents.md ang mga seksyong gaya ng pangkalahatang-ideya ng proyekto, mga command para sa build at test, estilo ng code, testing, mga tala tungkol sa seguridad at mga gabay para sa pull request.
Paano ko gagamitin ang AGENTS.md sa isang monorepo?
Maglagay ng isang AGENTS.md sa root at ng isa pa sa loob ng bawat package na nangangailangan ng sarili nitong mga rule. Binabasa ng mga agent ang file na pinakamalapit sa ine-edit na code, at iyon ang masusunod kapag may salungatan. May 88 nito ang pangunahing repository ng OpenAI noong idokumento ito ng agents.md.
Paano ko itatakda sa Gemini CLI na basahin ang AGENTS.md?
GEMINI.md pa rin ang default na binabasa ng Gemini CLI. Idagdag ang AGENTS.md sa context.fileName sa .gemini/settings.json, halimbawa ["AGENTS.md", "GEMINI.md"]. Patakbuhin ang /memory show para tingnan kung ano ang na-load.
Aling mga coding agent ang sumusuporta sa AGENTS.md?
Sinuri namin ang docs ng OpenAI Codex, Claude Code, Cursor, GitHub Copilot, Devin Desktop, Cline at OpenClaw, na lahat ay nakakabasa nito nang native. Kailangan naman ng isang linya ng config para sa Gemini CLI at Aider. Ayon sa site ng agents.md, may kabuuang 23 compatible na tool, kabilang ang Zed, Warp, goose, opencode, Jules at JetBrains Junie.
Sino ang nangangasiwa sa format na AGENTS.md?
Iniambag ng OpenAI ang AGENTS.md sa Agentic AI Foundation, isang directed fund ng Linux Foundation na inanunsyo noong 2025-12-09 kasama ng MCP at goose. Ayon sa site ng agents.md, mahigit 60k open-source na proyekto ang gumagamit nito.