Skip to main content

AI-powered code reviewer using OpenRouter LLMs

Project description

Iara - AI Code Reviewer 🧜‍♀️

🇧🇷 Leia em Português

Iara is an automated, project-agnostic, configurable code review tool designed to run in CI/CD pipelines or locally via CLI. It uses the OpenRouter API to access multiple LLM models (Llama 3, Gemini 2.0, etc.) for free or on paid plans.


Iara Code Review License: MIT


🚀 Features

  • Agnostic: Configure your project context (Tech Stack, Rules) via JSON.
  • Multi-Model: Support for multiple providers via OpenRouter.
  • Smart Fallback: Automatically tries free models if the preferred one fails.
  • Rules-Based (Static): Identifies dangerous patterns instantly without spending tokens (e.g., GetComponent in loops in Unity).
  • LLM-Based (Intelligent): Uses AI to understand logic, security, and context, going beyond syntax.
  • GitHub + GitLab: Native integration with both platforms, with automatic comments on PRs/MRs.
  • Multi-Language Reviews: Configure the output language — reviews can be written in English, Portuguese, Spanish, French, and more.

🧠 Capabilities

Iara combines different types of analysis for a complete review:

Type What does it do? Does Iara cover it? How?
Static Analysis Finds bugs by reading code (fast). Yes Via Extensions (Regex) and LLM.
Linting Fixes style and formatting. Yes LLM can suggest Clean Code.
SAST Finds security flaws in code. Yes Primary focus on vulnerability detection.
Dynamic Analysis Finds bugs by running the app (slow). ❌ No Focus on fast CI/CD (Code Review).

What does it detect?

  1. Unity / Game Dev:

    • Use of slow APIs (Find, GetComponent) in critical loops (Update).
    • Excessive memory allocation (Garbage Collection).
    • Excess logging (Debug.Log) in final builds.
  2. Security (General):

    • Hardcoded credentials (Passwords, API Keys).
    • Injection vulnerabilities (SQL, Command).
    • Missing input validation.
  3. Code Quality:

    • Complex or confusing logic.
    • Exception handling errors.
    • Refactoring suggestions for readability.

📦 Installation and Setup

1. Install

pip install iara-reviewer

2. Configure (Interactive Setup)

iara init

The wizard will guide you through 4 steps:

  • API Key — Asks for your OpenRouter key (free at openrouter.ai/keys), validates and saves it
  • Language — Choose the review output language (en, pt-br, es, fr, etc.)
  • Project — Name, tech stack, description
  • Preferences — Focus areas (Security, Performance, etc.)

Done! The API key is saved at ~/.iara/config.json and project config at .iara.json.

3. Use

git diff main | iara

Check authentication

iara auth status

Alternative setup (without wizard)

If you prefer to configure manually:

# Linux/Mac
export OPENROUTER_API_KEY="sk-or-..."

# Windows (PowerShell)
$env:OPENROUTER_API_KEY="sk-or-..."

API key resolution priority: environment variable > global config (~/.iara/config.json).

From source (Development)

git clone https://github.com/felipefernandes/iara.git
cd iara
pip install -e .

⚙️ Project Configuration

iara init automatically creates .iara.json. You can also create it manually:

{
  "project": {
    "name": "My Project",
    "description": "Project description.",
    "tech_stack": ["Python"]
  },
  "review": {
    "focus_areas": ["Performance", "Security"],
    "ignore_patterns": []
  },
  "model": {
    "preferred": "google/gemini-2.0-flash-exp:free",
    "fallback_enabled": true
  },
  "language": "en"
}

The language field controls the review output language. Supported values: en, pt-br, es, fr, de, ja, zh, ko, ru, or any language the LLM understands.

You can also override via environment variable:

export IARA_LANGUAGE="pt-br"

A ready-to-use example is available at iara-example.json.


🏃 How to Use

Via Pipe (Git Diff)

git diff main | iara

Via Environment Variable

export PR_DIFF=$(git diff main)
iara

Scan Mode (Static Analysis)

iara --scan ./path/to/project

Forcing a Model

