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

# Working in Slack

> Start work with CodeRabbit Agent from mentions, direct conversations, and slash commands.

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

Once your workspace is set up, most day-to-day use happens directly in Slack. You can start with an `@coderabbit` mention in any channel or thread, or open the CodeRabbit app to chat directly. Slash commands are also available for specific actions.

<Warning>
  CodeRabbit application for Slack uses AI (Large Language Models) to generate responses, which may occasionally be inaccurate. Verify important information independently because responses do not constitute professional advice. Some features, including the AI Agent/Assistant, require a paid Slack plan and may not be available on free plans.
</Warning>

## Entry points

| Entry point           | What it does                                                                                                                                                                                | Details                       |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `@coderabbit` mention | Investigate, explain, plan, or act on anything in the current conversation. The run uses the <Hint type="scope">scope</Hint> matching the current channel, thread, or DM.                   | [Scopes](/slack-agent/scopes) |
| Direct conversation   | Open CodeRabbit from Slack's **Apps** sidebar or search for "CodeRabbit" in Slack. The Chat tab shows starter prompts when empty and does not require an @mention — just type your message. | —                             |

### Slash commands

Slash commands provide shortcuts for specific actions. You can also trigger all of these actions by asking `@coderabbit` directly.

<Warning>
  Slash commands are only available in **channels**. They do not work in Direct Messages or threads. Use an `@coderabbit` mention instead when working in a DM or thread.
</Warning>

| Command        | What it does                                                                                 | Details                                       |
| -------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `/plan`        | Generate a structured implementation plan from a request or thread.                          | [Plans](/slack-agent/plans)                   |
| `/learn`       | Capture a durable fact from the current thread or from text you provide directly.            | [Knowledge Base](/slack-agent/knowledge-base) |
| `/automations` | List, create, or manage scheduled and message-triggered automations for the current channel. | [Automations](/slack-agent/automations)       |

## How conversation behavior works

CodeRabbit Agent behaves differently depending on the Slack surface:

<Tabs borderBottom>
  <Tab title="Direct conversations">
    Open CodeRabbit from the **Apps** sidebar or search for "CodeRabbit" in Slack to start a direct conversation. Each top-level message starts a new conversation. Threaded replies continue that same conversation. There is no need to @mention the bot — it stays active automatically.
  </Tab>

  <Tab title="Channel threads">
    A thread is armed when the bot is mentioned in the root message. Once armed, CodeRabbit Agent replies within that thread. If the thread remains single-player, continued interaction does not require re-mentioning.

    <Info>
      Once multiple humans participate in a thread, the Agent becomes more mention-driven to avoid taking over the conversation. Mention `@coderabbit` when you want it to respond.
    </Info>
  </Tab>
</Tabs>

<Tip>
  **CodeRabbit Agent uses the scope matching the current surface. You never need to select a scope manually.** The matching scope determines repositories, connections, spend limits, and knowledge privacy automatically.
</Tip>

<Warning>
  If multiple scopes match the current surface, requests are blocked as ambiguous rather than auto-selecting one. Learn more about [scope resolution and ambiguous matches](/slack-agent/scopes#one-scope-per-conversation).
</Warning>

## What determines what CodeRabbit Agent can use

Each run is governed by the scope that matches the current Slack surface.

That scope determines:

* Which repositories are available
* Which [connections](/slack-agent/connections) can be used
* What spend limit applies
* Whether the shared [sandbox](/slack-agent/sandboxes) is available
* Whether knowledge should be shared or private

## Who can use CodeRabbit Agent

CodeRabbit Agent responds to workspace members only.

<Warning>
  External users (guests) are blocked by default. Channels marked as externally shared are fully unsupported, and all bot usage is blocked in those channels.
</Warning>

## After a run

After completing a task, the Agent replies in the thread with its findings, a proposed plan, follow-up actions like opening a PR, or an offer to save what it learned to the [Knowledge Base](/slack-agent/knowledge-base).

For deeper inspection, the companion web app provides [thread reviews](/slack-agent/thread-reviews) for run-by-run execution detail, [usage](/slack-agent/usage) for workspace-wide activity, and [plans](/slack-agent/plans) for version comparison and agent handoff.

## Slack vs. the web app

| Use Slack when you want to...                                       | Use the web app when you want to...                                 |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| Ask CodeRabbit Agent to investigate, plan, learn, or act in context | Inspect what happened after a run in more detail                    |
| Manage automations from the conversation where they apply           | Configure scopes, connections, or sandbox settings                  |
| Confirm knowledge proposals from the same thread                    | Browse knowledge history, plans, usage, and thread review artifacts |

## What's next

<CardGroup cols={1}>
  <Card title="Scopes" href="/slack-agent/scopes" icon="shield" horizontal>
    Learn how CodeRabbit Agent decides which repositories, tools, and limits apply in each conversation.
  </Card>

  <Card title="Automations" href="/slack-agent/automations" icon="repeat" horizontal>
    See how recurring CodeRabbit Agent tasks work for channels and other Slack surfaces.
  </Card>

  <Card title="Plans" href="/slack-agent/plans" icon="list-checks" horizontal>
    Review how planning work moves from Slack into a structured implementation plan and handoff flow.
  </Card>
</CardGroup>