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

# Planning on GitHub

> Generate comprehensive Coding Plans from your issues on the GitHub issue tracker.

export const ProPlusPlanBadge = ({tip = "This feature is available as part of the Pro+ plan and Enterprise plan. Please refer to our pricing page for more information about our plans and features.", title = "Pro+ Plan", cta = "Read more", href = "https://coderabbit.ai/pricing", disabled = false}) => {
  return <Tooltip tip={tip} cta={cta} href={href}>
        <Badge icon="shield-plus" disabled={disabled || undefined}>
            {title}
        </Badge>
    </Tooltip>;
};

export const GitHubBadge = ({tip = "This feature is available on GitHub and GitHub Enterprise.", title = "GitHub", cta, href, disabled = false}) => {
  return <Tooltip tip={tip} cta={cta} href={href}>
        <Badge icon="github" disabled={disabled || undefined}>
            {title}
        </Badge>
    </Tooltip>;
};

<GitHubBadge title="GitHub Cloud" tip="This feature is available for GitHub Cloud" /> <GitHubBadge title="GitHub Enterprise Cloud" tip="This feature is available for GitHub Enterprise Cloud" /> <GitHubBadge title="GitHub Enterprise Server" tip="GitHub Enterprise Server is not supported yet" cta="See CodeRabbit Plan instead" href="/plan" disabled /> | <ProPlusPlanBadge />

## Initiating Planning

### Manual Planning

There are two ways to trigger Planning manually:

<CardGroup cols={1}>
  <Card title="CodeRabbit Command" icon="terminal" horizontal="true">
    Comment `@coderabbitai plan` on any GitHub Issue to generate a plan.
  </Card>

  <Card title="Checkbox" icon="square-check-big" horizontal="true">
    When Issue Enrichment is enabled, CodeRabbit posts a comment on new issues
    with a **Create Plan** checkbox. Check the box to generate a plan.
  </Card>
</CardGroup>

### Auto-Planning (Recommended)

Automatically generate plans when specific labels are added to issues.

<Tabs>
  <Tab title="Using configuration file">
    ```yaml theme={null}
    issue_enrichment:
      planning:
        enabled: true
        auto_planning:
          enabled: true
          labels:
            - "plan-me" # Auto-plan issues with this label
            - "feature" # Also auto-plan these
            - "!no-plan" # Never auto-plan issues with this label
    ```
  </Tab>

  <Tab title="Using the Web Interface">
    To configure auto-planning labels in the CodeRabbit web app:

    1. Navigate to **Configuration → Issue Enrichment → Auto-Planning**
    2. Enable **Automatic Planning**
    3. Add your desired labels in the labels field:
       * Enter labels that should trigger auto-planning (e.g., `plan-me`, `feature`)
       * Use the `!` prefix for exclusion labels (e.g., `!no-plan`)
    4. Save your configuration

    The web interface provides the same functionality as the YAML configuration, allowing you to manage auto-planning labels without committing configuration files to your repository.
  </Tab>
</Tabs>

#### Label Matching Rules

| Configuration                    | Behavior                                                                      |
| -------------------------------- | ----------------------------------------------------------------------------- |
| Inclusion only (e.g., `feature`) | Plans only issues with at least one matching label                            |
| Exclusion only (e.g., `!wip`)    | Plans all issues except those with excluded labels                            |
| Mixed (e.g., `feature`, `!wip`)  | Plans issues that have an inclusion label AND don't have any exclusion labels |

<Info>
  Exclusion labels (starting with `!`) always take priority over inclusion
  labels.
</Info>

## Viewing and Refining Plans

Once a Coding Plan is generated, CodeRabbit posts the full plan as a comment on the issue.

<Frame caption="Coding Plan posted as a comment on a GitHub issue">
  <img src="https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/planning-github-comment.png?fit=max&auto=format&n=0_UNDuRPehZvImxS&q=85&s=720c50d5d557a1e5bc8838b37d0645f9" alt="Coding Plan posted as a comment on a GitHub issue" width="1856" height="1162" data-path="assets/images/planning-github-comment.png" />
</Frame>

### Chatting about Your Plan

Reply to the Coding Plan comment on the issue to:

* Ask questions about the plan or the codebase
* Request changes to specific tasks or phases
* Challenge design choices and provide additional context
* Get clarification on implementation details

<Frame caption="Discuss the Coding Plan with CodeRabbit">
  <img src="https://mintcdn.com/coderabbit/0_UNDuRPehZvImxS/assets/images/discuss-plan-github.png?fit=max&auto=format&n=0_UNDuRPehZvImxS&q=85&s=20700f2bb53bfe8150f9d191505ffde9" alt="Discuss the Coding Plan with CodeRabbit" width="500" data-path="assets/images/discuss-plan-github.png" />
</Frame>

### Re-planning

Once asked to make changes, CodeRabbit will respond to your comment and update the plan accordingly. You can also comment `@coderabbitai plan` again on the issue to regenerate the plan from scratch.

### Handing Off to a Coding Agent

Copy the agentic prompts from the Coding Plan comment on the issue, and paste them into your preferred coding agent (Claude Code, Cursor, GitHub Copilot, etc.).

Alternatively, if your coding agent can access GitHub directly (for example, through the GitHub MCP), you can simply ask it to `fetch the issue by its number and execute CodeRabbit's plan`.