यह क्या करता है

codereview आपके कोड को एक LLM को भेजता है और आपके टर्मिनल में सीधे एक संरचित, रंग-कोडित समीक्षा लौटाता है — जिसमें गंभीरता रेटिंग, पंक्ति संदर्भ और ठोस सुधार सुझाव शामिल होते हैं।

कोई ब्राउज़र नहीं। कोई PR आवश्यक नहीं। साथियों की प्रतीक्षा नहीं। बस:

codereview app.py

वास्तविक सुरक्षा कमज़ोरियों को पकड़ना — स्कोर 2/10

अपने स्वयं के सोर्स कोड की समीक्षा करना — स्कोर 9/10

क्यों

• एकल डेवलपर्स — बिना किसी की प्रतीक्षा किए दूसरी नज़र पाएं
• प्री-कमिट जाँच — PR तक पहुँचने से पहले बग्स पकड़ें
• सीखने का उपकरण — समझें कि कोड क्यों समस्याग्रस्त है, न कि सिर्फ इतना कि यह है
• CI एकीकरण — स्वचालित समीक्षा गेट के लिए अपने पाइपलाइन में जोड़ें
• मुफ्त — Groq (मुफ्त स्तर, कोई क्रेडिट कार्ड नहीं) या पूरी तरह से ऑफलाइन Ollama के साथ काम करता है

यह क्या पकड़ता है

इंस्टॉल

स्रोत से (अनुशंसित)

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

या मैन्युअल रूप से:

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

सभी निर्भरताएँ (rich, requests) स्वचालित रूप से इंस्टॉल हो जाती हैं। कॉन्फ़िगर करने के लिए कुछ नहीं।

त्वरित आरंभ (मुफ्त, 60 सेकंड)

codereview को आपके कोड का विश्लेषण करने के लिए एक LLM की आवश्यकता है। सबसे तेज़ मुफ्त विकल्प Groq है — कोई क्रेडिट कार्ड नहीं, कोई ट्रायल नहीं, बस मुफ्त।

चरण 1 — मुफ्त API कुंजी प्राप्त करें

1. console.groq.com पर जाएँ
2. Google या GitHub से साइन अप करें (30 सेकंड लगते हैं)
3. API Keys पर क्लिक करें फिर Create API Key पर क्लिक करें
4. कुंजी कॉपी करें (gsk_ से शुरू होती है)

चरण 2 — अपनी कुंजी सेट करें

export GROQ_API_KEY="gsk_your_key_here"

इसे स्थायी बनाने के लिए (ताकि हर टर्मिनल सत्र में इसे सेट न करना पड़े):

# zsh के लिए (Mac पर डिफ़ॉल्ट)
echo 'export GROQ_API_KEY="gsk_your_key_here"' >> ~/.zshrc
source ~/.zshrc

# bash के लिए (Linux पर डिफ़ॉल्ट)
echo 'export GROQ_API_KEY="gsk_your_key_here"' >> ~/.bashrc
source ~/.bashrc

चरण 3 — आरंभ करें

codereview --init groq

चरण 4 — कोड की समीक्षा करें

codereview yourfile.py

बस इतना ही। आप AI कोड समीक्षा चला रहे हैं।

पहली बार चला रहे हैं? बिना किसी तर्क के बस codereview टाइप करें और यह आपको पूरी सेटअप प्रक्रिया में मार्गदर्शन करेगा।

उपयोग

किसी फ़ाइल की समीक्षा करें

codereview app.py

कई फ़ाइलों की समीक्षा करें

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

स्टेज किए गए git परिवर्तनों की समीक्षा करें (प्री-कमिट)

git add .
codereview --staged

पिछले N कमिट की समीक्षा करें

codereview --last 3

ब्रांचों के बीच डिफ की समीक्षा करें

codereview --diff origin/main

stdin से कोड पाइप करें

cat suspicious_code.py | codereview --stdin

एक विशिष्ट मॉडल का उपयोग करें

codereview app.py --model gpt-4

एक समीक्षा के लिए विशिष्ट प्रदाता का उपयोग करें

codereview app.py --provider ollama

सेटअप निर्देश दिखाएँ

codereview --setup

प्रदाता

