AGENTS.md

What it does

A simple open format for giving coding agents project instructions: one AGENTS.md markdown file in your repo with setup commands, test steps and code style. It is now stewarded by the Agentic AI Foundation under the Linux Foundation, and the agents.md site lists many tools that read it, including Codex, Cursor, goose, OpenCode, Aider, Zed, Kilo Code and GitHub Copilot's coding agent. The site and repo are MIT licensed.

Who it's for

Anyone who uses more than one coding agent and wants a single instructions file they all understand.

How to set it up

1. Create AGENTS.md at the root of your repo:

   markdownCopy

   # AGENTS.md
   
   ## Setup commands
   - Install deps: `pnpm install`
   - Start dev server: `pnpm dev`
   - Run tests: `pnpm test`
   
   ## Code style
   - TypeScript strict mode
   - Single quotes, no semicolons

2. Add sections for testing and PR rules. Keep it short and specific: exact commands work better than general advice.

3. Commit it. Agents that support the format read it automatically when they work in the repo.

Check the official AGENTS.md docs for the latest steps.

Example prompts

Read this repo and write an AGENTS.md with the real setup, test and lint commands.

Update AGENTS.md so agents always run the type checker before committing.

Compare our CLAUDE.md and AGENTS.md and merge them into one AGENTS.md.

Demo