Regras

Defina instruções personalizadas para o opencode.

Você pode fornecer instruções personalizadas ao opencode criando um arquivo AGENTS.md. Isso é semelhante às regras do Cursor. Ele contém instruções que serão incluídas no contexto do LLM para personalizar seu comportamento no seu projeto específico.

Inicializar

Para criar um novo arquivo AGENTS.md, você pode executar o comando /init no opencode.

Dica: Você deve versionar o arquivo AGENTS.md do seu projeto no Git.

O /init examina os arquivos importantes do seu repositório, pode fazer algumas perguntas direcionadas quando a base de código não consegue respondê-las, e então cria ou atualiza o AGENTS.md com orientações concisas e específicas do projeto.

Ele foca nas coisas que sessões futuras do agente provavelmente vão precisar:

• comandos de build, lint e test
• ordem dos comandos e etapas de verificação focadas quando isso importa
• arquitetura e estrutura do repositório que não são óbvias só pelos nomes dos arquivos
• convenções específicas do projeto, particularidades de configuração e armadilhas operacionais
• referências a fontes de instrução existentes, como regras do Cursor ou do Copilot

Se você já tiver um AGENTS.md, o /init irá melhorá-lo no lugar, em vez de substituí-lo cegamente.

Exemplo

Você também pode simplesmente criar este arquivo manualmente. Aqui está um exemplo de algumas coisas que você pode colocar em um arquivo AGENTS.md.

# SST v3 Monorepo Project
 
This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
 
## Project Structure
 
- `packages/` - Contains all workspace packages (functions, core, web, etc.)
- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
- `sst.config.ts` - Main SST configuration with dynamic imports
 
## Code Standards
 
- Use TypeScript with strict mode enabled
- Shared code goes in `packages/core/` with proper exports configuration
- Functions go in `packages/functions/`
- Infrastructure should be split into logical files in `infra/`
 
## Monorepo Conventions
 
- Import shared modules using workspace names: `@my-app/core/example`

Estamos adicionando instruções específicas do projeto aqui e isso será compartilhado com toda a sua equipe.

Tipos

O opencode também oferece suporte à leitura do arquivo AGENTS.md de múltiplos locais. E isso serve a diferentes propósitos.

Projeto

Coloque um AGENTS.md na raiz do seu projeto para regras específicas do projeto. Elas se aplicam apenas quando você está trabalhando neste diretório ou em seus subdiretórios.

Global

Você também pode ter regras globais em um arquivo ~/.config/opencode/AGENTS.md. Isso é aplicado em todas as sessões do opencode.

Como isso não é versionado no Git nem compartilhado com sua equipe, recomendamos usá-lo para especificar quaisquer regras pessoais que o LLM deve seguir.

Compatibilidade com Claude Code

Para usuários migrando do Claude Code, o OpenCode oferece suporte às convenções de arquivo do Claude Code como fallbacks:

• Regras de projeto : CLAUDE.md no diretório do seu projeto (usado se nenhum AGENTS.md existir)
• Regras globais : ~/.claude/CLAUDE.md (usado se nenhum ~/.config/opencode/AGENTS.md existir)
• Skills : ~/.claude/skills/ — veja Agent Skills para detalhes

Para desabilitar a compatibilidade com o Claude Code, defina uma destas variáveis de ambiente:

export OPENCODE_DISABLE_CLAUDE_CODE=1        # Disable all .claude support
export OPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1 # Disable only ~/.claude/CLAUDE.md
export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills

Precedência

Quando o opencode inicia, ele procura por arquivos de regras nesta ordem:

1. Arquivos locais subindo a partir do diretório atual ( AGENTS.md , CLAUDE.md )
2. Arquivo global em ~/.config/opencode/AGENTS.md
3. Arquivo do Claude Code em ~/.claude/CLAUDE.md (a menos que desabilitado)

O primeiro arquivo correspondente vence em cada categoria. Por exemplo, se você tiver tanto AGENTS.md quanto CLAUDE.md, apenas o AGENTS.md é usado. Da mesma forma, ~/.config/opencode/AGENTS.md tem precedência sobre ~/.claude/CLAUDE.md.

Instruções Personalizadas

Você pode especificar arquivos de instruções personalizadas no seu opencode.json ou no ~/.config/opencode/opencode.json global. Isso permite que você e sua equipe reutilizem regras existentes em vez de ter que duplicá-las no AGENTS.md.

Exemplo:

{
  "$schema": "https://opencode.ai/config.json",
  "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
}

Você também pode usar URLs remotas para carregar instruções da web.

{
  "$schema": "https://opencode.ai/config.json",
  "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]
}

As instruções remotas são buscadas com um timeout de 5 segundos.

Todos os arquivos de instruções são combinados com seus arquivos AGENTS.md.

Referenciando Arquivos Externos

Embora o opencode não analise automaticamente referências de arquivo no AGENTS.md, você pode obter funcionalidade semelhante de duas maneiras:

Usando opencode.json

A abordagem recomendada é usar o campo instructions no opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"]
}

Instruções Manuais no AGENTS.md

Você pode ensinar o opencode a ler arquivos externos fornecendo instruções explícitas no seu AGENTS.md. Aqui está um exemplo prático:

# TypeScript Project Rules
 
## External File Loading
 
CRITICAL: When you encounter a file reference (e.g., @rules/general.md), use your Read tool to load it on a need-to-know basis. They're relevant to the SPECIFIC task at hand.
 
Instructions:
 
- Do NOT preemptively load all references - use lazy loading based on actual need
- When loaded, treat content as mandatory instructions that override defaults
- Follow references recursively when needed
 
## Development Guidelines
 
For TypeScript code style and best practices: @docs/typescript-guidelines.md
For React component architecture and hooks patterns: @docs/react-patterns.md
For REST API design and error handling: @docs/api-standards.md
For testing strategies and coverage requirements: @test/testing-guidelines.md
 
## General Guidelines
 
Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.

Esta abordagem permite que você:

• Crie arquivos de regras modulares e reutilizáveis
• Compartilhe regras entre projetos via symlinks ou git submodules
• Mantenha o AGENTS.md conciso enquanto referencia diretrizes detalhadas
• Garanta que o opencode carregue arquivos apenas quando necessário para a tarefa específica

Dica: Para monorepos ou projetos com padrões compartilhados, usar o opencode.json com padrões glob (como packages/*/AGENTS.md) é mais sustentável do que instruções manuais.