> ## 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.

# Quickstart

> Set up CodeRabbit Agent for Slack for your workspace in a few steps. Connect Slack and GitHub, create the Base Scope, and start working.

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"
    },
    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"
    }
  };
  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>;
};

The setup flow connects your Slack workspace to GitHub, installs the CodeRabbit GitHub App for repository access, and creates a <Hint type="scope">Base Scope</Hint> that defines which repositories, connections, and spend controls apply by default. Once the Base Scope is saved, anyone in the workspace can mention `@coderabbit` in a channel, or open the CodeRabbit app to start a direct conversation.

## Prerequisites

Before you start, make sure you have:

* Permission to install or reauthorize apps in the Slack workspace
* A GitHub account that is a member of the organization whose repositories CodeRabbit Agent should access
* Permission to install the CodeRabbit GitHub App if it is not already installed

## Setup steps

<Steps>
  <Step title="Sign in with Slack">
    Go to [agent.coderabbit.ai](https://agent.coderabbit.ai/) to begin. Authenticate with Slack to establish the workspace identity.

    * **New workspace**: Click **Add to Slack** to trigger the full app install flow, grant workspace-level [Slack permissions](/slack-agent/slack-permissions), and enter the setup wizard.
    * **Returning to an existing workspace**: Click **Sign in with Slack**. CodeRabbit identifies the workspace and resumes from whichever setup stage was last completed.
  </Step>

  <Step title="Connect GitHub">
    Link the Slack workspace to the GitHub account or organization that should back CodeRabbit Agent. You will be redirected to GitHub to authorize access.
  </Step>

  <Step title="Install the CodeRabbit GitHub App">
    Install the [CodeRabbit GitHub App](https://github.com/apps/coderabbitai) so repository access becomes available to the workspace. CodeRabbit Agent may pause briefly while GitHub access propagates.
  </Step>

  <Step title="Create the Base Scope">
    Choose the default repositories, [connections](/slack-agent/connections), and spend baseline that should apply across the workspace. The [Base Scope](/slack-agent/scopes) is required before CodeRabbit Agent can be used.
  </Step>

  <Step title="Start using CodeRabbit Agent">
    Once the Base Scope is saved, open CodeRabbit from Slack's **Apps** sidebar or search for "CodeRabbit" in Slack — the Chat tab shows starter prompts to help you begin. You can also mention `@coderabbit` in any channel to start a conversation there. You can refine [scopes](/slack-agent/scopes), [connections](/slack-agent/connections), and [sandbox settings](/slack-agent/sandboxes) at any time.
  </Step>
</Steps>

## What the Base Scope does

The Base Scope is required to complete setup. It sets the default repositories, connections, and spend controls that apply across the workspace. Scopes can override or extend these defaults for specific channels or teams. See [Scopes](/slack-agent/scopes) for the full model.

## Resuming setup

The setup flow is resumable. If GitHub access is still propagating or a required step is incomplete, the Agent returns the workspace to the next missing requirement instead of forcing admins to start over.

<Info>
  Connecting GitHub and installing the CodeRabbit GitHub App are separate steps. A successful GitHub sign-in alone does not guarantee repository access.
</Info>

## Fixing an incorrect GitHub connection

If the wrong GitHub account or organization was connected, a global admin can reset the workspace GitHub connection from account settings and restart setup with the correct identity.

<Warning>
  Resetting the workspace GitHub connection is destructive. It removes existing scopes and workspace usage history for that Slack workspace. Treat it as a recovery path, not a normal reconfiguration step.
</Warning>

## What's next

<CardGroup cols={1}>
  <Card title="Working in Slack" href="/slack-agent/use-in-slack" icon="messages-square" horizontal>
    Learn how mentions and direct conversations work day to day.
  </Card>

  <Card title="Connections" href="/slack-agent/connections" icon="plug" horizontal>
    Add external systems like Jira, Notion, or Sentry for CodeRabbit Agent to use.
  </Card>

  <Card title="Scopes" href="/slack-agent/scopes" icon="shield" horizontal>
    Add scopes to tailor repositories, connections, and spend limits for specific channels or teams.
  </Card>
</CardGroup>