AGENTS.md
AGENTS.md is an open format: a plain Markdown file that gives coding agents the context and instructions for a project, described as a README for agents. The repository holds the format's README with a minimal sample, and a Next.js site with its own AGENTS.md.
- Kind
- Framework
- Works with
- Any agent
- Languages
- TypeScript / JavaScript
- Source
- AGENTS.md @ d001185d792e
- Path
- README.md
- License
- MIT
- Jobs
- Context management, Documentation
InstallCopy it from the source repository, or sign in and let the assistant adapt it for your project.
# AGENTS.md  [AGENTS.md](https://agents.md) is a simple, open format for guiding coding agents. Think of AGENTS.md as a README for agents: a dedicated, predictable place to provide context and instructions to help AI coding agents work on your project. Below is a minimal example of an AGENTS.md file: ```markdown # 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. …