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 для передачи ИИ-агентам, которые пишут код, контекста и инструкций, специфичных для проекта. Он работает как README, но написан специально для агентов.
Это инструмент, который нужно установить, или просто соглашение о формате Markdown?Это не программа для установки, а соглашение о простом файле в формате Markdown, который вы добавляете в репозиторий, чтобы у ИИ-агентов для написания кода было предсказуемое, специально отведённое место для чтения контекста проекта.
Как начать использовать AGENTS.md в моём проекте?Создайте файл AGENTS.md в корне проекта по образцу минимального примера из репозитория и заполните его контекстом и инструкциями, которые агенты должны выполнять.
Нужны ли какие-то специальные инструменты, чтобы начать использовать AGENTS.md?Нет. Поскольку это обычный файл в формате Markdown, для внедрения формата в проект не требуются ни зависимости, ни шаги сборки.
Для кого предназначен этот формат?Он предназначен для разработчиков и команд, которые работают с ИИ-агентами для написания кода и хотят иметь стандартизированное, предсказуемое место для описания инструкций, специфичных для проекта, для этих агентов.
Что входит в минимальный файл 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