Pular para o conteúdo principal
Este guia leva você do zero a um diff revisado em menos de cinco minutos.
1

Instalar

Instala o CLI e implanta as skills do Kodus em todos os agentes de IA detectados (Claude Code, Cursor, Codex, Windsurf):
curl -fsSL https://review-skill.com/install | bash
Requer Node.js >= 20.0.0.
Verifique a instalação:
kodus --version
kodus status
2

Autenticar

Escolha o caminho que corresponde à sua situação. Você também pode pular a autenticação e executar kodus review diretamente — funciona em modo trial com limites diários.
Faça login com uma conta pessoal:
kodus auth login
Os tokens são armazenados em ~/.kodus/credentials.json e atualizados automaticamente.
Usando Kodus self-hosted? Aponte o CLI para a sua API antes de autenticar:
export KODUS_API_URL=https://kodus-api.suaempresa.com
HTTPS é obrigatório, exceto para localhost.
Confirme o estado de autenticação:
kodus auth status
3

Execute sua primeira revisão

Dentro de qualquer repositório git com alterações não commitadas:
kodus review
O CLI analisa o diff da sua árvore de trabalho, imprime um resumo e (no modo interativo) permite navegar arquivo por arquivo, visualizar correções sugeridas e aplicá-las.Variações comuns:
kodus review --staged             # Apenas arquivos staged
kodus review --branch main        # Comparar a branch atual com main
kodus review --commit abc123      # Analisar um único commit
kodus review --fix                # Aplicar automaticamente todos os problemas corrigíveis
kodus review --prompt-only        # Saída compacta para agentes de IA
kodus review --fail-on error      # Sair com código não-zero em error ou acima (adequado para CI)
Revisões de árvore de trabalho (padrão) e --staged incluem o conteúdo dos arquivos para que o backend veja suas alterações não commitadas. Os modos --branch e --commit ignoram a inclusão, pois o backend pode buscar esses commits diretamente — é por isso que esses modos funcionam bem em branches grandes.
4

Escolha o que vem a seguir

Dependendo do seu objetivo:

Automatizar em cada push

Instale o hook pre-push com kodus hook install.

Executar revisões no CI

GitHub Actions, GitLab CI e exemplos de pipelines genéricos.

Integrar com um agente de IA

Alimente --prompt-only no Claude Code, Cursor ou Codex para loops de correção autônomos.

Configurar o repositório

Gerencie arquivos ignorados, branches base e configurações de revisão pelo CLI.

​
Variáveis de Ambiente

Essas variáveis de ambiente configuram o CLI em todos os comandos.
VariávelDescrição
KODUS_API_URLEndpoint da API (padrão: https://api.kodus.io)
KODUS_TEAM_KEYChave de equipe para acesso compartilhado e agentes de IA
KODUS_TOKENToken CI/CD gerado via kodus auth token
KODUS_VERBOSEDefina como true para saída detalhada
KODUS_SKIP_HOOKDefina como 1 para ignorar o hook pre-push em um único git push
KODUS_REQUEST_TIMEOUT_MINTimeout por requisição em minutos (padrão: 60)
CF_ACCESS_CLIENT_IDID do cliente Cloudflare Access (APIs atrás de Zero Trust)
CF_ACCESS_CLIENT_SECRETSegredo do cliente Cloudflare Access
Para configurações self-hosted, tokens e Cloudflare Access, veja Configuração Self-Hosted.

​
Solução de Problemas

Encontrou um erro? Verifique o guia de Solução de Problemas para sintomas comuns e correções.