Skip to main content
The setup flow connects your Slack workspace to GitHub, installs the CodeRabbit GitHub App for repository access, and creates a Base Scope 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 DM to start their first 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 Slack Agent should access
  • Permission to install the CodeRabbit GitHub App if it is not already installed

​
Setup steps

1

Sign in with Slack

Start by authenticating 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, 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.
2

Connect GitHub

Link the Slack workspace to the GitHub account or organization that should back Slack Agent. You will be redirected to GitHub to authorize access.
3

Install the CodeRabbit GitHub App

Install the CodeRabbit GitHub App so repository access becomes available to the workspace. Slack Agent may pause briefly while GitHub access propagates.
4

Create the Base Scope

Choose the default repositories, connections, and spend baseline that should apply across the workspace. The Base Scope is required before Slack Agent can be used.
5

Start using Slack Agent

Once the Base Scope is saved, mention @coderabbit in any channel or DM to start your first conversation. You can refine scopes, connections, and sandbox settings at any time.

​
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 for the full model.

​
Resuming setup

The setup flow is resumable. If GitHub access is still propagating or a required step is incomplete, Slack Agent returns the workspace to the next missing requirement instead of forcing admins to start over.
Connecting GitHub and installing the CodeRabbit GitHub App are separate steps. A successful GitHub sign-in alone does not guarantee repository access.

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

​
What’s next

Working in Slack

Learn how mentions, slash commands, and assistant entry points work day to day.

Connections

Add external systems like Jira, Notion, or Sentry for Slack Agent to use.

Scopes

Add scopes to tailor repositories, connections, and spend limits for specific channels or teams.