AGENTS.md - Um formato simples e aberto para orientar agentes de codificação

AGENTS.md é um formato simples e aberto projetado para guiar agentes de codificação, utilizado por mais de 20.000 projetos de código aberto. Ele serve como um espaço dedicado para fornecer contexto e instruções que ajudam os agentes de codificação de IA a trabalhar efetivamente em projetos. Este formato complementa os arquivos README.md tradicionais, focando nas necessidades específicas dos agentes de codificação.

1. Comandos de Configuração

   • Instalar dependências: pnpm install
   • Iniciar o servidor de desenvolvimento: pnpm dev
   • Executar testes: pnpm test

2. Diretrizes de Estilo de Código

   • Modo estrito do TypeScript
   • Aspas simples, sem ponto e vírgula
   • Preferência por padrões de programação funcional

3. Compatibilidade com Agentes

   AGENTS.md funciona perfeitamente com vários agentes de codificação de IA, incluindo:

   Nome do Agente	Descrição
   Codex	Ferramenta CLI de uso geral para agentes de codificação de IA.
   Amp	Agente de codificação de IA do Google.
   Jules	Outro agente de codificação de IA do Google.
   Cursor	Ferramenta de codificação de IA para produtividade aprimorada.
   Factory	Ferramenta para construir e gerenciar agentes de codificação.
   Roo	Assistente de codificação de IA para várias tarefas de programação.
   CodeAider	Ferramenta de IA para assistência e geração de código.
   Gemini CLI	Ferramenta CLI do Google para tarefas de codificação.
   Kilo Code	Agente de codificação de IA para desenvolvimento simplificado.
   OpenCode	Agente de codificação de código aberto para projetos colaborativos.
   Phoenix	Ferramenta de IA para aumentar a eficiência de codificação.
   Zed	Assistente de codificação de IA para várias linguagens de programação.

4. Arquivos AGENTS.md Aninhados

   Para grandes monorepos, arquivos AGENTS.md aninhados podem ser usados dentro de subprojetos, permitindo instruções personalizadas para cada pacote.

1. Crie um arquivo AGENTS.md na raiz do seu repositório.
2. Inclua seções que ajudem os agentes a trabalhar efetivamente, como visão geral do projeto, comandos de construção e instruções de teste.
3. Adicione quaisquer instruções adicionais relevantes para novos colaboradores, como mensagens de commit e considerações de segurança.
4. Para grandes projetos, utilize arquivos AGENTS.md aninhados para subprojetos específicos para fornecer orientações localizadas.

Existem campos obrigatórios no AGENTS.md?

Não, AGENTS.md é flexível e pode ser estruturado usando quaisquer cabeçalhos conforme necessário. O agente irá analisar o texto fornecido.

O que acontece se as instruções entrarem em conflito?

O arquivo AGENTS.md mais próximo do arquivo editado tem precedência, enquanto prompts de usuário explícitos substituirão quaisquer instruções conflitantes.

O agente executará comandos de teste automaticamente?

Sim, se os comandos de teste estiverem listados no AGENTS.md, o agente tentará executá-los e corrigir quaisquer falhas.

O AGENTS.md pode ser atualizado posteriormente?

Absolutamente, AGENTS.md deve ser tratado como documentação viva que pode ser modificada conforme necessário.

Os dados de preços ainda não estão disponíveis; por favor, visite o site oficial para mais informações.

1. AGENTS.md fornece efetivamente um formato estruturado para agentes de codificação, aprimorando sua capacidade de entender os requisitos do projeto e executar tarefas de forma eficiente.
2. A separação dos arquivos README.md ajuda a manter a clareza para colaboradores humanos, enquanto oferece orientações detalhadas para agentes de IA.
3. No entanto, a adoção do AGENTS.md pode exigir uma mudança cultural dentro das equipes que estão acostumadas a práticas tradicionais de documentação.
4. No geral, AGENTS.md é uma ferramenta valiosa para desenvolvedores que buscam otimizar seus fluxos de trabalho com agentes de codificação de IA, mas seu sucesso depende do uso consistente e das atualizações.