agentleFS

AGENTS.md examples from real projects

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

Worked for most · soon
hyf0AGENTS.md

vue-skills

hyf0/vue-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:

1 project uses a version of this

3.2k10mo agoReviewMountCreate a free account to mount
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.