Primeiros Passos

Este guia leva você do zero a um diff revisado em menos de cinco minutos.

Instalar

Instalador de Skills (Recomendado)
npm
npx (Sem Instalação)
curl

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

npm install -g @kodus/cli

npx @kodus/cli review

curl -fsSL https://raw.githubusercontent.com/kodustech/cli/main/install.sh | bash

Requer Node.js >= 20.0.0.

Verifique a instalação:

kodus --version
kodus status

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.

Desenvolvedor solo
Equipe (chave compartilhada)
Agente de IA
CI/CD

Faça login com uma conta pessoal:

kodus auth login

Os tokens são armazenados em ~/.kodus/credentials.json e atualizados automaticamente.

Gere uma chave de equipe em app.kodus.io/organization/cli-keys e aplique-a:

kodus auth team-key --key kodus_xxxxx

Ou distribua o comando de bootstrap para sua equipe — ele instala o CLI e configura a chave de uma só vez:

curl -fsSL https://review-skill.com/install | bash -s -- --team-key kodus_xxxxx

Salve a chave quando ela for exibida — ela não será mostrada novamente.

Para agentes de programação de IA (Claude Code, Cursor, Codex), chaves de equipe são o caminho recomendado — sem login individual, sem prompts interativos. Defina a chave uma vez:

export KODUS_TEAM_KEY=kodus_xxxxx

Adicione ao seu perfil de shell para que o agente a utilize em cada execução.

A partir de uma máquina com login, gere um token de longa duração:

kodus auth token

No seu pipeline, defina:

export KODUS_TOKEN=<token-gerado>

Veja Configuração Self-Hosted para exemplos completos de CI.

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

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.

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ável	Descrição
`KODUS_API_URL`	Endpoint da API (padrão: `https://api.kodus.io`)
`KODUS_TEAM_KEY`	Chave de equipe para acesso compartilhado e agentes de IA
`KODUS_TOKEN`	Token CI/CD gerado via `kodus auth token`
`KODUS_VERBOSE`	Defina como `true` para saída detalhada
`KODUS_SKIP_HOOK`	Defina como `1` para ignorar o hook pre-push em um único `git push`
`KODUS_REQUEST_TIMEOUT_MIN`	Timeout por requisição em minutos (padrão: `60`)
`CF_ACCESS_CLIENT_ID`	ID do cliente Cloudflare Access (APIs atrás de Zero Trust)
`CF_ACCESS_CLIENT_SECRET`	Segredo 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.