English | 简体中文

Your Lightweight Local AI Code Review Assistant

Code Gate is an intelligent code review tool seamlessly integrated into your Git workflow. When you run git commit, it automatically analyzes staged code changes, utilizing local LLMs (Ollama) or cloud AI services to provide instant feedback on code quality, security suggestions, and optimization plans.

Supports zero-config execution via npx, npm/yarn/pnpm package integration, and automated Git Hook reviews, flexibly adapting to any development workflow.

• 🔒 Privacy First: Native support for Ollama local models.
• ☁️ Multi-Model Support: Seamlessly integrates with DeepSeek, OpenAI, Anthropic, Aliyun Qwen, Doubao, and more.
• 🌍 Multi-Language: Built-in support for English, Chinese (Simplified & Traditional), Japanese, Korean, German, and French.
• ⚡️ High Performance: Intelligent concurrent processing for faster reviews across multiple files.
• 🛠️ Highly Customizable: Custom prompts, file filtering rules, and review strategies.
• 📊 Visual Reports: Generates intuitive HTML review reports with clear diffs and AI suggestions.
• 📜 Review Logs: Automatically archives review history for easy reference and tracking.

All methods rely on the configuration file. Please add a .code-gate.js file to your project root first.

export default {
  provider: 'ollama', // Default using Ollama local model
  providerOptions: {
    ollama: {
      baseURL: 'http://localhost:11434',
      model: 'qwen2.5-coder',
      concurrencyFiles: 1
    },
    deepseek: {
      baseURL: 'https://api.deepseek.com',
      apiKeyEnv: 'DEEPSEEK_API_KEY',
      model: 'deepseek-chat',
      concurrencyFiles: 4,
      apiKey: 'sk-xxxx' // Replace with your API Key (Avoid exposing in public code)
    }
    // openai: { baseURL: 'https://api.openai.com/v1', apiKeyEnv: 'OPENAI_API_KEY', model: 'gpt-4o-mini' },
    // anthropic: { baseURL: 'https://api.anthropic.com', apiKeyEnv: 'ANTHROPIC_API_KEY', model: 'claude-3-5-sonnet' },
    // azureOpenAI: { endpoint: 'https://your-endpoint.openai.azure.com', apiKeyEnv: 'AZURE_OPENAI_KEY', deployment: 'gpt-4o-mini', apiVersion: '2024-08-01-preview' },
    // aliyun: { baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', apiKeyEnv: 'DASHSCOPE_API_KEY', model: 'qwen-plus' },
    // volcengine: { baseURL: 'https://ark.cn-beijing.volces.com/api/v3', apiKeyEnv: 'VOLCENGINE_API_KEY', model: 'doubao-pro-32k' },
    // zhipu: { baseURL: 'https://open.bigmodel.cn/api/paas/v4', apiKeyEnv: 'ZHIPU_API_KEY', model: 'glm-4' }
  },
  language: 'en',
  fileTypes: ['ts', 'tsx', 'css'],
  ui: {
    openBrowser: true,
    port: 5175
  },
  limits: {
    maxDiffLines: 10000,
    maxFiles: 100
  },
  prompt: `You are a senior code reviewer responsible for ensuring code quality and security meet high standards.

Project Info:
- [Fill in your project info: architecture, standards, business type, etc.]

Review Checklist:
- Code is clean and readable
- Proper naming conventions for functions and variables
- No code duplication
- Correct error handling
- Input validation implemented
- Performance considerations addressed

Provide feedback prioritized by:
- Critical Issues (Must fix)
- Warnings (Should fix)
- Suggestions (Consider improving, avoid unnecessary suggestions if not essential)

Provide specific examples on how to fix the issues.`,
  output: {
    dir: '.review-logs'
  }
}

Supported configuration formats include: .codegate.js, .codegate.ts, code-gate.config.js, .code-gaterc, code-gate.config.yaml etc. (supports js, ts, json, yaml extensions).

No installation required. Review the latest commit (or a specific commit) directly:

npx code-gate review <commit-hash>

Or review staged file changes:

npx code-gate review

Note: On first run, Code Gate automatically creates a default configuration file .code-gate.js.

Install code-gate as a development dependency in your project:

npm i -D code-gate

Add script command in package.json:

{
  "scripts": {
    "review": "code-gate review"
  }
}

Manually trigger reviews via script commands:

# Review staged changes
npm run review

# Review a specific commit
npm run review <commit-hash>

If you want to use the code-gate review command directly in the command line, you can install code-gate as a global dependency: npm i -g code-gate

The recommended way. Automatically intercepts git commit flows.

Install code-gate as a development dependency:

npm i -D code-gate

We provide a one-click initialization command to configure Git Hooks.

Automatic Init (Recommended)

# Interactive selection for Git Hooks or Husky
npx code-gate init

You can also specify arguments if you prefer a specific hook manager:

• Native Git Hooks: npx code-gate init -m git
• Husky: npx code-gate init -m husky

After initialization, you can choose to add the generated config file to .gitignore.

Just commit your code as usual, and Code Gate will automatically start the review:

git add .
git commit -m "feat: new feature"

Each Provider supports the following fields, with request option for timeout and retry control.

Key Parameters:

• baseURL: API base URL (e.g., https://api.deepseek.com or http://localhost:11434)
• apiKey: API Key (specified directly in config, not recommended for committing)
• apiKeyEnv: Environment variable name storing the API Key (Recommended, e.g., DEEPSEEK_API_KEY)
• model: Model name to use (e.g., deepseek-chat, qwen2.5-coder)
• concurrencyFiles: Number of concurrent file reviews (Recommended: Cloud API 4-8, Local Model 1)
• request: Advanced request configuration (see "Advanced Configuration" below)

Configure in providerOptions.<provider>.request to control request behavior:

Note: concurrencyFiles controls the number of concurrent file reviews (Default: DeepSeek=4, Ollama=1, Others=4).

Choose the appropriate configuration scheme based on your project needs. Taking deepseek as an example. For security, avoid hardcoding API Keys in the config file.

Option A: Config File

Set in .code-gate.js:

export default {
  providerOptions: {
    deepseek: {
      // ...other config
      apiKey: 'your-deepseek-api-key'
    }
  }
}

Option B: Git Hook Injection

Export temporarily in .githooks/pre-commit or .husky/pre-commit:

#!/bin/sh
export DEEPSEEK_API_KEY=[your-deepseek-api-key]
./node_modules/.bin/code-gate-hook

Option C: Environment Variables (Recommended)

Set in your .env file or system environment:

export DEEPSEEK_API_KEY=[your-deepseek-api-key]

Q: Report shows diffs but no AI suggestions?

• Check provider configuration.
• If using Ollama, ensure local service is running (ollama serve) and model is pulled (ollama pull qwen2.5-coder).
• If using Cloud API, check API Key validity and network connection.

Q: How to skip review in CI/CD? Code Gate detects non-interactive environments and skips automatically. To force skip, use git commit --no-verify.

MIT