Что это такое

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_ваш_ключ"

Чтобы сделать его постоянным (чтобы не вводить каждый раз):

# Для zsh (по умолчанию на Mac)
echo 'export GROQ_API_KEY="gsk_ваш_ключ"' >> ~/.zshrc
source ~/.zshrc

# Для bash (по умолчанию на Linux)
echo 'export GROQ_API_KEY="gsk_ваш_ключ"' >> ~/.bashrc
source ~/.bashrc

Шаг 3 — Инициализируйте

codereview --init groq

Шаг 4 — Проверьте код

codereview ваш_файл.py

Всё. Вы запускаете проверку кода с ИИ.

В первый раз? Просто введите codereview без аргументов, и он проведёт вас через всю настройку.

Использование

Проверить файл

codereview app.py

Проверить несколько файлов

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

Проверить подготовленные изменения в git (перед коммитом)

git add .
codereview --staged

Проверить последние N коммитов

codereview --last 3

Проверить diff между ветками

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 работает с любым API, совместимым с OpenAI. Выбирайте то, что подходит вам:

⚡ Groq (рекомендуется — бесплатно, быстро)

export GROQ_API_KEY="gsk_ваш_ключ"
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="любой-ключ"     # Универсальное переопределение
export CODEREVIEW_MODEL="gpt-4"             # Переопределение модели

Переопределить через флаги CLI

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

Как это работает

Ваш код  -->  codereview CLI  -->  LLM API  -->  Структурированный вывод в терминал
(файл/diff)     (построитель промпта)    (любой провайдер)     (цветные результаты)

1. Ввод — codereview читает ваш файл, git diff, подготовленные изменения или stdin
2. Промпт — Формирует целенаправленный промпт для проверки со строгими правилами, чтобы избежать воображаемых проблем
3. LLM — Отправляет запрос к любому API, совместимому с OpenAI (Groq, OpenAI, Anthropic, Ollama)
4. Разбор — Извлекает структурированный JSON из ответа LLM
5. Отображение — Выводит цветные, отсортированные по серьёзности результаты в терминале

Чем это отличается от ChatGPT

• Структурированный вывод — Оценка серьёзности, ссылки на файлы, конкретные предложения
• Отсутствие галлюцинаций — Проектирование промпта гарантирует, что LLM помечает только те проблемы, которые видит в вашем коде
• Работа с diffs — Проверяет только то, что изменилось, а не всю кодовую базу
• Одна команда — Нет копирования в браузер
• Работа офлайн — Запуск с Ollama, ваш код никогда не покидает ваш компьютер
• Бесплатно — Без подписки

Примеры

Аудит безопасности подозрительного файла

$ codereview api/auth.py

Score: 3/10

🔴 CRITICAL — Жёстко закодированный JWT-секрет
   Секретный ключ жёстко закодирован на строке 12.
   Предложение: Используйте переменную окружения: os.environ["JWT_SECRET"]

🔴 CRITICAL — Отсутствие хеширования паролей
   Пароли хранятся в открытом виде на строке 34.
   Предложение: Используйте bcrypt: bcrypt.hashpw(password, bcrypt.gensalt())

🟡 WARNING — Токен никогда не истекает
   У JWT-токенов не задан срок действия.
   Предложение: Добавьте exp claim с timedelta

Проверка подготовленных изменений перед коммитом

$ git add .
$ codereview --staged

Score: 8/10

🔵 INFO — Рассмотрите возможность обработки ошибок
   Новая конечная точка API не перехватывает ConnectionError.
   Предложение: Оберните в try/except с логикой повтора.

Проверка последних 3 коммитов перед отправкой

$ codereview --last 3

Score: 9/10

⚪ STYLE — Непоследовательное именование
   Смесь snake_case и camelCase в utils.py
   Предложение: Придерживайтесь snake_case согласно PEP 8.

Использование в CI/CD

Добавьте в ваш 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 }}

Структура проекта

ai-code-review/
├── codereview/
│   ├── __init__.py          # Версия
│   ├── cli.py               # Интерфейс командной строки + настройка при первом запуске
│   ├── reviewer.py          # Вызовы LLM API + разбор ответов
│   ├── formatter.py         # Форматирование вывода в терминале с помощью rich
│   ├── git_utils.py         # Утилиты для извлечения git diff/файлов
│   └── 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_ваш_ключ"
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 ваш_файл.py

Или создайте alias:

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

Вклад

PR приветствуются! Проект активно поддерживается.

Настройка среды разработки

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

Запуск тестов

pytest -v

Стиль кода

• Используйте подсказки типов для всех функций
• Пишите docstring для всех публичных функций
• Следуйте 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 hooks — автоматическая проверка при git commit
• Расширение VS Code — проверка из редактора
• История проверок — отслеживание улучшений с течением времени
• Пользовательские правила — определите свои критерии проверки
• Поддержка нескольких языков — промпты для проверки с учётом языка

Лицензия

MIT — см. LICENSE