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)

Searching Database…

25K ·GitHub
Agents.md
这是什么？AGENTS.md 是一种简单、开放的 Markdown 格式，用于为 AI 编程代理提供项目专属的上下文和指令。它类似于 README，但专门面向代理编写。
这是需要安装的工具，还是只是一种 Markdown 约定？它不是需要安装的软件，而是一种纯 Markdown 文件约定。你只需把它添加到代码仓库中，编程代理就有了固定、专门的位置来读取项目上下文。
我该如何在项目中开始使用 AGENTS.md？在项目根目录创建一个 AGENTS.md 文件，参照仓库中展示的最简示例进行编写，并填入你希望代理遵循的上下文和指令。
采用 AGENTS.md 需要什么特殊工具吗？不需要。它只是一个纯 Markdown 文件，因此在项目中采用这一格式无需任何依赖或构建步骤。
这种格式是给谁用的？它面向使用 AI 编程代理的开发者和团队，让他们有一个标准化、可预期的地方来记录专门给这些代理的项目指令。
最简的 AGENTS.md 文件包含什么？仓库中的最简示例包含简单的上下文和指令两个部分，代理在处理代码库之前可以先阅读这些内容。
我能在本地预览项目的说明网站吗？可以。仓库中包含一个基础的 Next.js 网站，通过示例介绍项目目标。安装依赖并运行开发服务器，然后在浏览器中打开即可。
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