> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# IDE/CLI review metrics

> Detailed definitions for all CodeRabbit IDE and CLI review dashboard metrics.

export const Hint = ({type, children, headline, tip, href, cta}) => {
  const TIPS = {
    learnings: {
      headline: "Learnings",
      tip: "Review preferences CodeRabbit learns from your chat conversations and applies automatically to future reviews.",
      cta: "Learn about Learnings",
      href: "/knowledge-base/learnings",
      content: "Learnings"
    },
    walkthrough: {
      headline: "PR Walkthrough",
      tip: "A structured comment posted by CodeRabbit at the top of every pull request, summarizing changes, sequence diagrams, review effort, and more.",
      cta: "Learn about PR Walkthroughs",
      href: "/pr-reviews/walkthroughs",
      content: "Walkthrough"
    },
    "finishing-touches": {
      headline: "Finishing Touches",
      tip: "Post-review agentic actions (Autofix, writing docstrings or unit tests, and more) you trigger from a PR comment or a checkbox in the Walkthrough.",
      cta: "See all Finishing Touches",
      href: "/finishing-touches",
      content: "Finishing Touches"
    },
    "coding-plan": {
      headline: "Coding Plan",
      tip: "A detailed, codebase-aware implementation plan CodeRabbit generates from an issue or description, ready to hand off to any coding agent.",
      cta: "Learn about Coding Plans",
      href: "/plan",
      content: "Coding Plan"
    },
    "knowledge-base": {
      headline: "Knowledge Base",
      tip: "The collected context sources CodeRabbit draws on during reviews: Learnings, Code Guidelines, issue trackers, connected MCP servers, and cross-repo analysis.",
      cta: "Explore the Knowledge Base",
      href: "/knowledge-base",
      content: "Knowledge Base"
    },
    "path-instructions": {
      headline: "Path Instructions",
      tip: "Custom review rules that only apply to files matching a glob pattern, e.g. 'src/controllers/**'.",
      cta: "Configure path instructions",
      href: "/configuration/path-instructions",
      content: "Path Instructions"
    },
    "change-stack": {
      headline: "Change Stack",
      tip: "An improved code inspection interface that reorganizes a pull request from a flat file list into a structured, layer-by-layer walkthrough with range-specific summaries and diagrams when useful.",
      cta: "Learn about Change Stack",
      href: "/pr-reviews/change-stack",
      content: "Change Stack"
    },
    scope: {
      headline: "Scope",
      tip: "A named set of repositories, connections, and spend limits that controls what CodeRabbit Agent can access in a given Slack conversation.",
      cta: "Learn about Scopes",
      href: "/slack-agent/scopes",
      content: "Scope"
    },
    "coderabbit-agent": {
      headline: "CodeRabbit Agent for Slack",
      tip: "An AI agent built into Slack that investigates issues, generates implementation plans, and opens pull requests right from the Slack threads.",
      cta: "Explore CodeRabbit Agent",
      href: "/slack-agent",
      content: "CodeRabbit Agent"
    },
    "configuration-inheritance": {
      headline: "Configuration Inheritance",
      tip: "A setting that merges configuration values across multiple levels — repository YAML, central YAML, and UI settings — instead of using only the highest-priority source.",
      cta: "Learn about Configuration Inheritance",
      href: "/configuration/configuration-inheritance",
      content: "Configuration Inheritance"
    }
  };
  const defaults = TIPS[type] || ({});
  return <Tooltip headline={headline ?? defaults.headline} tip={tip ?? defaults.tip} cta={cta ?? defaults.cta} href={href ?? defaults.href}>
      {children ?? defaults.content}
    </Tooltip>;
};

## Summary

The Summary page provides a high-level overview of review activity across [IDE extensions](/ide/index) and the [CLI](/cli/index). Use it to understand adoption, see whether <Hint type="learnings" /> carry over to local reviews, and track tool findings.

**Active Repositories**: Total number of repositories where reviews were performed through IDE extensions or CLI.

**Active Users**: Number of active users who have used CodeRabbit IDE extensions or CLI for reviews.

**Reviews**: Total number of code reviews performed through IDE extensions or CLI.

**Review Comments**: Total review comments posted for reviews done through IDE extensions or CLI.

**Learnings Usage**: Percentage of IDE/CLI reviews that benefited from Learnings and total times applied.

**Path-based Instructions Usage**: Percentage of IDE/CLI reviews that benefited from <Hint type="path-instructions">path-based instructions</Hint> and total times applied.

**Tool Findings**: Automated tool findings from SAST and linter tools surfaced during reviews.

**Active Users by Extension Type**: Active users broken down by IDE extension or CLI.

**Reviews by Extension Type**: Distribution of code reviews across IDE extensions and CLI.

***

## Organization Trends

Track week-over-week adoption of IDE and CLI reviews across your team.

**Weekly Active Users**: Weekly trend of unique users performing reviews using each IDE extension or CLI.

**Weekly Reviews**: Weekly trend of reviews performed using each IDE extension or CLI.

**Weekly Avg Reviews per User**: Weekly trend of average number of reviews per active user.

**Weekly Review Comments**: Weekly trend of review comments posted through IDE extensions and CLI.

**Tool Findings by Tool Name**: Number of automated tool findings surfaced during reviews, grouped by individual tool.

**Tool Findings by Severity**: Number of automated tool findings surfaced during reviews, grouped by severity.

***

## Data Metrics

Drill down into individual user activity to identify who's actively using local reviews and where to focus adoption efforts.

**Active User Details**: Per-user summary of IDE extension and CLI review activity.

<Expandable title="Fields included">
  * **Full Name**: Full name of the user
  * **Username**: Username of the user
  * **Extension Type**: IDE extension or CLI used
  * **Installed**: When the extension or CLI was installed
  * **Last Used**: Timestamp of the user's most recent review
  * **Total Reviews**: Number of code reviews performed via CodeRabbit
  * **Total Review Comments**: Number of review comments posted by CodeRabbit
</Expandable>

## What's next

<CardGroup cols={1}>
  <Card title="IDE extension overview" href="/ide/index" icon="code" horizontal>
    Set up and use CodeRabbit's AI-powered code reviews directly in your IDE.
  </Card>

  <Card title="Command-line review tool" href="/cli/index" icon="square-terminal" horizontal>
    Run CodeRabbit reviews from the CLI to catch issues before you commit.
  </Card>

  <Card title="Dashboard overview" href="/guides/dashboard" icon="layout-dashboard" horizontal>
    Explore all dashboard sections and learn what each page helps you answer.
  </Card>
</CardGroup>