AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

vuejs-ai Hiding risky files

vuejs-aiAGENTS.md

skills

vuejs-ai/skills/AGENTS.md

IMPORTANT: Never develop on main branch! - main is the publishing branch — it only contains released skills - dev is the development branch — all work happens here - Use the "Sync to Main" GitHub Action to publish changes from dev to main After completing any task, run: This ensures TypeScript types are correct before committing. Before sharing a Skill, verify: Following Anthropic's best practices:

Steady6 mentions in 2 weeks

1 project uses a version of this

3.1k9mo agoReviewMount

vuejs-aiAGENTS.md

vue-tui

vuejs-ai/vue-tui/AGENTS.md

- AGENTS.md is the source of truth. CLAUDE.md is a symlink to it. - Always use Vue's shallowRef over ref by default. Using ref requires a solid justification and a code comment explaining why deep reactivity is needed. - Always use defineComponent() to define components. Never use bare { setup() {} } objects — they lack component scope, so inject, watch, and onScopeDispose won't work correctly. - Vue SFCs must use <script setup> unless there's an explicit reason not to.…

36255d agoReviewMount

CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.