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

studyzy 1k+ stars Hiding risky files

studyzyAGENTS.md

OpenSpec-cn / test

studyzy/OpenSpec-cn/test/AGENTS.md

Applies to tests under test/. Path identity is a recurring CI failure mode: Windows short/long paths, symlink or junction aliases, and case-insensitive file systems can spell the same existing directory differently. When asserting existing filesystem paths as identities, canonicalize both actual and expected paths first. Prefer FileSystemUtils.canonicalizeExistingPath() in project code and fs.realpathSync.native() in test-only expectations. Add an alias-path regression when touching path identity logic. If preserving user-typed path spelling is intentional, assert it separately from identity comparisons.

Steady24 mentions in 2 weeks

1 project uses a version of this

1.2k2mo 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.