Pular para o conteúdo principal
Kodus pode sincronizar e importar automaticamente seus arquivos de regras da IDE existentes para aprimorar o code review de Kody com os padrões e preferências de codificação estabelecidos pela sua equipe.

O Que é Detecção de Arquivos de Regras?

A Detecção de Arquivos de Regras detecta e importa automaticamente arquivos de configuração de ferramentas e assistentes de codificação com IA populares no seu repositório. Isso garante que Kody entenda e respeite seus padrões de codificação existentes sem necessidade de configuração manual.

Arquivos de Regras Suportados

Kodus detecta e importa automaticamente os seguintes padrões de arquivos de regras:

Cursor

  • .cursorrules - Arquivo principal de regras do Cursor (legado)
  • .cursor/rules/**/*.mdc - Regras do Cursor em subdiretórios

GitHub Copilot

  • .github/copilot-instructions.md - Instruções do Copilot
  • .github/instructions/**/*.instructions.md - Arquivos de instrução detalhados

Agentic (convenção agents.md)

  • AGENTS.md - O arquivo padrão de-facto de orientação para agentes
  • .agents.md / .agent.md - Variantes dotfile

Claude

  • CLAUDE.md - Regras específicas do Claude
  • .claude/settings.json - Configurações do Claude

Windsurf

  • .windsurfrules - Regras da IDE Windsurf

Sourcegraph Cody

  • .sourcegraph/**/*.rule.md - Arquivos de regras do Cody

OpenCode

  • .opencode.json - Configuração do OpenCode

Aider

  • .aider.conf.yml - Configuração do Aider
  • .aiderignore - Padrões de ignore do Aider

Regras Genéricas/Internas

  • .rules/**/* - Diretório de regras genéricas
  • .kody/rules/** e rules/**/*.md - Regras específicas do Kody (veja Regras de Repositório — importadas verbatim, sem reescrita por LLM)
  • docs/coding-standards/**/* - Padrões de codificação baseados em documentação

Detalhes da detecção

  • Arquivos aninhados são descobertos. Todos os padrões acima são casados na raiz do repositório e em qualquer subdiretório. Um services/billing/CLAUDE.md é importado e automaticamente escopado para services/billing/** — arquivos de orientação por diretório (convenção comum em monorepos) funcionam sem configuração.
  • O matching é case-insensitive. claude.md e CLAUDE.md são equivalentes.
  • Referências @arquivo são seguidas. Se um arquivo de regra referencia outro com a convenção @ (ex: @AGENTS.md dentro do CLAUDE.md), o conteúdo do arquivo referenciado é buscado e incluído na importação (um nível de profundidade, até 5 referências por arquivo, 100KB por arquivo referenciado).
  • Múltiplos globs por regra são suportados. Um path como app/**/*.rb,lib/**/*.rb (ou uma lista path: [] no frontmatter de Regras de Repositório) aplica a regra a arquivos que casem com qualquer um dos globs.

Como Funciona

Configuração Inicial

  1. Habilitar Sincronização Automática: Alterne a opção “Sincronizar automaticamente regras do repositório” nas suas configurações
  2. Modal de Primeira Sincronização: Um modal aparecerá perguntando se você deseja sincronizar pela primeira vez
  3. Varredura do Repositório: Quando você confirmar, Kodus varre todo o seu repositório em busca de arquivos de regras suportados
  4. Geração de Regras: Um LLM processa os arquivos encontrados e cria automaticamente as Kody Rules correspondentes. Exceção: arquivos de template .kody/rules/** e rules/**/*.md são importados verbatim — sem conversão por LLM — preservando instruções, exemplos e identificadores exatamente como escritos.
Cada arquivo importado produz uma Kody Rule. Se um arquivo contém várias diretrizes distintas, o LLM as mescla em uma única regra abrangente — divida a orientação em múltiplos arquivos quando quiser regras gerenciáveis de forma independente.

Sincronização Contínua

  • Atualizações Automáticas: A sincronização acontece automaticamente quando um Pull Request é fechado
  • Alterações de Arquivo Detectadas:
    • Novos arquivos de regras → Cria novas Kody Rules
    • Arquivos de regras modificados → Atualiza Kody Rules existentes
    • Arquivos de regras excluídos → Remove as Kody Rules correspondentes

Sincronização Manual (Toggle Desabilitado)

Você pode sincronizar arquivos de regras individuais sem habilitar a sincronização automática:
  1. Adicione @kody-sync em qualquer lugar no seu arquivo de regra
  2. Faça commit da alteração
  3. Kody sincronizará apenas aquele arquivo específico
Isso permite sincronizar regras seletivamente sem habilitar a sincronização automática para todos os arquivos.
Se você editar manualmente uma Kody Rule que foi criada a partir de um arquivo de regra da IDE, suas alterações serão sobrescritas na próxima vez que o arquivo correspondente for modificado e sincronizado.

Verificando sincronização e avaliação de regras (self-hosted)

Em deployments self-hosted, os logs da API carregam marcadores grep-áveis para debug:
  • [kody-rules-sync] — sumário por execução de sync: quais arquivos foram importados, pulados (com o motivo) ou removidos.
  • [kody-rules-eval] — trace de avaliação por arquivo durante um review: exatamente quais regras (uuid + título) foram selecionadas para o prompt de cada arquivo revisado.
docker logs kodus_api 2>&1 | grep "kody-rules-sync"
docker logs kodus_api 2>&1 | grep "kody-rules-eval"
Se uma regra aparece como ativa na UI mas nunca aparece em [kody-rules-eval] para os arquivos esperados, verifique o glob do campo Path — uma regra só roda em arquivos que casam com o path.

Limites de regras

Instâncias self-hosted rodando sem licença válida (Community Edition) avaliam no máximo 10 regras por review (as mais antigas primeiro). Instâncias self-hosted licenciadas e cloud não têm esse limite. Se regras além da 10ª silenciosamente não disparam numa instância sem licença, esse limite é o motivo.