Skip to main content

​
Overview

CodeAlive AI Code Review automatically analyzes your pull requests, providing comprehensive feedback on code quality, security, performance, and best practices. Get instant, consistent reviews that help your team ship better code faster.

​
Key Features

Automatic Reviews

Reviews trigger automatically on PR creation and updates

Multi-Language Support

Support for 19+ programming languages

Customizable Focus

Configure review agents for specific concerns

Team Consistency

Maintain coding standards across your organization

​
Getting Started

1

Connect Your Repository Provider

Choose your version control platform:
Navigate to Providers → GitHub in your CodeAlive dashboard
2

Configure Review Settings

Set up your review preferences in the PR Reviews section
3

Create a Pull Request

CodeAlive will automatically review new PRs and updates

​
GitHub Integration

​
Installing the GitHub App

1

Access GitHub Settings

Navigate to Providers → GitHub in your CodeAlive dashboard
GitHub Integration Settings
2

Install GitHub App

  1. Click “Install GitHub App”
  2. You’ll be redirected to GitHub
  3. Select your organization or personal account
  4. Choose repository access:
    • All repositories - Recommended for organization-wide coverage
    • Selected repositories - Choose specific repositories
3

Authorize Installation

  1. Review the requested permissions
  2. Click “Install & Authorize”
  3. You’ll be redirected back to CodeAlive
  4. The status will show “GitHub App Successfully Installed”
4

Import Repositories

Once connected:
  • Click “Import Repositories” to add repos for indexing
  • Select the repositories you want to review
  • Wait for initial indexing to complete

​
GitLab Integration

​
Setting Up GitLab Access

1

Create Personal Access Token

In GitLab:
  1. Go to User Settings → Access Tokens
  2. Create a new token:
    • Name: CodeAlive
    • Expiration: Set as needed
    • Scopes: Select api and read_repository
  3. Copy the generated token
2

Configure in CodeAlive

  1. Navigate to Providers → GitLab in CodeAlive
  2. Paste your Personal Access Token
  3. Click “Token Set”
GitLab Integration Settings
3

Set Up Webhooks

Configure GitLab webhooks for automatic reviews:
  1. Copy the webhook URL from CodeAlive
  2. In your GitLab project:
    • Go to Settings → Webhooks
    • Add the CodeAlive webhook URL
    • Select triggers:
      • Merge request events
      • Comments
  3. Click “Secret Configured” in CodeAlive
4

Import Repositories

  • Click “Import Repositories”
  • Select GitLab projects to analyze
  • Complete the setup

​
Review Configuration

​
Customizing Review Behavior

Access review settings by clicking “Repository Review Configuration” in the PR Reviews section.
Review Configuration Settings

​
Quick Settings

Control the detail level of reviews:
  • Minimal (1): Critical issues only
  • Basic (2): Important problems
  • Balanced (3): Comprehensive review (recommended)
  • Detailed (4): Include minor issues
  • Thorough (5): Every possible improvement

​
Focus Areas

Enable or disable specific review agents:
Reviews code for potential security vulnerabilities, authentication issues, and data exposure risks
Analyzes code efficiency, identifies bottlenecks, and suggests optimizations
Evaluates code structure, design patterns, and architectural decisions
Checks for coding standards, naming conventions, and style consistency
Reviews overall code quality, maintainability, and best practices
Validates pull requests against linked Jira tasks to ensure requirements are met

​
General Instructions

Add custom guidelines that apply to all review agents. This is useful for:
  • Team-specific conventions
  • Project requirements
  • Domain-specific rules
  • Compliance standards
Example: 
- Follow our team's error handling patterns
- Ensure all API endpoints have proper authentication
- Use TypeScript strict mode conventions
- Include unit tests for new functions

​
Managing Reviews

​
PR Reviews Dashboard

The PR Reviews page shows all pull requests across your repositories:
PR Reviews Dashboard
Features:
  • Repository selector: Filter by repository
  • Import PRs: Manually import pull requests
  • Auto-refresh: Keep the list updated
  • Automatic Review: Toggle automatic reviews on/off

​
Review States

Pull requests can have the following states:
  • Review Scheduled: Queued for review
  • Review Completed: Review finished successfully
  • Re-analyze: Request a fresh review

​
Triggering Reviews

Reviews can be triggered in multiple ways:
Reviews trigger automatically when:
  • A new PR is created
  • Commits are pushed to an open PR
  • PR is updated or edited

​
Best Practices

Start Balanced

Begin with balanced settings (level 3) and adjust based on team feedback

Customize Gradually

Enable focus areas one at a time to understand their impact

Use Clear PR Titles

Descriptive PR titles help AI understand context better

Iterate on Config

Review and refine settings based on team needs

Set Team Guidelines

Use general instructions for team-specific rules

Monitor Feedback

Track which suggestions are most valuable

​
Troubleshooting

Check:
  • Automatic Review toggle is enabled
  • Repository is properly indexed
  • Webhooks are configured (GitLab)
  • GitHub App has proper permissions
Normal duration: 2-5 minutes depending on PR sizeIf longer:
  • Check repository indexing status
  • Verify API limits aren’t exceeded
  • Contact support if persistent
Verify:
  • All files in PR are in supported languages
  • PR isn’t too large (>1000 files)
  • Repository is fully indexed
  • Review configuration is saved
Steps:
  1. Verify webhook URL is correct
  2. Check webhook test in GitLab settings
  3. Ensure merge request events are selected
  4. Confirm secret token matches