agents.md README

The project's README from github.com/agentsmd/agents.md. As one markdown file: README.md.

AGENTS.md

AGENTS.md logo

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:

# 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.

Website

This repository also includes a basic Next.js website hosted at https://agents.md/ that explains the project’s goals in a simple way, and featuring some examples.

Running the app locally

  1. Install dependencies:
    pnpm install
  2. Start the development server:
    pnpm run dev
  3. Open your browser and go to http://localhost:3000

agents.md (agentsmd/agents.md)

standards
Searching Database…

25K ·GitHub
Agents.md
What is this?AGENTS.md is a simple, open Markdown format for giving AI coding agents project-specific context and instructions, functioning like a README but written specifically for agents.
Is this a tool I install, or just a markdown convention?It is not software to install — it is a plain Markdown file convention you add to your repo so coding agents have a predictable, dedicated place to read project context.
How do I start using AGENTS.md in my project?Create an AGENTS.md file at the root of your project following the minimal example shown in the repo, filling it with the context and instructions you want agents to follow.
Do I need any special tooling to adopt AGENTS.md?No — since it is just a plain Markdown file, there are no dependencies or build steps required to adopt the format in a project.
Who is this format meant for?It is meant for developers and teams who work with AI coding agents and want a standardized, predictable place to document project-specific instructions for those agents.
What does a minimal AGENTS.md file contain?The repo shows a minimal example with simple context and instruction sections that agents can read before working on the codebase.
Can I preview the project's explainer website locally?Yes — the repo includes a basic Next.js site explaining the project's goals with examples; install dependencies and run the dev server, then open it in your browser.
What are similar projects?open-knowledge-format, pi-shadow-mind, agentskills, design, OpenSpec, qwen-code, OpenIntelligentUI, spec
Which topics is it in?spec, readme, standards, specification, coding-agents, nextjs, agents, documentation, coding-agent, markdown, ai-agent, agent
Creator
agentsmd
Size
2.1 MB
Stars
25K
Updated
CommitSep 10
Age
1y
Commits · 90 Days