Pular para o conteúdo principal

Flags Globais

Essas flags estão disponíveis em todos os comandos:
FlagCurtoPadrãoDescrição
--format <fmt>-fterminalFormato de saída: terminal, json, markdown
--output <file>-oSalvar saída em um arquivo
--verbose-vfalseSaída detalhada
--quiet-qfalseModo silencioso (apenas erros)
--agentfalseModo agente: saída determinística legível por máquina

kodus review

Analisa arquivos modificados em busca de problemas de qualidade de código, bugs, vulnerabilidades de segurança e violações de estilo.

Uso

kodus review                          # Revisar alterações na árvore de trabalho (interativo)
kodus review [files...]               # Revisar arquivos específicos
kodus review --staged                 # Revisar apenas arquivos staged
kodus review --branch main            # Comparar com uma branch
kodus review --commit abc123          # Analisar um commit específico
kodus review --fix                    # Aplicar automaticamente todos os problemas corrigíveis
kodus review --prompt-only            # Saída otimizada para agentes de IA

Flags

FlagCurtoDescrição
--staged-sAnalisar apenas arquivos staged
--commit <sha>-cAnalisar diff de um commit específico
--branch <name>-bComparar a branch atual com a branch especificada
--rules-onlyRevisar usando apenas regras configuradas (sem sugestões gerais)
--fastModo rápido: análise mais ágil com verificações mais leves
--interactive-iModo interativo: navegar e aplicar correções
--fixAplicar automaticamente todos os problemas corrigíveis
--prompt-onlySaída otimizada para agentes de IA
--fail-on <severity>Sair com código 1 se problemas atingirem ou superarem a severidade
--context <file>Arquivo de contexto personalizado para incluir na revisão
--fields <csv>Selecionar campos de resposta (modo JSON/agent), ex.: summary,issues.file

Modos de Revisão

Navegue pelos arquivos com contagens de problemas, visualize correções sugeridas e aplique-as uma a uma.
kodus review

kodus pr suggestions

Busca sugestões alimentadas por IA para pull requests abertos.

Uso

kodus pr suggestions --pr-url https://github.com/org/repo/pull/42
kodus pr suggestions --pr-number 42 --repo-id <id>
kodus pr suggestions --pr-number 42 --repo-id <id> --severity error,warning
kodus pr suggestions --pr-number 42 --repo-id <id> --format json

Flags

FlagDescrição
--pr-url <url>URL do pull request
--pr-number <number>Número do pull request (requer --repo-id)
--repo-id <id>ID do repositório para o pull request
--severity <list>Severidades separadas por vírgula para incluir
--category <list>Categorias separadas por vírgula para incluir
--fields <csv>Selecionar campos de resposta (modo JSON/agent), ex.: summary,issues.file

kodus pr business-validation

Valida um diff local em relação às regras de negócio/critérios de aceitação de uma tarefa. Útil antes de fazer merge para confirmar que a implementação corresponde ao objetivo da tarefa.

Uso

kodus pr business-validation --task-url https://linear.app/team/issue/KC-1441
kodus pr business-validation --task-id KC-1441 --staged
kodus pr business-validation --task-id KC-1441 --branch main
kodus pr business-validation --task-id KC-1441 --commit abc123
kodus pr business-validation --task-id KC-1441 --dry-run

Flags

FlagCurtoDescrição
--task-url <url>URL da tarefa para incluir no comando de validação
--task-id <id>ID da tarefa ou chave do issue (ex.: KC-1441) para incluir
--staged-sUsar apenas alterações staged
--commit <sha>-cUsar diff de um commit específico
--branch <name>-bComparar a branch atual com uma branch base
--dry-runImprimir o payload sem executar a chamada de API

kodus auth

Gerencia autenticação com a API do Kodus.

auth login

kodus auth login                              # Login interativo
kodus auth login -e user@mail.com -p password # Não interativo
FlagCurtoDescrição
--email <email>-eE-mail da conta
--password <password>-pSenha da conta

auth logout

kodus auth logout
Remove a autenticação local (login e chave de equipe).

auth status

kodus auth status
Exibe o modo de autenticação, e-mail, validade do token, organizações, status de trial e limites de uso.

auth team-key

kodus auth team-key --key kodus_xxxxx
Autentica usando uma chave de API de equipe compartilhada. Também pode ser definida via variável de ambiente KODUS_TEAM_KEY.

auth team-status

kodus auth team-status
Exibe detalhes de autenticação da equipe (nome da organização e da equipe).

auth token

kodus auth token
Gera um token de CI/CD para uso em pipelines automatizados. Use com a variável de ambiente KODUS_TOKEN.

kodus hook

Gerencia hooks Git pre-push para revisão automática de código antes do push.

hook install

