Zum Inhalt

CLI-Referenz

AI Code Reviewer Befehlsreferenz.

Hauptbefehl

ai-review [OPTIONS]

Verhalten:

  • In CI (GitHub Actions / GitLab CI) — erkennt automatisch den Kontext
  • Manuell — mĂŒssen --provider, --repo, --pr angeben

Subcommands

ai-review (ohne Subcommand) fĂŒhrt ein Review durch — abwĂ€rtskompatibel. Verwenden Sie ai-review discover, um Discovery eigenstĂ€ndig auszufĂŒhren.

Optionen

Option Kurz Beschreibung Standard
--provider -p CI-Provider Auto-Erkennung
--repo -r Repository (owner/repo) Auto-Erkennung
--pr PR/MR-Nummer Auto-Erkennung
--help Hilfe anzeigen
--version Version anzeigen

Provider

Wert Beschreibung
github GitHub (GitHub Actions)
gitlab GitLab (GitLab CI)

Verwendungsbeispiele

In CI (automatisch)

# GitHub Actions — alles automatisch
ai-review

# GitLab CI — alles automatisch
ai-review

Manuell fĂŒr GitHub

export AI_REVIEWER_GOOGLE_API_KEY=your_key
export AI_REVIEWER_GITHUB_TOKEN=your_token

ai-review --provider github --repo owner/repo --pr 123

Wo die Werte erhalten:

  • --repo — aus Repository-URL: github.com/owner/repo → owner/repo
  • --pr — Nummer aus URL: github.com/owner/repo/pull/123 → 123

Manuell fĂŒr GitLab

export AI_REVIEWER_GOOGLE_API_KEY=your_key
export AI_REVIEWER_GITLAB_TOKEN=your_token

ai-review --provider gitlab --repo owner/repo --pr 456

Wo die Werte erhalten:

  • --repo — Projektpfad aus URL: gitlab.com/group/project → group/project
  • --pr — MR-Nummer aus URL: gitlab.com/group/project/-/merge_requests/456 → 456

Kurzsyntax

ai-review -p github -r owner/repo --pr 123

Umgebungsvariablen

CLI liest Konfiguration aus Umgebungsvariablen:

Erforderlich

Variable Beschreibung
AI_REVIEWER_GOOGLE_API_KEY Gemini API-SchlĂŒssel
AI_REVIEWER_GITHUB_TOKEN GitHub-Token (fĂŒr GitHub)
AI_REVIEWER_GITLAB_TOKEN GitLab-Token (fĂŒr GitLab)

Fallback

Alte Namen ohne PrÀfix (z.B. GOOGLE_API_KEY) funktionieren weiterhin als Fallback.

Optional

Variable Beschreibung Standard
AI_REVIEWER_LANGUAGE Antwortsprache en
AI_REVIEWER_LANGUAGE_MODE Sprachmodus adaptive
AI_REVIEWER_GEMINI_MODEL Gemini-Modell gemini-2.5-flash
AI_REVIEWER_LOG_LEVEL Log-Level INFO
AI_REVIEWER_GITLAB_URL GitLab-URL https://gitlab.com

👉 VollstĂ€ndige Liste →

Auto-Erkennung

GitHub Actions

CLI verwendet automatisch:

Variable Beschreibung
GITHUB_ACTIONS Umgebungserkennung
GITHUB_REPOSITORY owner/repo
GITHUB_EVENT_PATH JSON mit PR-Details
GITHUB_REF Fallback fĂŒr PR-Nummer

GitLab CI

CLI verwendet automatisch:

Variable Beschreibung
GITLAB_CI Umgebungserkennung
CI_PROJECT_PATH owner/repo
CI_MERGE_REQUEST_IID MR-Nummer
CI_SERVER_URL GitLab-URL

Exit-Codes

Code Beschreibung
0 Erfolg
1 Fehler (Konfiguration, API, etc.)

Logging

Level

Level Beschreibung
DEBUG Detaillierte Informationen fĂŒr Debugging
INFO Allgemeine Informationen (Standard)
WARNING Warnungen
ERROR Fehler
CRITICAL Kritische Fehler

Konfiguration

export AI_REVIEWER_LOG_LEVEL=DEBUG
ai-review

Ausgabe

CLI verwendet Rich fĂŒr formatierte Ausgabe:

[12:34:56] INFO     Detected CI Provider: github
[12:34:56] INFO     Context extracted: owner/repo PR #123
[12:34:57] INFO     Fetching PR diff...
[12:34:58] INFO     Analyzing code with Gemini...
[12:35:02] INFO     Review completed successfully

Fehler

Konfigurationsfehler

Configuration Error: AI_REVIEWER_GOOGLE_API_KEY is too short (minimum 10 characters)

Ursache: UngĂŒltige Konfiguration.

Lösung: ÜberprĂŒfen Sie die Umgebungsvariablen.

Kontextfehler

Context Error: Could not determine PR number from GitHub Actions context.

Ursache: Workflow lĂ€uft nicht fĂŒr PR.

Lösung: Stellen Sie sicher, dass der Workflow on: pull_request hat.

Provider nicht erkannt

Error: Could not detect CI environment.
Please specify --provider, --repo, and --pr manually.

Ursache: AusfĂŒhrung außerhalb von CI.

Lösung: Geben Sie alle Parameter manuell an.

Discover-Befehl

Projektanalyse eigenstĂ€ndig ausfĂŒhren (ohne ein Review zu erstellen):

ai-review discover <REPO> [OPTIONS]

Argumente

Argument Beschreibung
REPO Repository (owner/repo)

Optionen

Option Kurz Beschreibung Standard
--provider -p Git-Provider github
--json Ausgabe als JSON false
--verbose -v Alle Details anzeigen (Conventions, CI-Tools, watch-files) false

Beispiele

# GitHub-Repository
ai-review discover owner/repo

# JSON-Ausgabe
ai-review discover owner/repo --json

# Verbose-Modus
ai-review discover owner/repo -v

# GitLab-Projekt
ai-review discover group/project -p gitlab

Beispielausgabe

🔍 Discovering project context...

Stack: Python (FastAPI) 3.13, uv
CI: ✅ .github/workflows/tests.yml — ruff, mypy, pytest

Attention Zones:
  ✅ Formatting — ruff format in CI
  ✅ Type checking — mypy --strict in CI
  ❌ Security scanning — No security scanner detected
  ⚠ Test coverage — no coverage threshold

Docker

AusfĂŒhrung ĂŒber Docker:

docker run --rm \
  -e AI_REVIEWER_GOOGLE_API_KEY=your_key \
  -e AI_REVIEWER_GITHUB_TOKEN=your_token \
  ghcr.io/konstziv/ai-code-reviewer:1 \
  --provider github \
  --repo owner/repo \
  --pr 123

Version

ai-review --version

AI Code Reviewer 0.1.0

Hilfe

ai-review --help

Usage: ai-review [OPTIONS]

  Run AI Code Reviewer.

  Automatically detects CI environment and reviews the current Pull Request.
  Can also be run manually by providing arguments.

Options:
  -p, --provider [github|gitlab]  CI provider (auto-detected if not provided)
  -r, --repo TEXT                 Repository name (e.g. owner/repo). Auto-detected in CI.
  --pr INTEGER                    Pull Request number. Auto-detected in CI.
  --help                          Show this message and exit.

NĂ€chster Schritt