MD Reader

O que é um arquivo CLAUDE.md? O que ele faz e o que incluir

Atualizado:

Um arquivo CLAUDE.md é um arquivo de texto simples contendo instruções permanentes para o Claude Code, o agente de programação da Anthropic. O Claude Code o lê no início de cada sessão, evitando que você precise repetir seu comando de teste ou as regras do projeto todas as vezes.

Ele é escrito em markdown e não executa nada por conta própria, portanto abri-lo para leitura é seguro. Editá-lo é diferente: o agente agirá com base no que você alterar.

O que colocar nele

Não há um formato obrigatório. As linhas mais úteis são aquelas que o agente não consegue descobrir apenas lendo o seu código:

Um exemplo pequeno se parece com isto:

# CLAUDE.md

## Comandos
- Testar: npm test (execute isto antes de terminar)

## Regras
- Não edite arquivos em /generated
- Mantenha o texto voltado para o usuário em src/i18n

A documentação de memória da Anthropic sugere manter o arquivo abaixo de 200 linhas, pois arquivos mais longos consomem mais atenção do agente e passam a ser seguidos com menos confiabilidade.

Onde ele fica

Arquivo Usado para
CLAUDE.md na pasta principal do projeto Instruções para o projeto, geralmente compartilhadas via git
CLAUDE.md em uma subpasta Instruções lidas quando o agente trabalha nessa pasta
~/.claude/CLAUDE.md Suas preferências pessoais em todos os projetos
CLAUDE.local.md Suas anotações privadas para um projeto. Mantenha fora do git

Arquivos localizados nas pastas acima de onde você inicia o Claude Code também são carregados. Eles são combinados em vez de substituírem uns aos outros, portanto contradições podem confundir o agente.

Como criar um

No Claude Code, execute /init. Ele examinará seu projeto e elaborará um rascunho de arquivo com os comandos de compilação e as convenções que encontrar. Em seguida, adicione o que ele não conseguiu descobrir.

Você não precisa de um no primeiro dia. Um bom momento para começar é quando você corrige o mesmo erro duas vezes. Adicione uma linha e a próxima sessão já saberá.

O que ele não pode fazer

O Claude Code trata o arquivo como uma orientação, e não como uma regra rígida, portanto ele geralmente segue uma instrução, mas não é obrigado a isso. Se algo nunca deve acontecer, a Anthropic recomenda o uso de um gancho (hook), que a ferramenta aplica todas as vezes. Adicionar "IMPORTANTE" a uma linha raramente resolve o problema.

Não coloque senhas ou chaves de API nele. Os arquivos do projeto geralmente são enviados junto com o código, então qualquer pessoa que possa ver o projeto poderá lê-los.

CLAUDE.md e AGENTS.md

O AGENTS.md cumpre uma função semelhante para outras ferramentas, como o Codex, e o Claude Code também consegue ler um que já esteja no seu projeto. Nosso guia sobre os arquivos .md criados por agentes de programação explica os outros que você pode encontrar.

Como ler no celular

Quando aberto em um aplicativo de texto simples, o arquivo exibe os símbolos # e ** em formato bruto. Para lê-lo formatado no Android:

  1. Envie-o para o seu celular. O Claude Code geralmente roda em um computador, então use o Google Drive, um anexo de e-mail ou um cabo USB.
  2. Toque no arquivo e escolha MD Reader, ou use Abrir arquivo no aplicativo.

Disponível no Google Play

Títulos, tabelas e blocos de código aparecem formatados, e o Sumário permite alternar rapidamente entre as seções. Tags como <example>, que são comuns em arquivos de instrução, são exibidas exatamente como escritas em vez de desaparecerem. Para o Google Drive, veja como abrir arquivos .md do Google Drive.

O MD Reader não se conecta ao Claude Code nem sincroniza com o seu computador, portanto o que você está lendo é uma cópia. Envie-o novamente após alterações. Você pode tocar em Editar e alterar a cópia, mas o Claude Code não verá isso até que você envie o arquivo de volta para o seu computador.