kodus hook install                    # Padrão: fail-on critical, modo rápido habilitado
kodus hook install --fail-on error    # Bloquear pushes em severidade error
kodus hook install --no-fast          # Desabilitar modo rápido
kodus hook install --force            # Sobrescrever hook existente
FlagPadrãoDescrição
--fail-on <severity>criticalSeveridade mínima para bloquear push
--fast / --no-fasttrueHabilitar/desabilitar modo rápido
--forceSobrescrever hook existente sem confirmação

hook uninstall

kodus hook uninstall
Remove o hook pre-push instalado pelo Kodus.

hook status

kodus hook status
Exibe o status do hook, severidade de fail-on, configuração de modo rápido e caminho.

Ignorando o Hook

KODUS_SKIP_HOOK=1 git push

kodus decisions

Captura e persiste decisões de agentes de IA no seu repositório para referência futura. As decisões são armazenadas como markdown estruturado em .kody/.

decisions enable

kodus decisions enable                                    # Todos os agentes
kodus decisions enable --agents claude,cursor            # Agentes específicos
kodus decisions enable --agents codex --codex-config ~/.codex/config.toml
kodus decisions enable --force                           # Sobrescrever configuração existente
FlagPadrãoDescrição
--agents <agents>claude,cursor,codexLista de agentes separada por vírgula
--codex-config <path>~/.codex/config.tomlCaminho para a configuração do Codex
--forceSobrescrever modules.yml existente

decisions disable

kodus decisions disable
Remove todos os hooks de decisões. Os dados preservados em .kody/ não são deletados.

decisions status

kodus decisions status
Exibe memória de PR, sessões, último SHA, agente e configuração de módulo.

decisions show

kodus decisions show                  # Memória de PR da branch atual
kodus decisions show auth             # Decisões de módulo para 'auth'
kodus decisions show feat/new-api     # Decisões de PR para uma branch específica

decisions promote

kodus decisions promote                                   # Branch atual, todos os módulos
kodus decisions promote --branch feat/auth                # Branch específica
kodus decisions promote --branch feat/auth --modules auth,users
FlagDescrição
--branch <name>Nome da branch (padrão: branch atual)
--modules <ids>IDs de módulos separados por vírgula (padrão: todos os correspondentes)
Promove decisões de nível de PR para memória de módulo de longo prazo.

kodus config centralized

Gerencia configuração centralizada pelo CLI.

Uso

kodus config centralized status
kodus config centralized init [owner/repo] --sync-option <pr|manual>
kodus config centralized sync
kodus config centralized disable
kodus config centralized download --out ./centralized-config.zip

Subcomandos

SubcomandoDescrição
statusExibe se a configuração centralizada está habilitada e o repositório de origem selecionado
init [repository]Habilita a configuração centralizada para um repositório selecionado
syncExecuta a sincronização de configuração centralizada sob demanda
disableDesabilita a configuração centralizada e limpa o repositório selecionado
download --out <path>Baixa o pacote ZIP de configuração centralizada

Flags

FlagAplica-se aDescrição
--sync-option <pr | manual>initEstratégia de sincronização. Padrão é pr
--out <path>downloadCaminho de saída obrigatório para o arquivo ZIP
--jsontodos os subcomandos centralizedSaída JSON estruturada
Para um guia completo, veja: /how_to_use/en/code_review/configs/centralized_config#cli-dedicated-section

kodus config repo

Inspeciona e atualiza configurações de repositório armazenadas no Kodus. Requer autenticação por chave de equipe. Use . para referenciar o repositório atual.
kodus config repo e kodus config remote são aliases para o mesmo grupo de comandos.

Uso

kodus config repo add                                   # Adicionar repositório atual ao Kodus
kodus config repo add owner/repo                        # Adicionar um repositório específico
kodus config repo list                                  # Listar repositórios configurados
kodus config repo show                                  # Exibir configurações do repositório atual
kodus config repo setup                                 # Assistente de configuração guiado
kodus config repo set . reviewEnabled true              # Definir uma configuração diretamente
kodus config repo open                                  # Abrir o painel do Kodus
kodus config repo add-ignore-file . "**/*.generated.ts"
kodus config repo add-base-branch . "release/*"
kodus config repo add-ignore-title . "^WIP:"

Subcomandos

SubcomandoDescrição
add [repository]Adicionar um repositório ao Kodus (atalho: kodus config -r [repository])
listListar repositórios configurados no Kodus
show [repository]Exibir configurações do repositório
setup [repository]Executar um assistente de configuração de repositório guiado
set [repository] <key> <value>Definir uma configuração de repositório diretamente
open [repository]Abrir o painel do Kodus para configurações avançadas
add-pattern [repository] <field> <pattern>Adicionar um padrão a um campo de lista (ignore-files, base-branches, ignore-titles)
remove-pattern [repository] <field> <pattern>Remover um padrão de um campo de lista
add-ignore-file [repository] <pattern>Atalho: adicionar um padrão aos padrões de arquivo ignorados
remove-ignore-file [repository] <pattern>Atalho: remover um padrão de arquivo ignorado
add-base-branch [repository] <pattern>Atalho: adicionar um padrão de branch base
remove-base-branch [repository] <pattern>Atalho: remover um padrão de branch base
add-ignore-title [repository] <pattern>Atalho: adicionar um padrão de título ignorado
remove-ignore-title [repository] <pattern>Atalho: remover um padrão de título ignorado

