Regras Personalizadas

As regras personalizadas fornecem uma maneira poderosa de definir comportamentos e restrições específicos do projeto e globais para o agente de IA do AI Cockpit Reasoning. Com regras personalizadas, você pode garantir uma formatação consistente, restringir o acesso a arquivos sensíveis, impor padrões de codificação e personalizar o comportamento da IA para as necessidades específicas do seu projeto ou em todos os projetos.

Visão Geral

As regras personalizadas permitem que você crie instruções baseadas em texto que todos os modelos de IA seguirão ao interagir com o seu projeto. Essas regras atuam como barreiras de proteção e convenções que são consistentemente respeitadas em todas as interações com sua base de código. As regras podem ser gerenciadas tanto pelo sistema de arquivos quanto pela interface de usuário integrada.

Formato da Regra

As regras personalizadas podem ser escritas em texto simples, mas o formato Markdown é recomendado para uma melhor estrutura e compreensão pelos modelos de IA. A natureza estruturada do Markdown ajuda os modelos a analisar e entender suas regras de forma mais eficaz.

• Use cabeçalhos Markdown (#, ##, etc.) para definir categorias de regras
• Use listas (-, *) para enumerar itens ou restrições específicas
• Use blocos de código ( ) para incluir exemplos de código quando necessário

Tipos de Regra

O AI Cockpit Reasoning suporta dois tipos de regras personalizadas:

• Regras de Projeto: Aplicam-se apenas ao espaço de trabalho do projeto atual
• Regras Globais: Aplicam-se a todos os projetos e espaços de trabalho

Suporte da UI

A UI de gerenciamento de regras integrada está disponível apenas para regras gerais. As regras específicas do modo devem ser gerenciadas através do sistema de arquivos.

Localização da Regra

Regras de Projeto

As regras personalizadas são carregadas principalmente do diretório .AI Cockpitcode/rules/. Esta é a abordagem recomendada para organizar suas regras específicas do projeto. Cada regra é normalmente colocada em seu próprio arquivo Markdown com um nome descritivo:

projeto/
├── .AI Cockpitcode/
│   ├── rules/
│   │   ├── formatting.md
│   │   ├── restricted_files.md
│   │   └── naming_conventions.md
├── src/
└── ...

Regras Globais

As regras globais são armazenadas em seu diretório pessoal e se aplicam a todos os projetos:

~/.AI Cockpitcode/
├── rules/
│   ├── coding_standards.md
│   ├── security_guidelines.md
│   └── documentation_style.md

Gerenciando Regras Através da UI

O AI Cockpit Reasoning fornece uma interface integrada para gerenciar suas regras personalizadas sem editar manualmente os arquivos nos diretórios .AI Cockpitcode/rules/. Para acessar a UI, clique no ícone no canto inferior direito da janela do AI Cockpit Reasoning.

Você pode acessar a UI de gerenciamento de regras para:

• Visualizar todas as regras ativas (tanto de projeto quanto globais)
• Ativar/desativar regras sem excluí-las
• Criar e editar regras diretamente na interface
• Organizar regras por categoria e prioridade

Ordem de Carregamento das Regras

Regras Gerais (Qualquer Modo)

As regras são carregadas na seguinte ordem de prioridade:

1. Regras globais do diretório ~/.AI Cockpitcode/rules/
2. Regras de projeto do diretório .AI Cockpitcode/rules/
3. Arquivos de fallback legados (para compatibilidade com versões anteriores):
   • .roorules
   • .clinerules
   • .AI Cockpitcoderules (obsoleto)

Quando existem regras globais e de projeto, elas são combinadas, com as regras de projeto tendo precedência sobre as regras globais para diretivas conflitantes.

nota

Recomendamos fortemente manter suas regras na pasta .AI Cockpitcode/rules/, pois isso proporciona uma melhor organização e é a abordagem preferida para versões futuras. A estrutura baseada em pastas permite uma organização de regras mais granular e uma separação mais clara de responsabilidades. A abordagem legada baseada em arquivos é mantida para compatibilidade com versões anteriores, mas pode estar sujeita a alterações em versões futuras.

Regras Específicas do Modo

Além disso, o sistema suporta regras específicas do modo, que são carregadas separadamente e têm sua própria ordem de prioridade:

1. Primeiro, ele verifica o diretório .AI Cockpitcode/rules-${mode}/
2. Se isso não existir ou estiver vazio, ele recorre ao arquivo .AI Cockpitcoderules-${mode} (obsoleto)

Atualmente, as regras específicas do modo são suportadas apenas no nível do projeto. Quando existem regras genéricas e regras específicas do modo, as regras específicas do modo recebem prioridade na saída final.

Criando Regras Personalizadas

Usando a Interface da UI

A maneira mais fácil de criar e gerenciar regras é através da UI integrada:

1. Acesse a interface de gerenciamento de regras no painel do AI Cockpit Reasoning
2. Escolha entre criar regras específicas do projeto ou globais
3. Use a interface para criar, editar ou alternar regras
4. As regras são salvas e aplicadas automaticamente e imediatamente

Usando o Sistema de Arquivos

Para criar regras manualmente:

Para Regras de Projeto:

1. Crie o diretório .AI Cockpitcode/rules/ se ele ainda não existir
2. Crie um novo arquivo Markdown com um nome descritivo neste diretório
3. Escreva sua regra usando a formatação Markdown
4. Salve o arquivo

Para Regras Globais:

1. Crie o diretório ~/.AI Cockpitcode/rules/ se ele ainda não existir
2. Crie um novo arquivo Markdown com um nome descritivo neste diretório
3. Escreva sua regra usando a formatação Markdown
4. Salve o arquivo

As regras serão aplicadas automaticamente a todas as interações futuras do AI Cockpit Reasoning. Quaisquer novas alterações serão aplicadas imediatamente.

Exemplos de Regras

Exemplo 1: Formatação de Tabela

# Tabelas

Ao imprimir tabelas, sempre adicione um ponto de exclamação a cada cabeçalho de coluna

Esta regra simples instrui a IA a adicionar pontos de exclamação a todos os cabeçalhos de coluna da tabela ao gerar tabelas em seu projeto.

Exemplo 2: Acesso a Arquivos Restritos

# Arquivos restritos

Os arquivos na lista contêm dados sensíveis, eles NÃO DEVEM ser lidos

- supersecrets.txt
- credentials.json
- .env

Esta regra impede que a IA leia ou acesse arquivos sensíveis, mesmo que seja explicitamente solicitado a fazê-lo.

Casos de Uso

As regras personalizadas podem ser aplicadas a uma ampla variedade de cenários:

• Estilo de Código: Impor formatação consistente, convenções de nomenclatura e estilos de documentação
• Controles de Segurança: Impedir o acesso a arquivos ou diretórios sensíveis
• Estrutura do Projeto: Definir onde diferentes tipos de arquivos devem ser criados
• Requisitos de Documentação: Especificar formatos e requisitos de documentação
• Padrões de Teste: Definir como os testes devem ser estruturados
• Uso de API: Especificar como as APIs devem ser usadas e documentadas
• Tratamento de Erros: Definir convenções de tratamento de erros

Exemplos de Regras Personalizadas

• "Siga rigorosamente o guia de estilo de código [o guia de estilo de código específico do seu projeto]"
• "Sempre use espaços para indentação, com uma largura de 4 espaços"
• "Use camelCase para nomes de variáveis"
• "Escreva testes unitários para todas as novas funções"
• "Explique seu raciocínio antes de fornecer o código"
• "Foque na legibilidade e manutenibilidade do código"
• "Priorize o uso da biblioteca mais comum na comunidade"
• "Ao adicionar novas funcionalidades a sites, garanta que sejam responsivas e acessíveis"

Melhores Práticas

• Seja Específico: Defina claramente o escopo e a intenção de cada regra
• Use Categorias: Organize regras relacionadas sob cabeçalhos comuns
• Separe as Preocupações: Use arquivos diferentes para diferentes tipos de regras
• Use Exemplos: Inclua exemplos para ilustrar o comportamento esperado
• Mantenha Simples: As regras devem ser concisas e fáceis de entender
• Atualize Regularmente: Revise e atualize as regras conforme os requisitos do projeto mudam

Dica Profissional: Padrões de Equipe Baseados em Arquivo

Ao trabalhar em ambientes de equipe, colocar os arquivos .AI Cockpitcode/rules/codestyle.md sob controle de versão permite padronizar o comportamento do AI Cockpit em toda a sua equipe de desenvolvimento. Isso garante um estilo de código consistente, práticas de documentação e fluxos de trabalho de desenvolvimento para todos no projeto.

Limitações

• As regras são aplicadas com base no melhor esforço pelos modelos de IA
• Regras complexas podem exigir múltiplos exemplos para uma compreensão clara
• As regras do projeto se aplicam apenas ao projeto em que são definidas
• As regras globais se aplicam a todos os projetos

Solução de Problemas

Se suas regras personalizadas não estiverem sendo seguidas corretamente:

1. Verifique o status da regra na UI: Use a interface de gerenciamento de regras para verificar se suas regras estão ativas e carregadas corretamente
2. Verifique a formatação da regra: Garanta que suas regras estejam formatadas corretamente com uma estrutura Markdown clara
3. Verifique os locais das regras: Garanta que suas regras estejam localizadas em locais suportados:
   • Regras globais: diretório ~/.AI Cockpitcode/rules/
   • Regras do projeto: diretório .AI Cockpitcode/rules/
   • Arquivos legados: .AI Cockpitcoderules, .roorules, ou .clinerules
4. Especificidade da regra: Verifique se as regras são específicas e inequívocas
5. Reinicie o VS Code: Reinicie o VS Code para garantir que as regras sejam carregadas corretamente

Recursos Relacionados

• Modos Personalizados
• Instruções Personalizadas
• Gerenciamento de Configurações
• Configurações de Aprovação Automática