Codex Code Reviewer

OpenAI Codex SDK를 사용하여 구축된 AI 기반 코드 리뷰 CLI 도구입니다. 버그, 보안 문제, 성능 문제 및 스타일 위반 사항에 대해 코드를 자동으로 분석합니다.

기능 (Features)

✨ 자동화된 코드 리뷰 (Automated Code Reviews) - AI 기반 분석을 통해 전체 코드베이스 또는 특정 파일을 검토합니다.
🔍 Git Diff 분석 (Git Diff Analysis) - 병합(merging) 전에 풀 리퀘스트와 커밋을 분석합니다.
💬 PR 댓글 생성 (PR Comment Generation) - GitHub PR에 적용 가능한 인라인 리뷰 댓글을 생성합니다.
🚨 CI 품질 게이트 (CI Quality Gates) - 구성 가능한 심각도 임계값으로 중요 문제 발생 시 빌드를 실패시킵니다.
📊 다중 출력 형식 (Multiple Output Formats) - JSON, SARIF (GitHub Code Scanning), Markdown 요약본을 지원합니다.
🎯 기준선 지원 (Baseline Support) - 새로운 문제에 대해서만 실패를 보고하고 시간이 지남에 따라 기술 부채(technical debt)를 추적합니다.
⚡ 최적화된 성능 (Optimized Performance) - 스레드 캐싱, diff 최소화, 타임아웃 제어 기능을 제공합니다.
🎯 중요 이슈 집중 (Critical Issue Focus) - 데드 코드(dead code), 비동기 버그(async bugs), 타입 오류(type errors), 보안 취약점(security vulnerabilities)을 감지합니다.
🚀 Codex 기반 작동 (Powered by Codex) - 지능형 코드 분석을 위해 최신 OpenAI Codex 에이전트를 사용합니다.

전제 조건 (Prerequisites)

• Node.js 18 이상
• OpenAI Codex CLI를 전역으로 설치해야 합니다:
  복사

npm install -g @openai/codex

## 설치 (Installation)

```bash
npm install
npm run build

또는 전역으로 설치할 수 있습니다:

npm install -g .

사용법 (Usage)

코드 검토 (Review Code)

파일 또는 디렉터리를 검색하여 문제를 검토합니다:

codex-review review [paths...] 

옵션:

• -o, --output <file> - 결과 출력 파일 (기본값: review-results.json)
• --focus <areas> - 쉼표로 구분된 집중 영역 (기본값: security,performance,bugs,style)

예시:

# 현재 디렉터리 검토
codex-review review

...

출력:

{
  

**옵션:**
- `-b, --branch <브랜치>` - 브랜치를 기준으로 비교합니다 (기본값: `main`)
- `-c, --commit <sha>` - 특정 커밋을 분석합니다
- `-o, --output <파일>` - 주석 출력 파일입니다 (기본값: `pr-comments.json`)

**예시:**

```bash
# main 브랜치 대비 변경 사항에 대한 주석 생성
codex-review pr-comments

...

출력:

[
  {
    "path": "src/auth.ts",
...

주요 분석 영역:

• 데드 코드/도달 불가능한 코드 (Dead/unreachable code)
• 깨진 제어 흐름 (Broken control flow) (break 누락, fallthrough 등)
• Async/await 실수
• React 뮤테이션 버그
• UseEffect 의존성 문제
• 연산자 오류 (==, &&, 조건문 내 할당)
• 오프바이원 오류 (Off-by-one errors)
• 타입 강제 변환 버그 (Type coercion bugs)
• Null/undefined 역참조
• 리소스 누수 (Resource leaks)
• SQL/XSS 삽입
• 레이스 컨디션 (Race conditions)
• 누락된 오류 처리

Git Diff 분석

병합 추천과 함께 포괄적인 분석을 받으려면:

codex-review diff

옵션:

• -b, --branch <브랜치> - 브랜치를 기준으로 비교합니다 (기본값: main)
• -c, --commit <sha> - 특정 커밋을 분석합니다
• -o, --output <파일> - 결과 출력 파일입니다 (기본값: diff-analysis.json)

예시:

# main 브랜치 대비 diff 분석
codex-review diff

...

출력:

{
  "overall_assessment": "변경 사항은 좋은 테스트 커버리지를 가진 새로운 인증 기능을 도입합니다...",
  "should_merge": true,
...

CI/CD 통합

PR을 자동으로 검토하려면 CI 파이프라인에서 사용하세요:

GitHub Actions - 리뷰 주석 게시

name: Automated Code Review

on: [pull_request]
...

GitHub Actions - 분석만 수행

name: Code Review Analysis

on: [pull_request]
...

GitLab CI

code_review:
  image: node:18
  script:
...

설정 (Configuration)

이 도구는 다음 환경 변수를 인식합니다:

• OPENAI_API_KEY - 사용자의 OpenAI API 키
• CODEX_API_KEY - OPENAI_API_KEY의 대안
• OPENAI_BASE_URL - 사용자 지정 API 엔드포인트 (선택 사항)

작동 방식 (How It Works)

이 도구는 OpenAI Codex SDK를 사용하여 다음을 수행합니다:

1. Codex 에이전트 스레드 시작하기
2. 컨텍스트로 코드 제공하기
3. JSON 스키마를 사용하여 구조화된 분석 요청하기 (Zod 이용)
4. 결과 파싱 및 포맷팅하기

Codex 에이전트는 다음 기능에 접근할 수 있습니다:

• 파일 읽기 및 분석 도구
• Git 작업 수행
• 코드 검색 기능
• 모범 사례를 위한 웹 검색

개발

# 의존성 설치하기
npm install

...

라이선스

MIT

작성자

Jonathan Haas

링크

• OpenAI Codex
• Codex CLI 문서
• GitHub 리포지토리