Ce qu'il fait

codereview envoie votre code à un LLM et renvoie une revue structurée et codée par couleur directement dans votre terminal — avec des niveaux de gravité, des références de lignes et des suggestions concrètes de correction.

Pas de navigateur. Pas de PR nécessaire. Pas d'attente des coéquipiers. Juste :

codereview app.py

Détection de vraies vulnérabilités de sécurité — score 2/10

Revue de son propre code source — score 9/10

Pourquoi

• Développeurs solo — obtenez un second regard sans attendre personne
• Vérification pré-commit — détectez les bugs avant qu'ils n'atteignent la PR
• Outil d'apprentissage — comprenez pourquoi le code est problématique, pas seulement qu'il l'est
• Intégration CI — ajoutez à votre pipeline pour des passerelles de revue automatisées
• Gratuit — fonctionne avec Groq (niveau gratuit, pas de carte de crédit) ou entièrement hors ligne avec Ollama

Ce qu'il détecte

Installation

Depuis les sources (recommandé)

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

Ou manuellement :

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

Toutes les dépendances (rich, requests) s'installent automatiquement. Rien d'autre à configurer.

Démarrage rapide (gratuit, 60 secondes)

codereview a besoin d'un LLM pour analyser votre code. L'option gratuite la plus rapide est Groq — pas de carte de crédit, pas d'essai, juste gratuit.

Étape 1 — Obtenir une clé API gratuite

1. Allez sur console.groq.com
2. Inscrivez-vous avec Google ou GitHub (prend 30 secondes)
3. Cliquez sur API Keys puis Create API Key
4. Copiez la clé (commence par gsk_)

Étape 2 — Définir votre clé

export GROQ_API_KEY="gsk_your_key_here"

Pour la rendre permanente (afin de ne pas avoir à la définir à chaque session de terminal) :

# For zsh (default on Mac)
echo 'export GROQ_API_KEY="gsk_your_key_here"' >> ~/.zshrc
source ~/.zshrc

# For bash (default on Linux)
echo 'export GROQ_API_KEY="gsk_your_key_here"' >> ~/.bashrc
source ~/.bashrc

Étape 3 — Initialiser

codereview --init groq

Étape 4 — Examiner le code

codereview yourfile.py

Voilà. Vous exécutez des revues de code IA.

Première exécution ? Tapez simplement codereview sans arguments et il vous guidera à travers toute la configuration.

Utilisation

Examiner un fichier

codereview app.py

Examiner plusieurs fichiers

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

Examiner les modifications git indexées (pre-commit)

git add .
codereview --staged

Examiner les N derniers commits

codereview --last 3

Examiner le diff entre branches

codereview --diff origin/main

Canaliser le code depuis stdin

cat suspicious_code.py | codereview --stdin

Utiliser un modèle spécifique

codereview app.py --model gpt-4

Utiliser un fournisseur spécifique pour une revue

codereview app.py --provider ollama

Afficher les instructions de configuration

codereview --setup

Fournisseurs

codereview works with any OpenAI-compatible API. Pick what works for you:

⚡ Groq (recommandé — gratuit, rapide)

export GROQ_API_KEY="gsk_your_key_here"
codereview --init groq

• Coût : Niveau gratuit, pas de carte de crédit requise
• Vitesse : Inférence la plus rapide disponible
• Modèle : Llama 3.3 70B
• Obtenir une clé : console.groq.com

🏠 Ollama (gratuit, entièrement hors ligne)

# 1. Install Ollama
# Mac: Download from https://ollama.com
# Linux: curl -fsSL https://ollama.com/install.sh | sh

# 2. Pull a model
ollama pull llama3

# 3. Start the server
ollama serve

# 4. Initialize (no API key needed)
codereview --init ollama

• Coût : Gratuit pour toujours
• Vitesse : Dépend de votre matériel
• Confidentialité : Le code ne quitte jamais votre machine
• Modèle : Tout modèle supporté par Ollama

🧠 OpenAI

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

• Coût : Paiement par token
• Modèle : GPT-3.5 Turbo (par défaut), GPT-4 avec --model gpt-4
• Obtenir une clé : platform.openai.com

🔮 Anthropic

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

• Coût : Paiement par token
• Modèle : Claude 3 Haiku (par défaut)
• Obtenir une clé : console.anthropic.com

Configuration

La configuration est stockée dans ~/.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
}

Les clés API ne sont jamais stockées dans le fichier de configuration. Elles sont lues uniquement depuis les variables d'environnement.

Tout remplacer via les variables d'environnement