codereview किसी भी OpenAI-संगत API के साथ काम करता है। वह चुनें जो आपके लिए काम करे:

⚡ Groq (अनुशंसित — मुफ्त, तेज़)

export GROQ_API_KEY="gsk_your_key_here"
codereview --init groq

• लागत: मुफ्त स्तर, क्रेडिट कार्ड की आवश्यकता नहीं
• गति: उपलब्ध सबसे तेज़ इन्फ्रेंस
• मॉडल: Llama 3.3 70B
• कुंजी प्राप्त करें: console.groq.com

🏠 Ollama (मुफ्त, पूरी तरह से ऑफलाइन)

# 1. Ollama इंस्टॉल करें
# Mac: https://ollama.com से डाउनलोड करें
# Linux: curl -fsSL https://ollama.com/install.sh | sh

# 2. एक मॉडल खींचें
ollama pull llama3

# 3. सर्वर शुरू करें
ollama serve

# 4. आरंभ करें (API कुंजी की आवश्यकता नहीं)
codereview --init ollama

• लागत: हमेशा के लिए मुफ्त
• गति: आपके हार्डवेयर पर निर्भर करता है
• गोपनीयता: कोड कभी आपकी मशीन नहीं छोड़ता
• मॉडल: कोई भी मॉडल जो Ollama समर्थन करता है

🧠 OpenAI

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

• लागत: प्रति टोकन भुगतान
• मॉडल: GPT-3.5 Turbo (डिफ़ॉल्ट), GPT-4 --model gpt-4 के साथ
• कुंजी प्राप्त करें: platform.openai.com

🔮 Anthropic

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

• लागत: प्रति टोकन भुगतान
• मॉडल: Claude 3 Haiku (डिफ़ॉल्ट)
• कुंजी प्राप्त करें: console.anthropic.com

कॉन्फ़िगरेशन

कॉन्फ़िग ~/.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
}

API कुंजियाँ कभी भी कॉन्फ़िग फ़ाइल में संग्रहीत नहीं होतीं। वे केवल एनवायरनमेंट वेरिएबल से पढ़ी जाती हैं।

एनवायरनमेंट वेरिएबल के माध्यम से कुछ भी ओवरराइड करें

export CODEREVIEW_API_KEY="any-key"     # यूनिवर्सल ओवरराइड
export CODEREVIEW_MODEL="gpt-4"         # मॉडल ओवरराइड करें

CLI फ़्लैग के माध्यम से ओवरराइड करें

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

यह कैसे काम करता है

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

1. इनपुट — codereview आपकी फ़ाइल, git डिफ, स्टेज किए गए परिवर्तन, या stdin पढ़ता है
2. प्रॉम्प्ट — सख्त नियमों के साथ एक केंद्रित समीक्षा प्रॉम्प्ट बनाता है ताकि काल्पनिक मुद्दों को रोका जा सके
3. LLM — किसी भी OpenAI-संगत API (Groq, OpenAI, Anthropic, Ollama) को भेजता है
4. पार्स — LLM प्रतिक्रिया से संरचित JSON निकालता है
5. प्रदर्शन — आपके टर्मिनल में रंग-कोडित, गंभीरता-क्रमित निष्कर्ष रेंडर करता है

यह ChatGPT से कैसे अलग है

• संरचित आउटपुट — गंभीरता रेटिंग, फ़ाइल संदर्भ, ठोस सुझाव
• कोई भ्रम नहीं — प्रॉम्प्ट इंजीनियरिंग सुनिश्चित करती है कि LLM केवल उन मुद्दों को फ़्लैग करे जो वह आपके कोड में देख सकता है
• डिफ पर काम करता है — पूरे कोडबेस के बजाय केवल जो बदला है उसकी समीक्षा करें
• एक कमांड — ब्राउज़र में कॉपी-पेस्ट नहीं
• ऑफलाइन सक्षम — Ollama के साथ चलाएँ, आपका कोड कभी आपकी मशीन नहीं छोड़ता
• मुफ्त — कोई सब्सक्रिप्शन आवश्यक नहीं

उदाहरण

संदिग्ध फ़ाइल पर सुरक्षा ऑडिट

$ 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

स्टेज किए गए परिवर्तनों की प्री-कमिट समीक्षा

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