export IARA_MODEL="meta-llama/llama-3.2-3b-instruct:free"
git diff | iara

🐙 GitHub Integration

Add Iara to your GitHub repository in 2 steps:

1. Configure the secret

Go to Settings > Secrets and variables > Actions > New repository secret and add:

  • Name: OPENROUTER_API_KEY
  • Value: your OpenRouter API key

2. Create the workflow

Create the file .github/workflows/iara-review.yml:

name: Iara Code Review

on:
  pull_request:
    types: [opened, synchronize]

permissions:
  pull-requests: write
  contents: read

jobs:
  review:
    runs-on: ubuntu-latest
    name: AI Code Review
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Run Iara Code Review
        uses: felipefernandes/iara@main
        with:
          openrouter_api_key: ${{ secrets.OPENROUTER_API_KEY }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Iara will automatically:

  • Review the Pull Request diff
  • Post a comment with the review result

Additional options

- uses: felipefernandes/iara@main
  with:
    openrouter_api_key: ${{ secrets.OPENROUTER_API_KEY }}
    model: "google/gemini-2.0-flash-exp:free" # Force model
    config_path: ".iara.json" # Config path
    post_comment: "true" # Post comment (default: true)
    language: "pt-br" # Review language

🦊 GitLab Integration

1. Configure variables

Go to Settings > CI/CD > Variables and add:

  • OPENROUTER_API_KEY: OpenRouter API key
  • GITLAB_TOKEN: Personal/Project Access Token with api scope (required for MR comments)

2. Add to .gitlab-ci.yml

stages:
  - review

iara_code_review:
  stage: review
  image: python:3.11-slim
  script:
    - apt-get update && apt-get install -y --no-install-recommends git curl
    - pip install iara-reviewer
    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    - export PR_DIFF=$(git diff origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...$CI_COMMIT_SHA)
    - REVIEW=$(iara 2>/tmp/iara_stderr.txt) || true
    - echo "$REVIEW"
    - |
      if [ -n "$REVIEW" ] && [ -n "$GITLAB_TOKEN" ]; then
        PAYLOAD=$(python3 -c "
      import sys, json
      review = '''$REVIEW'''
      body = '## 🧜‍♀️ Iara Code Review\n\n' + review + '\n\n---\n*Reviewed by Iara - AI Code Reviewer*'
      print(json.dumps({'body': body}))
      ")
        curl -s -X POST \
          -H "PRIVATE-TOKEN: $GITLAB_TOKEN" \
          -H "Content-Type: application/json" \
          -d "$PAYLOAD" \
          "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests/${CI_MERGE_REQUEST_IID}/notes"
      fi
  allow_failure: true
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"

Iara will automatically:

  • Review the Merge Request diff
  • Post a comment with the review result on the MR

A complete template is available at gitlab-ci.yml.


🔧 Any CI (Jenkins, CircleCI, etc.)

pip install iara-reviewer
export OPENROUTER_API_KEY="sk-or-..."
git diff main...HEAD | iara

🧪 Tests

python -m unittest discover tests

📜 License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iara_reviewer-1.3.1.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iara_reviewer-1.3.1-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file iara_reviewer-1.3.1.tar.gz.

File metadata

  • Download URL: iara_reviewer-1.3.1.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for iara_reviewer-1.3.1.tar.gz
Algorithm Hash digest
SHA256 1b4040b7f57ca304bb98d5b9eca7e56107998879f1aa8157e77d29163a8cf8e7
MD5 20fd74c9ca4ef7f33209d8b332f46446
BLAKE2b-256 9facbf78761d536209b582636e1d08a4f63bae7953b74f70fa3337a56bbc370c

See more details on using hashes here.

File details

Details for the file iara_reviewer-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: iara_reviewer-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for iara_reviewer-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cad65fa5ec70b272a54aafb077392bec9b537a561a9481c07253bb15b24a9b31
MD5 80ffa6f03e7e1a0d326c9c24c29e8b90
BLAKE2b-256 106016fd7fa93a77c268cf542cd8a43170601d38c030d70066678e85a67037f8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page