export CODEREVIEW_API_KEY="any-key"     # Universal override
export CODEREVIEW_MODEL="gpt-4"         # Override model

Remplacement via les options CLI

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

Comment ça fonctionne

Your Code  -->  codereview CLI  -->  LLM API  -->  Structured Terminal Output
(file/diff)     (prompt builder)    (any provider)  (color-coded findings)

1. Entrée — codereview lit votre fichier, diff git, modifications indexées ou stdin
2. Prompt — Construit un prompt de revue ciblé avec des règles strictes pour prévenir les problèmes hallucinés
3. LLM — Envoie à toute API compatible OpenAI (Groq, OpenAI, Anthropic, Ollama)
4. Analyse — Extrait le JSON structuré de la réponse du LLM
5. Affichage — Affiche les résultats codés par couleur et triés par gravité dans votre terminal

Ce qui le rend différent de ChatGPT

• Sortie structurée — Niveaux de gravité, références de fichiers, suggestions concrètes
• Pas d'hallucinations — L'ingénierie du prompt garantit que le LLM ne signale que les problèmes qu'il peut voir dans votre code
• Fonctionne sur les diffs — Revue uniquement de ce qui a changé, pas de toute la base de code
• Une seule commande — Pas de copier-coller dans un navigateur
• Capable hors ligne — Exécution avec Ollama, votre code ne quitte jamais votre machine
• Gratuit — Aucun abonnement requis

Exemples

Audit de sécurité sur un fichier suspect

$ 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

Revue pré-commit des modifications indexées

$ 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.

Revue des 3 derniers commits avant de pousser

$ 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.

Utilisation en CI/CD

Ajoutez à votre workflow 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 }}

Structure du projet

ai-code-review/
├── codereview/
│   ├── __init__.py          # Version
│   ├── cli.py               # Command-line interface + first-run setup
│   ├── reviewer.py          # LLM API calls + response parsing
│   ├── formatter.py         # Rich terminal output formatting
│   ├── git_utils.py         # Git diff/file extraction utilities
│   └── config.py            # Configuration management + API key handling
├── tests/
│   ├── test_reviewer.py     # Review parsing tests
│   └── test_git_utils.py    # Git utility tests
├── setup.py
├── pyproject.toml
├── LICENSE
└── README.md

Dépannage

"Aucune clé API trouvée"

Vous n'avez pas défini votre clé API. L'option gratuite la plus rapide :

# 1. Get a free key at https://console.groq.com
# 2. Set it:
export GROQ_API_KEY="gsk_your_key_here"
codereview --init groq

"API error 403: error code 1010"

Votre client HTTP est bloqué par Cloudflare. Assurez-vous d'être à jour :

git pull
pip install -e .

"Modèle décommissionné"

Le modèle a été déprécié. Réinitialisez pour obtenir le dernier modèle :

codereview --init groq

"Connexion refusée" (Ollama)

Le serveur Ollama n'est pas en cours d'exécution :

ollama serve

Puis réessayez dans un nouveau terminal.

"No module named rich" ou "No module named requests"

Les dépendances ne se sont pas installées. Exécutez :

pip install rich requests

Ou réinstallez :

pip install -e .

Commande introuvable : codereview

L'installation ne l'a pas ajouté à votre PATH. Utilisez directement :

python3 -m codereview.cli yourfile.py

Ou créez un alias :

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

Contribution

Les PRs sont les bienvenues ! Ce projet est activement maintenu.

Configurer l'environnement de développement

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

Exécuter les tests

pytest -v

Style de code

• Utilisez des annotations de type sur toutes les fonctions
• Écrivez des docstrings pour toutes les fonctions publiques
• Suivez PEP 8
• Ajoutez des tests pour les nouvelles fonctionnalités

Directives pour les PR

1. Forkez le dépôt
2. Créez une branche de fonctionnalité : git checkout -b feat/my-feature
3. Apportez des modifications et ajoutez des tests
4. Exécutez pytest pour vérifier
5. Soumettez une PR avec une description claire

Feuille de route

• Analyse de répertoire — codereview src/ examine tous les fichiers récursivement
• Profils de configuration — basculer entre fournisseurs avec codereview --profile work
• Formats de sortie — JSON, Markdown, SARIF pour l'intégration CI
• Hooks Git — revue automatique lors du commit
• Extension VS Code — revue depuis votre éditeur
• Historique des revues — suivre les améliorations au fil du temps
• Règles personnalisées — définir vos propres critères de revue
• Support multilingue — prompts de revue spécifiques à la langue

Licence

MIT — voir LICENSE