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

uxjulia Hiding risky files

uxjuliaAGENTS.md

CrossInk

uxjulia/CrossInk/AGENTS.md

This is the canonical repo instruction file. CLAUDE.md should point here so Codex and Claude read the same guidance. Project: Open-source e-reader firmware for ESP32-C3 and ESP32-S3 devices. Start narrow. Read the named entry point and its direct collaborators before scanning a whole subsystem; rg exact symbols and rg --files <directory> are the default discovery tools. The repository is intentionally split between application policy here and reusable hardware/UI implementation in the nested SDK.

No other project uses it yet

1.7k5mo 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.