O Que Faz

O codereview envia seu código para um LLM e retorna uma revisão estruturada e codificada por cores diretamente no terminal — com classificações de gravidade, referências de linha e sugestões concretas de correção.

Sem navegador. Sem PR. Sem esperar por colegas. Apenas:

codereview app.py

Detectando vulnerabilidades reais de segurança — nota 2/10

Revisando seu próprio código-fonte — nota 9/10

Por Quê

• Desenvolvedores solo — tenha um segundo par de olhos sem esperar ninguém
• Verificação pré-commit — detecte bugs antes de chegarem ao PR
• Ferramenta de aprendizado — entenda por que o código é problemático, não apenas que é
• Integração com CI — adicione ao seu pipeline para revisões automatizadas
• Gratuito — funciona com Groq (nível gratuito, sem cartão de crédito) ou totalmente offline com Ollama

O Que Detecta

Instalar

A partir do código-fonte (recomendado)

git clone https://github.com/jaydendancer12/ai-code-review.git
cd ai-code-review
./install.sh

Ou manualmente:

git clone https://github.com/jaydendancer12/ai-code-review.git
cd ai-code-review
pip install -e .

Todas as dependências (rich, requests) são instaladas automaticamente. Nada mais a configurar.

Início Rápido (gratuito, 60 segundos)

O codereview precisa de um LLM para analisar seu código. A opção gratuita mais rápida é o Groq — sem cartão de crédito, sem teste, apenas gratuito.

Etapa 1 — Obtenha uma chave de API gratuita

1. Acesse console.groq.com
2. Cadastre-se com Google ou GitHub (leva 30 segundos)
3. Clique em API Keys e depois Create API Key
4. Copie a chave (começa com gsk_)

Etapa 2 — Defina sua chave

export GROQ_API_KEY="gsk_sua_chave_aqui"

Para torná-la permanente (para não precisar defini-la a cada sessão do terminal):

# Para zsh (padrão no Mac)
echo 'export GROQ_API_KEY="gsk_sua_chave_aqui"' >> ~/.zshrc
source ~/.zshrc

# Para bash (padrão no Linux)
echo 'export GROQ_API_KEY="gsk_sua_chave_aqui"' >> ~/.bashrc
source ~/.bashrc

Etapa 3 — Inicialize

codereview --init groq

Etapa 4 — Revise o código

codereview seu_arquivo.py

Pronto. Você está executando revisões de código com IA.

Primeira vez executando? Basta digitar codereview sem argumentos e ele o guiará por toda a configuração.

Uso

Revisar um arquivo

codereview app.py

Revisar múltiplos arquivos

codereview src/auth.py src/db.py src/api.py

Revisar alterações staged do git (pré-commit)

git add .
codereview --staged

Revisar os últimos N commits

codereview --last 3

Revisar diff entre branches

codereview --diff origin/main

Enviar código via stdin

cat codigo_suspeito.py | codereview --stdin

Usar um modelo específico

codereview app.py --model gpt-4

Usar um provedor específico para uma revisão

codereview app.py --provider ollama

Mostrar instruções de configuração

codereview --setup

Provedores

O codereview funciona com qualquer API compatível com OpenAI. Escolha o que funciona para você:

⚡ Groq (recomendado — gratuito, rápido)

export GROQ_API_KEY="gsk_sua_chave_aqui"
codereview --init groq

• Custo: Nível gratuito, sem necessidade de cartão de crédito
• Velocidade: Inferência mais rápida disponível
• Modelo: Llama 3.3 70B
• Obter chave: console.groq.com

🏠 Ollama (gratuito, totalmente offline)

# 1. Instalar o Ollama
# Mac: Baixe de https://ollama.com
# Linux: curl -fsSL https://ollama.com/install.sh | sh

# 2. Baixar um modelo
ollama pull llama3

# 3. Iniciar o servidor
ollama serve

# 4. Inicializar (nenhuma chave de API necessária)
codereview --init ollama

• Custo: Gratuito para sempre
• Velocidade: Depende do seu hardware
• Privacidade: O código nunca sai da sua máquina
• Modelo: Qualquer modelo que o Ollama suporte

🧠 OpenAI

export OPENAI_API_KEY="sk-..."
codereview --init openai

• Custo: Pague por token
• Modelo: GPT-3.5 Turbo (padrão), GPT-4 com --model gpt-4
• Obter chave: platform.openai.com

🔮 Anthropic

export ANTHROPIC_API_KEY="sk-ant-..."
codereview --init anthropic

• Custo: Pague por token
• Modelo: Claude 3 Haiku (padrão)
• Obter chave: console.anthropic.com

Configuração

A configuração é armazenada em ~/.codereview/config.json:

{
  "provider": "groq",
  "model": "llama-3.3-70b-versatile",
  "base_url": "https://api.groq.com/openai/v1",
  "max_tokens": 2048,
  "temperature": 0.2
}

As chaves de API nunca são armazenadas no arquivo de configuração. Elas são lidas apenas de variáveis de ambiente.

Substituir qualquer coisa via variáveis de ambiente

export CODEREVIEW_API_KEY="qualquer-chave"     # Substituição universal
export CODEREVIEW_MODEL="gpt-4"         # Substituir modelo

Substituir via flags da CLI

codereview app.py --model gpt-4 --provider openai

Como Funciona

Seu Código  -->  CLI codereview  -->  API LLM  -->  Saída Estruturada no Terminal
(arquivo/diff)     (construtor de prompt)    (qualquer provedor)  (achados com código de cores)

