The project reached OpenSSF Best Practices Gold level, so update the static status badge in all localized READMEs accordingly. The label changes from Silver to Gold and the color to metallic gold (D4AF37).
18 KiB
English | 简体中文 | 日本語 | 한국어 | Русский
Что такое Open Code Review?
Open Code Review — это CLI-инструмент для код-ревью на основе ИИ. Он появился как внутренний официальный ИИ-ассистент код-ревью Alibaba Group: за последние два года им воспользовались десятки тысяч разработчиков, и он выявил миллионы дефектов в коде. После тщательной проверки в огромных масштабах мы превратили его в open-source-проект для сообщества. Чтобы начать работу, достаточно настроить эндпоинт модели.
Инструмент читает git-диффы, отправляет изменённые файлы настраиваемой LLM через агента с поддержкой вызова инструментов (tool use) и генерирует структурированные ревью-комментарии с точностью до строки. Агент может читать полное содержимое файлов, искать по кодовой базе, заглядывать в другие изменённые файлы за контекстом и выполнять глубокое ревью — а не только давать поверхностные замечания по диффу. Помимо ревью диффов, ocr scan позволяет проверять файлы целиком — удобно для аудита незнакомой кодовой базы или каталогов без значимого диффа.
Подробнее на официальном сайте.
Бенчмарк
По сравнению с агентами общего назначения (Claude Code), Open Code Review при той же базовой модели достигает значительно более высоких показателей Precision и F1, потребляя лишь ~1/9 токенов и выполняя ревью быстрее. При этом показатель Recall ниже, чем у агентов общего назначения — это осознанный компромисс в пользу точности и минимального шума.
Бенчмарк собран на основе реальных код-ревью и включает 50 популярных open-source-репозиториев, 200 реальных пул-реквестов и 10 языков программирования. Разметку из 1 505 дефектов перекрёстно проверили более 80 ведущих инженеров.
| Метрика | Что измеряет | Почему важна |
|---|---|---|
| F1 | Гармоническое среднее precision и recall | Лучший единый показатель качества ревью |
| Precision | Доля найденных проблем, являющихся реальными дефектами | Выше = меньше ложных срабатываний |
| Recall | Доля реальных дефектов, которые были найдены | Выше = меньше пропущенных проблем |
| Avg Time | Время выполнения одного ревью | Влияет на задержки в CI-пайплайне |
| Avg Token | Суммарное потребление токенов за ревью | Прямо влияет на стоимость API |
Почему Open Code Review?
Проблема агентов общего назначения
Если вы использовали для код-ревью агентов общего назначения, например Claude Code со Skills, вы наверняка сталкивались с такими проблемами:
- Неполное покрытие — на крупных ченджсетах агенты склонны «срезать углы»: выборочно проверяют часть файлов и пропускают остальные.
- Дрейф позиций — найденные проблемы часто не совпадают с реальным местом в коде: номера строк и ссылки на файлы «уезжают» от цели.
- Нестабильное качество — Skills, управляемые естественным языком, трудно отлаживать, и качество ревью заметно колеблется при небольших изменениях промпта.
Первопричина: чисто языковая архитектура не накладывает жёстких ограничений на процесс ревью.
Ключевая идея: детерминированная инженерия × агент
Ключевая философия Open Code Review — сочетать детерминированную инженерию и агента так, чтобы каждый занимался тем, что у него получается лучше всего.
Детерминированная инженерия — жёсткие гарантии
Для тех шагов ревью, где нельзя ошибаться, корректность гарантирует инженерная логика, а не языковая модель:
- Точный отбор файлов — точно определяет, какие файлы нуждаются в ревью, а какие следует отфильтровать, гарантируя, что ни одно важное изменение не будет упущено.
- Группировка связанных файлов — объединяет связанные файлы в одну единицу ревью (например,
message_en.propertiesиmessage_zh.properties). Каждая группа обрабатывается отдельным субагентом в изолированном контексте. Подход «разделяй и властвуй» сохраняет стабильность при очень больших изменениях и позволяет выполнять ревью параллельно. - Точное сопоставление правил — подбирает правила ревью с учётом особенностей каждого файла, удерживая внимание модели на задаче и устраняя лишний информационный шум. Сопоставление по шаблонам работает стабильнее и предсказуемее, чем управление правилами только на естественном языке.
- Внешние модули позиционирования и рефлексии — независимые модули позиционирования комментариев и рефлексии над комментариями системно повышают точность как расположения, так и содержания замечаний ИИ.
Агент — динамические решения
Сильные стороны агента сосредоточены там, где они важнее всего, — в динамических решениях и динамическом доборе контекста:
- Промпты, заточенные под сценарий — шаблоны промптов, глубоко оптимизированные под код-ревью: выше качество при меньшем расходе токенов.
- Специализированный набор инструментов — создан на основе анализа вызовов инструментов в реальных проектах: частоты вызовов, доли повторных обращений к каждому инструменту и влияния новых инструментов на всю цепочку. Такой набор работает при код-ревью стабильнее и предсказуемее, чем универсальные инструменты агента.
Как использовать
Предварительные требования
- Git >= 2.41 — Open Code Review использует Git для генерации diff, поиска по коду и операций с репозиторием.
CLI
Установка
npm install -g @alibaba-group/open-code-review
После установки команда ocr доступна глобально.
Другие способы установки (скрипт установки, бинарный файл из GitHub Release, сборка из исходников) описаны в руководстве по установке.
Быстрый старт
1. Настройте LLM
Перед запуском ревью необходимо настроить LLM, если только вы не используете режим делегирования.
ocr config provider # Выбрать встроенного провайдера или добавить пользовательский
ocr config model # Выбрать модель для активного провайдера
Интерактивный UI проведёт вас через выбор провайдера, ввод API-ключа и настройку модели, после чего автоматически проверит подключение.
Настройка через CLI, переменные окружения, пользовательские провайдеры и другие расширенные параметры описаны в руководстве по конфигурации.
2. Запустите ревью
cd your-project
# Режим рабочей копии — ревью всех staged, unstaged и untracked изменений
ocr review
# Диапазон веток — сравнение двух ref'ов
ocr review --from main --to feature-branch
# Один коммит
ocr review --commit abc123
# Возобновить прерванное ревью диапазона или одного коммита
ocr session list
ocr review --from main --to feature-branch --resume <session-id>
# Полнофайловое сканирование — ревью целых файлов вместо диффа (история git не нужна)
ocr scan # сканировать весь репозиторий
ocr scan --path internal/agent # сканировать каталог или конкретные файлы
ocr scan --resume <session-id> # возобновить прерванное полнофайловое сканирование
# Режим делегирования — ИИ-агент сам выполняет ревью
# OCR отвечает за выбор файлов и разрешение правил; настройка LLM не требуется
ocr delegate preview
ocr delegate rule src/main.go src/handler.go
Документация
Полная документация доступна на open-codereview.ai/docs:
- Быстрый старт — установка и запуск первого ревью
- Установка — все платформы и менеджеры пакетов
- Справочник CLI — все команды и флаги
- Правила ревью — кастомизация правил ревью, фильтрация и таргетинг по путям
- Конфигурация — ключи конфигурации и переменные окружения
- MCP-сервер — расширение агента ревью внешними инструментами
- Интеграции с кодинг-агентами — выберите используемую платформу
- Claude Code — установка плагина со slash-командами для ревью
- Codex — установка плагина с вызываемыми навыками ревью
- Cursor — установка плагина с переносимыми навыками ревью
- OpenCode — установка нативных инструментов ревью и slash-команд
- Агенты с поддержкой Skill — установка переносимого навыка агента
- Режимы выполнения ревью — после интеграции выберите, какая LLM выполняет ревью
- По умолчанию (под управлением OCR) — OCR выполняет ревью с помощью настроенной LLM
- Режим делегирования — кодинг-агент выполняет ревью с помощью собственной LLM; API-ключ для OCR не требуется
- Интеграция с CI/CD — GitHub Actions, GitLab CI, GitFlic CI и Gerrit
- Просмотр сессий — просмотр и воспроизведение сессий ревью в браузере
- Телеметрия — интеграция с OpenTelemetry для наблюдаемости
- FAQ — частые вопросы и устранение неполадок
Участие в разработке
Этот проект существует благодаря всем, кто вносит свой вклад. В CONTRIBUTING.ru-RU.md описаны настройка окружения разработки, рекомендации по коду и порядок отправки пул-реквестов.
Лицензия
Apache-2.0 — Copyright 2026 Alibaba


