agentleFS
Sign inSign up

AGENTS.md examples from real projects

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

Most stars firstWorked for most · soon
OpenAIAGENTS.md

codex

openai/codex/AGENTS.md

In the codex-rs folder where the rust code lives: - Crate names are prefixed with codex-. For example, the core folder's crate is named codex-core - When using format! and you can inline variables into {}, always do that. - Install any commands the repo relies on (for example just, rg, or cargo-insta) if they aren't already available before running instructions here. - Never add or modify any code related to CODEXSANDBOXNETWORKDISABLEDENVVAR or CODEXSANDBOXENVVAR. - You operate in a sandbox…

127k4mo agoDiscuss
OpenAIAGENTS.md

codex / bottom_pane

openai/codex/codex-rs/tui/src/bottom_pane/AGENTS.md

When changing the paste-burst or chat-composer state machines in this folder, keep the docs in sync: - Update the relevant module docs (chatcomposer.rs and/or pasteburst.rs) so they remain a readable, top-down explanation of the current behavior. - Keep implementations/docstrings aligned unless a divergence is intentional and documented. Practical check: - After edits, sanity-check that docs mention only APIs/behavior that exist in code (especially the Enter/newline paths and disablepasteburst semantics).

127k4mo agoDiscuss

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.