O que é um arquivo de instrução de agente
Um arquivo de instrução de agente fica na raiz do repositório e orienta a ferramenta de código sobre como trabalhar no projeto. O AGENTS.md é o formato aberto, e o CLAUDE.md e o GEMINI.md são os nomes lidos por ferramentas específicas.
O conteúdo vale para toda sessão do agente no repositório e complementa o README. Ele informa o que o projeto é, como validar uma mudança e quais arquivos exigem cuidado.
O que cabe no arquivo
O arquivo reúne os comandos de instalação, teste e build, as convenções de nome e de pasta e os caminhos que exigem cuidado. Também lista as etapas de validação antes de concluir a tarefa.
Também cabe a indicação de onde buscar a documentação de cada área, com o link para o arquivo real. O agente usa essa referência para carregar a parte que importa na tarefa em andamento.
O que não cabe
O arquivo não recebe credencial nem informação sensível. Histórico de conversa e anotação temporária ficam fora, e uma instrução que ninguém consegue verificar também não pertence ao repositório.
O README apresenta o projeto para novos integrantes. O arquivo de instrução define como o agente deve operar, e os dois podem repetir comandos sem duplicar a explicação completa.
Exemplo
Como conferir
Execute os comandos publicados no arquivo e confira se eles funcionam na versão atual do repositório. Compare os caminhos citados com a árvore real e retire a instrução que não pode ser verificada.
O contexto do agente cresce com o repositório, e a memória da sessão não substitui a instrução escrita. A documentação de cada área continua sendo a fonte para o detalhe.
Dúvidas frequentes
Perguntas frequentes sobre Arquivo de instrução de agente
- AGENTS.md, CLAUDE.md e GEMINI.md fazem a mesma coisa?
- Os três orientam a ferramenta de código no repositório. AGENTS.md é um formato aberto, e CLAUDE.md e GEMINI.md são lidos por ferramentas específicas. O conteúdo pode ser o mesmo.
- O arquivo substitui o README?
- Não. O README apresenta o projeto para novos integrantes. O arquivo de instrução define como o agente deve operar. A orientação cobre comandos e limites, além das etapas de validação.
- Posso colocar credencial no arquivo?
- Não. O arquivo fica no repositório e pode ser lido por qualquer pessoa com acesso. Chaves e tokens ficam em variável de ambiente ou em um cofre.
- Como saber se a instrução está correta?
- Execute os comandos publicados e confira os caminhos citados na árvore real. A instrução que não pode ser verificada no repositório precisa ser corrigida ou removida.
Para continuar
Recursos relacionados
Documentação
AGENTS.md
Apresenta o formato aberto e exemplos de instrução para agentes de código.
Abrir recursoDocumentação
Claude Code: memória do projeto
Explica como o CLAUDE.md é lido e como as instruções do projeto são carregadas.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
Na Formação Vibe Coding, o arquivo de instrução orienta o agente sobre o comando de teste e os caminhos que ele pode alterar.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.