AGENTS.md
AGENTS.md — a simple, open format for guiding coding agents. Create, share, and discover agent implementations across languages and frameworks.
What's AGENTS.md?
AGENTS.md is a dedicated file in your project root that guides AI coding agents with clear instructions and context about your codebase.
Markdown-Based Format
A simple, standardized markdown file that provides context and instructions to AI coding agents working on your project.
Project Context Hub
Centralized documentation for build steps, test commands, coding conventions, and project-specific guidance that agents need.
Wide Tool Support
Compatible with GitHub Copilot, Cursor, OpenAI Codex, Google Jules, Aider, and other major AI coding platforms.
Scalable Architecture
Support for nested AGENTS.md files in monorepos, allowing each subproject to provide tailored instructions to agents.
How to Set Up AGENTS.md
Create an effective AGENTS.md file with the best structure and configuration for AI coding tools.
Set Up Your File
Create an AGENTS.md file in your project root. Use plain Markdown with no required fields or strict formatting rules.
Structure Your Content
Include project overview, build commands, test instructions, coding conventions, and any project-specific context agents need.
Configure for Tools
AI tools like OpenAI Codex, GitHub Copilot, and Cursor automatically read AGENTS.md. No additional configuration needed.
AGENTS.md Structure
A standardized format for documenting your AI agents with all the essential information.
# Sample AGENTS.md file ## Dev environment tips - Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`. - Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint, and TypeScript can see it. - Use `pnpm create vite@latest <project_name> -- --template react-ts` to spin up a new React + Vite package with TypeScript checks ready. - Check the name field inside each package's package.json to confirm the right name—skip the top-level one. ## Testing instructions - Find the CI plan in the .github/workflows folder. - Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package. - From the package root you can just call `pnpm test`. The commit should pass all tests before you merge. - To focus on one step, add the Vitest pattern: `pnpm vitest run -t "<test name>"`. - Fix any test or type errors until the whole suite is green. - After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass. - Add or update tests for the code you change, even if nobody asked. ## PR instructions - Title format: [<project_name>] <Title> - Always run `pnpm lint` and `pnpm test` before committing.
Frequently Asked Questions
Common questions and answers about AGENTS.md
Ready to Start Documenting?
Join the community of developers standardizing AI agent documentation.