Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.devin.ai/llms.txt

Use this file to discover all available pages before exploring further.

Os arquivos AGENTS.md oferecem uma forma simples de fornecer ao Cascade instruções contextualizadas que são aplicadas automaticamente com base em onde o arquivo está localizado no seu projeto. Isso é particularmente útil para definir diretrizes de codificação específicas por diretório, decisões de arquitetura ou convenções do projeto.

Como funciona

Quando você cria um arquivo AGENTS.md (ou agents.md), o Devin Desktop o detecta automaticamente e o envia para o mesmo mecanismo de Rules usado por .devin/rules/ (e pelo .windsurf/rules/ legado) — mas com o modo de ativação inferido com base na localização do arquivo, em vez de frontmatter:
  • Diretório raiz: Tratado como uma regra always-on — todo o conteúdo é incluído no prompt do sistema do Cascade em cada mensagem.
  • Subdiretórios: Tratados como uma regra glob com um padrão gerado automaticamente de <directory>/** — o conteúdo é aplicado somente quando o Cascade lê ou edita arquivos dentro desse diretório.
Esse escopo baseado na localização torna o AGENTS.md ideal para fornecer orientações específicas sem sobrecarregar um único arquivo de configuração global.

Criando um arquivo AGENTS.md

Basta criar um arquivo chamado AGENTS.md ou agents.md no diretório desejado. O arquivo usa Markdown simples, sem exigir nenhum frontmatter especial.

Estrutura de exemplo

my-project/
├── AGENTS.md                    # Instruções globais para todo o projeto
├── frontend/
│   ├── AGENTS.md                # Instruções específicas para o código frontend
│   └── src/
│       └── components/
│           └── AGENTS.md        # Instruções específicas para os componentes
├── backend/
│   └── AGENTS.md                # Instruções específicas para o código backend
└── docs/
    └── AGENTS.md                # Instruções para a documentação

Conteúdo de exemplo

Aqui está um exemplo de arquivo AGENTS.md para um diretório de componentes em React:
# Component Guidelines

When working with components in this directory:

- Use functional components with hooks
- Follow the naming convention: ComponentName.tsx for components, useHookName.ts for hooks
- Each component should have a corresponding test file: ComponentName.test.tsx
- Use CSS modules for styling: ComponentName.module.css
- Export components as named exports, not default exports

## File Structure

Each component folder should contain:
- The main component file
- A test file
- A styles file (if needed)
- An index.ts for re-exports

Descoberta e escopo

O Devin Desktop detecta automaticamente arquivos AGENTS.md em todo o seu workspace:
  • Varredura do workspace: Todos os arquivos AGENTS.md no seu workspace e em seus subdiretórios são detectados
  • Suporte a repositórios Git: Em repositórios Git, o Devin Desktop também procura nos diretórios pai até a raiz do repositório
  • Sem diferenciar maiúsculas de minúsculas: Tanto AGENTS.md quanto agents.md são reconhecidos

Escopo automático

O principal benefício do AGENTS.md é o escopo automático com base na localização do arquivo:
Localização do arquivoEscopo
Raiz do workspaceAplica-se a todos os arquivos (sempre ativo)
/frontend/Aplica-se ao trabalhar com arquivos em /frontend/**
/frontend/components/Aplica-se ao trabalhar com arquivos em /frontend/components/**
Isso significa que você pode ter vários arquivos AGENTS.md em níveis diferentes, cada um fornecendo orientações cada vez mais específicas para os respectivos diretórios.

Melhores práticas

Para aproveitar ao máximo os arquivos AGENTS.md:
  • Mantenha as instruções focadas: Cada AGENTS.md deve conter instruções relevantes para a finalidade do diretório
  • Use formatação clara: Marcadores, cabeçalhos e blocos de código tornam as instruções mais fáceis para o Cascade seguir
  • Seja específico: Exemplos concretos e convenções explícitas funcionam melhor do que orientações vagas
  • Evite redundância: Não repita instruções globais em arquivos de subdiretórios; eles herdam essas instruções dos diretórios pai

Diretrizes de conteúdo

# Bom Exemplo
- Use TypeScript strict mode
- All API responses must include error handling
- Follow REST naming conventions for endpoints

# Exemplo Menos Eficaz
- Write good code
- Be careful with errors
- Use best practices

Comparação com Rules

Embora tanto AGENTS.md quanto Rules forneçam instruções para o Cascade, eles têm finalidades diferentes:
RecursoAGENTS.mdRules
LocalizaçãoNos diretórios do projeto.devin/rules/ (ou legado .windsurf/rules/) ou global
EscopoAutomático com base na localização do arquivoManual (glob, sempre ativo, decisão do modelo, manual)
FormatoMarkdown simplesMarkdown com frontmatter
Ideal paraConvenções específicas de diretórioRegras transversais, lógica de ativação complexa
Use AGENTS.md quando quiser instruções simples baseadas na localização. Use Rules quando precisar de mais controle sobre quando e como as instruções são aplicadas.