Resposta curta
AGENTS.md é um arquivo de instruções do projeto para o Codex. Ele informa a estrutura do repositório, comandos, testes, estilo de programação, regras de commit e preferências de colaboração.
Use-o para regras estáveis do projeto, não para tarefas pontuais. Coloque requisitos temporários na conversa atual.
O que incluir
- Como instalar dependências, iniciar o projeto e executar testes
- Comandos comuns de validação
- Estilo de programação e convenções de nomenclatura
- Diretórios que não devem ser alterados sem necessidade
- Verificações obrigatórias antes de concluir
- Preferências da equipe para comunicação e respostas
O que não incluir
- API Keys, tokens, senhas ou credenciais privadas
- Instruções de tarefas temporárias
- Contextos longos sobre o produto
- Prompts genéricos sem relação com o repositório
- Comandos e caminhos desatualizados
Estrutura sugerida
Erros comuns
- Transformar o
AGENTS.mdem um prompt universal muito longo. - Gravar segredos no arquivo.
- Esquecer de atualizá-lo quando os comandos do projeto mudam.
- Misturar o
AGENTS.mdcom oconfig.tomldo usuário. - Achar que as regras eliminam a necessidade de revisar diffs e testes.
Sobre a BetterToken
Mesmo quando uma equipe usa a BetterToken para unificar o roteamento de modelos, oAGENTS.md continua importante. A camada de API gerencia solicitações de modelo e registros de uso. O AGENTS.md gerencia o contexto do projeto e as normas de execução.
Use os dois para reduzir a confusão de configuração e o custo de colaboração.
Documentos relacionados
- O que é o Codex CLI?
- Como configurar o config.toml do Codex CLI
- O que são os modos de sandbox e aprovação do Codex CLI?
- O que é CLAUDE.md no Claude Code?