पुश करने से पहले पिछले 3 कमिट की समीक्षा करें

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

CI/CD में उपयोग करें

अपने 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 }}

प्रोजेक्ट संरचना

ai-code-review/
├── codereview/
│   ├── __init__.py          # संस्करण
│   ├── cli.py               # कमांड-लाइन इंटरफ़ेस + पहली बार चलने पर सेटअप
│   ├── reviewer.py          # LLM API कॉल + प्रतिक्रिया पार्सिंग
│   ├── formatter.py         # रिच टर्मिनल आउटपुट फ़ॉर्मेटिंग
│   ├── git_utils.py         # Git डिफ/फ़ाइल निष्कर्षण उपयोगिताएँ
│   └── config.py            # कॉन्फ़िगरेशन प्रबंधन + API कुंजी हैंडलिंग
├── tests/
│   ├── test_reviewer.py     # समीक्षा पार्सिंग परीक्षण
│   └── test_git_utils.py    # Git उपयोगिता परीक्षण
├── setup.py
├── pyproject.toml
├── LICENSE
└── README.md

समस्या निवारण

"No API key found"

आपने अपनी API कुंजी सेट नहीं की है। सबसे तेज़ मुफ्त विकल्प:

# 1. https://console.groq.com पर मुफ्त कुंजी प्राप्त करें
# 2. इसे सेट करें:
export GROQ_API_KEY="gsk_your_key_here"
codereview --init groq

"API error 403: error code 1010"

आपका HTTP क्लाइंट Cloudflare द्वारा अवरुद्ध किया जा रहा है। सुनिश्चित करें कि आप अपडेट हैं:

git pull
pip install -e .

"Model has been decommissioned"

मॉडल को हटा दिया गया है। नवीनतम मॉडल प्राप्त करने के लिए फिर से आरंभ करें:

codereview --init groq

"Connection refused" (Ollama)

Ollama सर्वर नहीं चल रहा है:

ollama serve

फिर एक नए टर्मिनल में पुनः प्रयास करें।

"No module named rich" या "No module named requests"

निर्भरताएँ इंस्टॉल नहीं हुईं। चलाएँ:

pip install rich requests

या पुनः इंस्टॉल करें:

pip install -e .

Command not found: codereview

इंस्टॉल ने इसे आपके PATH में नहीं जोड़ा। सीधे उपयोग करें:

python3 -m codereview.cli yourfile.py

या एक alias बनाएँ:

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

योगदान

PRs का स्वागत है! यह प्रोजेक्ट सक्रिय रूप से बनाए रखा जाता है।

डेव एनवायरनमेंट सेटअप करें

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

परीक्षण चलाएँ

pytest -v

कोड शैली

• सभी फ़ंक्शन पर टाइप हिंट का उपयोग करें
• सभी सार्वजनिक फ़ंक्शन के लिए डॉकस्ट्रिंग लिखें
• PEP 8 का पालन करें
• नई सुविधाओं के लिए परीक्षण जोड़ें

PR दिशानिर्देश

1. रिपॉजिटरी को फोर्क करें
2. एक फीचर ब्रांच बनाएँ: git checkout -b feat/my-feature
3. परिवर्तन करें और परीक्षण जोड़ें
4. pytest चलाएँ और सत्यापित करें
5. स्पष्ट विवरण के साथ PR सबमिट करें

रोडमैप

• निर्देशिका स्कैनिंग — codereview src/ सभी फ़ाइलों को पुनरावर्ती रूप से समीक्षा करता है
• कॉन्फ़िग प्रोफ़ाइल — codereview --profile work के साथ प्रदाताओं के बीच स्विच करें
• आउटपुट फ़ॉर्मेट — JSON, Markdown, SARIF CI एकीकरण के लिए
• Git हुक — git commit पर ऑटो-समीक्षा
• VS Code एक्सटेंशन — अपने एडिटर से समीक्षा करें
• समीक्षा इतिहास — समय के साथ सुधार ट्रैक करें
• कस्टम नियम — अपने स्वयं के समीक्षा मानदंड परिभाषित करें
• बहु-भाषा समर्थन — भाषा-विशिष्ट समीक्षा प्रॉम्प्ट

लाइसेंस

MIT — LICENSE देखें