AGENTS.md - Простой, открытый формат для управления кодирующими агентами

AGENTS.md — это простой, открытый формат, предназначенный для управления кодирующими агентами, используемый более чем в 20 000 проектах с открытым исходным кодом. Он служит специальным пространством для предоставления контекста и инструкций, которые помогают AI-кодирующим агентам эффективно работать над проектами. Этот формат дополняет традиционные файлы README.md, сосредотачиваясь на конкретных потребностях кодирующих агентов.

1. Команды настройки

   • Установите зависимости: pnpm install
   • Запустите сервер разработки: pnpm dev
   • Запустите тесты: pnpm test

2. Рекомендации по стилю кода

   • Режим строгой типизации TypeScript
   • Одинарные кавычки, без точек с запятой
   • Предпочтение функциональным паттернам программирования

3. Совместимость агентов

   AGENTS.md работает без проблем с различными AI-кодирующими агентами, включая:

   Имя агента	Описание
   Codex	Утилита CLI общего назначения для AI-кодирующих агентов.
   Amp	AI-кодирующий агент от Google.
   Jules	Еще один AI-кодирующий агент от Google.
   Cursor	AI-инструмент для повышения продуктивности.
   Factory	Инструмент для создания и управления кодирующими агентами.
   Roo	AI-кодирующий помощник для различных задач программирования.
   CodeAider	AI-инструмент для помощи и генерации кода.
   Gemini CLI	Инструмент CLI от Google для задач программирования.
   Kilo Code	AI-кодирующий агент для оптимизированной разработки.
   OpenCode	Кодирующий агент с открытым исходным кодом для совместных проектов.
   Phoenix	AI-инструмент для повышения эффективности кодирования.
   Zed	AI-кодирующий помощник для различных языков программирования.

4. Вложенные файлы AGENTS.md

   Для больших монорепозиториев можно использовать вложенные файлы AGENTS.md в подпроектах, что позволяет предоставить индивидуальные инструкции для каждого пакета.

1. Создайте файл AGENTS.md в корне вашего репозитория.
2. Включите разделы, которые помогут агентам эффективно работать, такие как обзор проекта, команды сборки и инструкции по тестированию.
3. Добавьте любые дополнительные инструкции, относящиеся к новым участникам, такие как сообщения о коммитах и соображения по безопасности.
4. Для больших проектов используйте вложенные файлы AGENTS.md для конкретных под проектов, чтобы предоставить локализованное руководство.

Есть ли обязательные поля в AGENTS.md?

Нет, AGENTS.md гибок и может быть структурирован с использованием любых заголовков по мере необходимости. Агент будет анализировать предоставленный текст.

Что произойдет, если инструкции конфликтуют?

Ближайший файл AGENTS.md к редактируемому файлу имеет приоритет, в то время как явные пользовательские подсказки переопределят любые конфликтующие инструкции.

Будет ли агент автоматически выполнять команды тестирования?

Да, если команды тестирования указаны в AGENTS.md, агент попытается их выполнить и исправить любые ошибки.

Можно ли обновить AGENTS.md позже?

Абсолютно, AGENTS.md следует рассматривать как живую документацию, которую можно изменять по мере необходимости.

Данные о ценах пока недоступны; пожалуйста, посетите официальный сайт для получения дополнительной информации.

1. AGENTS.md эффективно предоставляет структурированный формат для кодирующих агентов, улучшая их способность понимать требования проекта и выполнять задачи эффективно.
2. Отделение от файлов README.md помогает поддерживать ясность для человеческих участников, предлагая при этом подробные рекомендации для AI-агентов.
3. Однако внедрение AGENTS.md может потребовать культурного сдвига в командах, привыкших к традиционным практикам документации.
4. В целом, AGENTS.md является ценным инструментом для разработчиков, стремящихся оптимизировать свои рабочие процессы с AI-кодирующими агентами, но его успех зависит от последовательного использования и обновлений.