Flags

FlagAplica-se aDescrição
--no-promptaddIgnorar o prompt de configuração pós-adição

kodus rules

Cria, atualiza e visualiza Kody Rules — regras estruturadas que o Kodus aplica durante as revisões.

Uso

kodus rules view                                         # Ver todas as regras da sua equipe
kodus rules view --repo-id <id>                          # Filtrar por repositório
kodus rules view --uuid <rule-uuid>                      # Buscar uma única regra
kodus rules create --title "No console.log" --rule "Avoid leaving console.log in committed code" --severity high
kodus rules update --uuid <rule-uuid> --severity critical

Subcomandos

SubcomandoDescrição
createCriar uma nova Kody Rule
updateAtualizar uma regra existente
viewVisualizar Kody Rules

Flags de rules create

FlagPadrãoDescrição
--title <title>Título da regra
--rule <rule>Conteúdo/descrição da regra
--repo-id <id>globalID do repositório (ou global para aplicar a todos)
--severity <severity>mediumlow, medium, high, critical
--scope <scope>filepull request ou file
--path <glob>**/*Padrão glob para seleção de arquivos
--jsonfalseExportar regra criada como JSON

Flags de rules update

FlagDescrição
--uuid <uuid>UUID da regra a atualizar (obrigatório)
--repo-id <id>ID de repositório atualizado
--title <title>Título atualizado
--rule <rule>Conteúdo/descrição atualizado
--severity <severity>Severidade atualizada
--scope <scope>Escopo atualizado
--path <glob>Padrão glob atualizado
--jsonExportar regra atualizada como JSON

Flags de rules view

FlagDescrição
--uuid <uuid>Buscar uma única regra por UUID
--repo-id <id>Filtrar regras por ID de repositório
--jsonExportar regras como JSON

kodus skills

Inspeciona e instala as skills de agentes incluídas no CLI (Claude Code, Cursor, Codex).

Uso

kodus skills list                                        # Listar skills incluídas
kodus skills install                                     # Instalar nas raízes de agentes detectadas
kodus skills install --dry-run                           # Visualizar alterações
kodus skills resync                                      # Ressincronizar skills incluídas
kodus skills uninstall                                   # Remover skills incluídas

Subcomandos

SubcomandoDescrição
listListar skills incluídas disponíveis neste pacote CLI
syncSincronizar skills incluídas com diretórios de agentes locais detectados
resyncRessincronizar skills incluídas com diretórios de agentes locais detectados
installInstalar skills incluídas nas raízes de agentes detectadas (cria dirs se necessário)
uninstallDesinstalar skills gerenciadas incluídas dos diretórios de agentes detectados

Flags

FlagAplica-se aDescrição
--dry-runinstall, sync, resync, uninstallMostrar alterações planejadas sem gravar arquivos
Para bootstrap completo com múltiplos agentes, prefira o instalador de plataforma (curl -fsSL https://review-skill.com/install | bash). kodus skills cobre ressincronização local e limpeza.

kodus status

Exibe um status consolidado do Kodus: modo de autenticação, organização, repositório, hook, decisions, skills incluídas e versão do CLI.
kodus status
Útil como primeiro diagnóstico quando algo não funciona ou ao configurar uma nova máquina.

kodus update

Atualiza o Kodus CLI para a versão mais recente do npm.
kodus update
Resolve o comando de instalação global correto para o seu gerenciador de pacotes (npm, yarn, pnpm, bun) e o executa. Se um script de instalação foi usado, o CLI aponta para o comando de re-execução correspondente.

kodus subscribe

Abre a página de preços/upgrade do Kodus no seu navegador.
kodus subscribe

Níveis de Severidade

Os problemas são categorizados por severidade, do mais ao menos crítico:
NívelDescrição
criticalProblemas graves de segurança ou estabilidade que exigem atenção imediata
errorBugs ou problemas significativos
warningProblemas potenciais que merecem atenção
infoSugestões e boas práticas

Categorias de Problemas

CategoriaDescrição
security_vulnerabilityProblemas relacionados à segurança
bugBugs potenciais
performanceOportunidades de otimização de desempenho
code_qualityMelhorias de qualidade de código
best_practicesViolações de boas práticas
complexityProblemas de complexidade de código
maintainabilityPreocupações de manutenibilidade
styleProblemas de estilo de código