CR - Code Review Tool

A terminal-based code review tool from git changes (before commit) with AI assistance using Google's Gemini API.

Features

1. Index code: Index current code in your project directory
2. Initialize configuration: Set up the CR tool with a configuration file (CR.json)
3. Review code changes: Automatically review git changes with AI assistance
4. Git integration: Set up git hooks to run code review automatically on commit
5. Customizable rules: Define your own code review rules
6. AI-powered: Uses Google's Gemini API for intelligent code review

Installation

npm install -g cr-ai

Configuration

The tool uses a CR.json file for configuration with the following structure:

{
    "index_source_path": "path to index source code",
    "rules": [
        "Check for security vulnerabilities",
        "Ensure proper error handling",
        "Verify code follows best practices"
    ],
    "gemini_api_key": "your gemini api key",
    "model_name": "gemini-2.0-flash",
    "instruction": "Review this code for bugs, security issues, and best practices.",
    "use_colors": true,
    "light_review": false
}

The model_name field specifies which Gemini model to use for code review. Supported models:

• gemini-2.0-flash (default): Faster, more efficient model
• gemini-1.5-flash: Balanced performance model
• gemini-2.5-flash-preview-04-17: Latest preview model with advanced capabilities

The use_colors field controls whether the code review output uses colored formatting:

• true (default): Display code reviews with colorful headers and syntax highlighting
• false: Display code reviews in plain text without colors

The light_review field controls the level of detail in code reviews:

• false (default): Full review with all sections (SUMMARY, ISSUES, SUGGESTIONS, BEST PRACTICES, etc.)
• true: Light review with only ISSUES and BEST PRACTICES sections

Usage

Initialize the tool

cr init

This will guide you through creating a CR.json configuration file.

Index your code

cr index

This will scan and index your codebase for better context during reviews.

Review code changes

cr changes

This will analyze your git changes and provide AI-powered code review feedback.

Set up git hooks

cr integrate

This will set up git hooks to automatically run code review on commit using Husky. The command preserves any existing pre-commit hooks, so it's safe to use in projects that already have other hooks configured (like ESLint).

Manage AI models

List available models

cr model list

This will display all available AI models for code review.

Show current model

cr model show

This will display the currently configured AI model.

Change the model

cr model change

This will allow you to select a different AI model for code review.

Requirements

• Node.js >= 18 (required, the tool will warn you if using an older version)
• Git repository (for the changes and integrate commands)
• Gemini API key (optional, but recommended for AI features)
• Husky (automatically installed by the integrate command)

License

MIT