AGENTS.md
A README for agents: one predictable file that gives coding agents the build steps, tests and conventions of a project.
About AGENTS.md
Think of AGENTS.md as a README for agents: a dedicated, predictable place to provide the context and instructions to help AI coding agents work on your project. It complements README files with the detailed context coding agents need, such as build steps, tests and code conventions, that would clutter a README or is not relevant to human contributors. The format is stewarded by the Agentic AI Foundation under the Linux Foundation, and the site lists support from OpenAI Codex, Google Gemini CLI, Cursor, GitHub Copilot Coding Agent, Zed, Warp, VS Code, Devin, Windsurf and many more. Details were read from the publisher’s repository and documentation; nothing was installed or executed.
What you can do
- Project context for coding agents
- Build and test instructions
- Code conventions
Rules file
- Format
- Instruction file (CLAUDE.md, AGENTS.md, .cursorrules or similar)
- Works with
- OpenAI Codex, Google Gemini CLI, Cursor, GitHub Copilot, Zed, Warp, VS Code, Devin, Windsurf, Aider, goose, opencode
- License
- Not specified
How to install
From the publisher
Create an AGENTS.md file at the root of your repository with build steps, test commands and conventions. Supporting agents read it automatically.
How do I use AGENTS.md?
The publisher’s steps are shown above. Copy the file into the place your agent reads: CLAUDE.md or AGENTS.md at the repository root, .cursorrules or .cursor/rules/ for Cursor, .github/copilot-instructions.md for GitHub Copilot. Then edit it for your project.
Which agents read AGENTS.md?
The publisher lists OpenAI Codex, Google Gemini CLI, Cursor, GitHub Copilot, Zed, Warp, VS Code, Devin, Windsurf, Aider, goose, opencode.
Is it free?
Open source; free to run yourself.
Questions and answers
What is AGENTS.md?
AGENTS.md is a rules file in the Developer tools category. A README for agents: one predictable file that gives coding agents the build steps, tests and conventions of a project.
How do I use AGENTS.md?
Copy the file into the place your agent reads: CLAUDE.md or AGENTS.md at the repository root, .cursorrules or .cursor/rules/ for Cursor, .github/copilot-instructions.md for GitHub Copilot. Then edit it for your project. The publisher's steps: Create an AGENTS.md file at the root of your repository with build steps, test commands and conventions. Supporting agents read it automatically.
Is AGENTS.md free?
Open source; free to run yourself.
What can AGENTS.md do?
According to the published details: Project context for coding agents; Build and test instructions; Code conventions.
Which agents or platforms work with AGENTS.md?
The publisher lists OpenAI Codex, Google Gemini CLI, Cursor, GitHub Copilot, Zed, Warp, VS Code, Devin, Windsurf, Aider, goose, opencode.
Where is AGENTS.md published?
Its homepage is https://agents.md/ and its source repository is https://github.com/agentsmd/agents.md. RUAGENTIC read these details from Publisher repository on October 1, 2026 and did not install or run the project.
Sources and checks
View the sourceSource information collected October 1, 2026.
Badge and embed
Show this listing on your website or README. The badge and the card link back to this page.
[](https://ruagentic.com/tools/agents-md)<a href="https://ruagentic.com/tools/agents-md"><img src="https://ruagentic.com/badge/agents-md.svg" alt="Listed on RUAGENTIC" height="28"></a>[](https://ruagentic.com/tools/agents-md)<iframe src="https://ruagentic.com/embed/agents-md" width="480" height="150" style="border:0;max-width:100%" loading="lazy" title="AGENTS.md on RUAGENTIC"></iframe>