1. Entrada — O codereview lê seu arquivo, diff git, alterações staged ou stdin
2. Prompt — Constrói um prompt de revisão focado com regras rígidas para evitar problemas alucinados
3. LLM — Envia para qualquer API compatível com OpenAI (Groq, OpenAI, Anthropic, Ollama)
4. Analisar — Extrai JSON estruturado da resposta do LLM
5. Exibir — Renderiza achados com código de cores, ordenados por gravidade, no seu terminal

O que torna isso diferente do ChatGPT

• Saída estruturada — Classificações de gravidade, referências de arquivo, sugestões concretas
• Sem alucinações — Engenharia de prompt garante que o LLM sinalize apenas problemas que pode ver no seu código
• Funciona em diffs — Revise apenas o que mudou, não todo o código
• Um comando — Sem copiar e colar em um navegador
• Capacidade offline — Execute com Ollama, seu código nunca sai da sua máquina
• Gratuito — Sem assinatura necessária

Exemplos

Auditoria de segurança em um arquivo suspeito

$ codereview api/auth.py

Score: 3/10

🔴 CRITICAL — Hardcoded JWT secret
   Secret key is hardcoded on line 12.
   Suggestion: Use environment variable: os.environ["JWT_SECRET"]

🔴 CRITICAL — No password hashing
   Passwords stored in plaintext on line 34.
   Suggestion: Use bcrypt: bcrypt.hashpw(password, bcrypt.gensalt())

🟡 WARNING — Token never expires
   JWT tokens have no expiration set.
   Suggestion: Add exp claim with timedelta

Revisão pré-commit de alterações staged

$ git add .
$ codereview --staged

Score: 8/10

🔵 INFO — Consider adding error handling
   The new API endpoint doesn't catch ConnectionError.
   Suggestion: Wrap in try/except with retry logic.

Revisar os últimos 3 commits antes de enviar

$ codereview --last 3

Score: 9/10

⚪ STYLE — Inconsistent naming
   Mix of snake_case and camelCase in utils.py
   Suggestion: Stick to snake_case per PEP 8.

Usar em CI/CD

Adicione ao seu fluxo de trabalho do GitHub Actions:

name: Code Review
on: [pull_request]
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - run: pip install ai-code-review
      - run: codereview --diff origin/main
        env:
          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}

Estrutura do Projeto

ai-code-review/
├── codereview/
│   ├── __init__.py          # Versão
│   ├── cli.py               # Interface de linha de comando + configuração inicial
│   ├── reviewer.py          # Chamadas à API LLM + análise de resposta
│   ├── formatter.py         # Formatação de saída rica no terminal
│   ├── git_utils.py         # Utilitários de extração de diff/arquivo git
│   └── config.py            # Gerenciamento de configuração + manipulação de chave de API
├── tests/
│   ├── test_reviewer.py     # Testes de análise de revisão
│   └── test_git_utils.py    # Testes de utilitários git
├── setup.py
├── pyproject.toml
├── LICENSE
└── README.md

Solução de Problemas

"Nenhuma chave de API encontrada"

Você não definiu sua chave de API. A opção gratuita mais rápida:

# 1. Obtenha uma chave gratuita em https://console.groq.com
# 2. Defina-a:
export GROQ_API_KEY="gsk_sua_chave_aqui"
codereview --init groq

"Erro de API 403: código de erro 1010"

Seu cliente HTTP está sendo bloqueado pelo Cloudflare. Certifique-se de estar atualizado:

git pull
pip install -e .

"Modelo foi descontinuado"

O modelo foi descontinuado. Re-inicialize para obter o modelo mais recente:

codereview --init groq

"Conexão recusada" (Ollama)

O servidor Ollama não está em execução:

ollama serve

Depois tente novamente em um novo terminal.

"Nenhum módulo chamado rich" ou "Nenhum módulo chamado requests"

As dependências não foram instaladas. Execute:

pip install rich requests

Ou reinstale:

pip install -e .

Comando não encontrado: codereview

A instalação não o adicionou ao seu PATH. Use diretamente:

python3 -m codereview.cli seu_arquivo.py

Ou crie um alias:

echo 'alias codereview="python3 -m codereview.cli"' >> ~/.zshrc
source ~/.zshrc

Contribuir

PRs são bem-vindos! Este projeto é mantido ativamente.

Configurar ambiente de desenvolvimento

git clone https://github.com/jaydendancer12/ai-code-review.git
cd ai-code-review
pip install -e .
pip install pytest

Executar testes

pytest -v

Estilo de código

• Use dicas de tipo em todas as funções
• Escreva docstrings para todas as funções públicas
• Siga PEP 8
• Adicione testes para novos recursos

Diretrizes para PR

1. Faça um fork do repositório
2. Crie um branch de recurso: git checkout -b feat/meu-recurso
3. Faça as alterações e adicione testes
4. Execute pytest para verificar
5. Envie um PR com uma descrição clara

Roteiro

• Varredura de diretórios — codereview src/ revisa todos os arquivos recursivamente
• Perfis de configuração — alternar entre provedores com codereview --profile trabalho
• Formatos de saída — JSON, Markdown, SARIF para integração com CI
• Ganchos git — revisão automática no git commit
• Extensão para VS Code — revisão diretamente do seu editor
• Histórico de revisões — acompanhar melhorias ao longo do tempo
• Regras personalizadas — definir seus próprios critérios de revisão
• Suporte a múltiplos idiomas — prompts de revisão específicos para linguagem

Licença

MIT — veja LICENSE