What is AGENTS.md?
AGENTS.md is an open format for telling coding agents how to work in your repository: setup, commands, code style and rules. Codex reads it before every task, and so do Cursor, Jules and other agents. This AGENTS.md generator writes one from a few choices so every agent follows the same rules.
How to use the AGENTS.md generator
Pick your stack
Choose your framework, styling, language, package manager and test tool above.
Copy the file
Copy the generated AGENTS.md and commit it at the root of your repository.
Add nested files if needed
In a monorepo, add an AGENTS.md inside a package for rules that only apply there.
Run a task
Give Codex a task; it reads AGENTS.md before it starts working.
Why AGENTS.md exists
README files are written for people. AGENTS.md is written for agents: the commands to run, the checks that must pass and the rules to follow, in one predictable place. Because it is an open format, one file serves several tools instead of a separate rules file for each.
Agents read the AGENTS.md closest to the file they are editing, so a monorepo can have one at the root and more specific ones in each package. The nearest file wins when rules conflict.
AGENTS.md vs CLAUDE.md
They do the same job for different tools. Claude Code reads CLAUDE.md; Codex, Cursor and many other agents read AGENTS.md. If your team uses both, keep the rules in AGENTS.md and point CLAUDE.md at it, or generate both from the same choices on this site.
What makes a good AGENTS.md
Checks that define done
Say which build, lint and test commands must pass before a task is finished.
Clear boundaries
Name folders and files agents must not change.
One design source
Point at the design file so UI tasks come back consistent.
Short sections
Agents read it every task; headings and short lists work best.
Common mistakes
Copying the README
Installation stories and badges waste context. Keep only what an agent acts on.
No test command
Without one, agents cannot check their own work.
Rules in many places
Keep shared rules in AGENTS.md and avoid repeating them in every tool's file.
Design templates for Codex
The generated file points Codex at design/template.html. Save one of these templates there and every page it builds follows the same design.
Frequently asked questions
Which tools read AGENTS.md?
OpenAI Codex, Cursor, Google Jules, Amp, Factory and a growing list of coding agents. Gemini CLI can be set to read it too.
Is this AGENTS.md generator free?
Yes. The generated file is free to copy. The full design rules template on the AGENTS.md page comes with a BrowserMoon licence.
Where does AGENTS.md go?
At the root of your repository. You can add more inside subfolders; agents use the closest one.
Does Claude Code read AGENTS.md?
Claude Code reads CLAUDE.md. Use the CLAUDE.md generator on this site, or reference AGENTS.md from your CLAUDE.md.
How long should AGENTS.md be?
Short enough to read in full every task, usually under 100 lines.
Should AGENTS.md be committed?
Yes. It belongs in version control so every agent and teammate uses the same rules.
More free generators
Related