|
| 1 | +--- |
| 2 | +title: Use the VSCode extension |
| 3 | +description: How to review your code with the VSCode extension. |
| 4 | +--- |
| 5 | + |
| 6 | +This page is about using the CodeRabbit VSCode extension. For more information about the extension, see |
| 7 | +[Overview](/guides/about-vscode). To learn how to install the extension, see [Install the VSCode extension](/guides/install-vscode). |
| 8 | + |
| 9 | +## Review your code changes |
| 10 | + |
| 11 | +To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps: |
| 12 | + |
| 13 | +1. Click the CodeRabbit icon in the VSCode activity bar. The CodeRabbit sidebar appears. |
| 14 | + |
| 15 | +1. Refer to **Branch** in the CodeRabbit sidebar. If you want to compare your code changes |
| 16 | + to a branch other than the default that appears, then follow these steps: |
| 17 | + |
| 18 | + 1. Click the name of the base branch, which is `main` by default. A **Select a base branch** dialog appears, listing other branches in your local Git repository. |
| 19 | + |
| 20 | + 1. Select the name of a base branch to compare against. |
| 21 | + |
| 22 | +1. Select one of the review-action options from the menu at the bottom of the CodeRabbit sidebar: |
| 23 | + |
| 24 | + - To review all changes between the base branch and your current branch, including |
| 25 | + both committed and uncommitted changes, select **Review all changes**. This is the default selection. |
| 26 | + |
| 27 | + - To limit the review to only changes on your branch that you have committed, select **Review committed changes**. This includes both pushed and not-pushed commits on the current branch. |
| 28 | + |
| 29 | + - To limit the review to only uncommitted changes on your branch, select **Review all changes**. |
| 30 | + |
| 31 | +1. Refer to the list of **Files to review** in the sidebar. This list represents all of the files that the selected review style includes. To change this list of files, repeat the previous step to choose a different review style, or use Git features like `git stash` to remove changes to files. |
| 32 | + |
| 33 | +1. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review's progress. |
| 34 | + |
| 35 | +1. Wait for the review to complete. This might take several minutes. To cancel a review in progress, click **Stop the review**. |
| 36 | + |
| 37 | +## What's next |
| 38 | + |
| 39 | +- The CodeRabbit [Introduction](/overview/introduction) describes how you can complement the CodeRabbit VSCode extension by setting up automatic, full-featured code reviews on your remote repository's pull requests. |
0 commit comments