diff --git a/.nav.yml b/.nav.yml index cf40f721..c611f654 100644 --- a/.nav.yml +++ b/.nav.yml @@ -3,7 +3,7 @@ nav: - ':custom-sparkles: Review Modes': code-reviews/review-modes.md - ':custom-rocket: Get Started': code-reviews/get-started - ':custom-monitor: IDE Reviews': code-reviews/ide-reviews -# - ':custom-git: PR Reviews': code-reviews/pr-reviews + - ':custom-git: PR Reviews': code-reviews/pr-reviews - ':custom-folder: Repo Reviews': code-reviews/repo-reviews - ':custom-terminal: CLI': code-reviews/cli - ':custom-database: External Knowledge': code-reviews/external-knowledge diff --git a/.snippets/text/code-reviews/pr-reviews-enterprise.md b/.snippets/text/code-reviews/pr-reviews-enterprise.md new file mode 100644 index 00000000..1b89e73a --- /dev/null +++ b/.snippets/text/code-reviews/pr-reviews-enterprise.md @@ -0,0 +1,2 @@ +!!! note "Enterprise plan" + PR Reviews is available exclusively on the Enterprise plan. To enable PR Reviews for your organization, contact the kluster.ai team at [sales@kluster.ai](mailto:sales@kluster.ai){target=\_blank}. \ No newline at end of file diff --git a/code-reviews/configuration/rules.md b/code-reviews/configuration/rules.md index 32febdf3..106f4e92 100644 --- a/code-reviews/configuration/rules.md +++ b/code-reviews/configuration/rules.md @@ -28,9 +28,9 @@ To accommodate different workflows, Code Reviews supports two types of rules: ![Connect to GitHub](/images/code-reviews/configuration/rules/rules-01.webp) !!! note - Rule extraction and project-specific learned rules are currently available for GitHub repositories only. GitLab and Bitbucket do not support automatic rule extraction at this time. Azure DevOps does not support custom rules of any kind, including manual rules. + Rule extraction and project-specific learned rules are currently available for GitHub repositories only. GitLab and Bitbucket do not support automatic rule extraction at this time. Azure DevOps repositories in Code Reviews do not support custom rules of any kind, including manual and learned rules. -3. Click **Add review rule** to create custom rules. +3. For GitHub, GitLab, and Bitbucket providers, click **Add review rule** to create custom rules. ![Add review rule button](/images/code-reviews/configuration/rules/rules-02.webp) diff --git a/code-reviews/get-started/installation.md b/code-reviews/get-started/installation.md index 2844aa55..aaab6f44 100644 --- a/code-reviews/get-started/installation.md +++ b/code-reviews/get-started/installation.md @@ -57,6 +57,10 @@ Before getting started, ensure you have: ![Active MCP Tools in VS Code](/images/code-reviews/get-started/installation/vscode/vscode-integration-6.webp) + **Uninstall** + + To remove kluster.ai from VS Code, open the Extensions panel, find **Kluster Code Reviews**, and click **Uninstall**. + === "Cursor" 1. Click the **Add to Cursor** button below. @@ -79,6 +83,10 @@ Before getting started, ensure you have: ![Active MCP Tools in Cursor](/images/code-reviews/get-started/installation/cursor/cursor-integration-2.webp) + **Uninstall** + + To remove kluster.ai from Cursor, open **Settings** > **Extensions**, find **Kluster Code Reviews**, and click **Uninstall**. + === "JetBrains" !!! warning "AI coding agent support" @@ -120,6 +128,10 @@ Before getting started, ensure you have: ![Active kluster.ai plugin in JetBrains](/images/code-reviews/get-started/installation/jetbrains/jetbrains-integration-5.webp) + **Uninstall** + + To remove kluster.ai from your JetBrains IDE, go to **Settings** > **Plugins**, find **kluster.ai**, and click **Uninstall**. Restart the IDE when prompted. + === "Windsurf" 1. Click the **Add to Windsurf** button below. @@ -161,6 +173,10 @@ Before getting started, ensure you have: ![Active MCP Tools in Windsurf](/images/code-reviews/get-started/installation/windsurf/windsurf-integration-7.webp) + **Uninstall** + + To remove kluster.ai from Windsurf, open the Extensions panel, find **Kluster Code Reviews**, and click **Uninstall**. + === "Antigravity" 1. Click the **Add to Antigravity** button below. @@ -198,6 +214,10 @@ Before getting started, ensure you have: ![Active MCP Tools in Antigravity](/images/code-reviews/get-started/installation/antigravity/antigravity-integration-6.webp) + **Uninstall** + + To remove kluster.ai from Antigravity, open the Extensions panel, find **Kluster Code Reviews**, and click **Uninstall**. + ### Terminal tools === "Claude Code" @@ -237,6 +257,14 @@ Before getting started, ensure you have: ![Claude Code Installation Demo](/images/code-reviews/get-started/installation/claudecode/claude.gif) + **Uninstall** + + To remove kluster.ai from Claude Code, run: + + ```bash + npx -y @klusterai/ide-installer@latest uninstall claude + ``` + === "Codex CLI" **Terminal installation** @@ -270,6 +298,14 @@ Before getting started, ensure you have: ![Codex CLI Installation Demo](/images/code-reviews/get-started/installation/codex-cli/codex-cli.gif) + **Uninstall** + + To remove kluster.ai from Codex CLI, run: + + ```bash + npx -y @klusterai/ide-installer@latest uninstall codex + ``` + === "CLI (Standalone)" kluster-cli is a standalone command-line tool that works without an IDE or AI assistant. Install it directly on macOS, Linux, or Windows. @@ -296,6 +332,10 @@ Before getting started, ensure you have: [:octicons-arrow-right-24: CLI quickstart](/code-reviews/cli/quickstart/) + **Uninstall** + + To remove the kluster CLI, see the [CLI installation guide](/code-reviews/cli/installation/) for platform-specific uninstall instructions. + ## Next steps - **[Human-written code](/code-reviews/ide-reviews/human-written-code/on-demand-reviews/)**: Learn about on-demand reviews in your editor diff --git a/code-reviews/pr-reviews/azure-devops.md b/code-reviews/pr-reviews/azure-devops.md index f39345db..26a4dceb 100644 --- a/code-reviews/pr-reviews/azure-devops.md +++ b/code-reviews/pr-reviews/azure-devops.md @@ -12,6 +12,8 @@ Before connecting, an administrator in your Azure DevOps organization must compl Once connected, the bot reviews every new pull request and every new commit pushed to an open pull request. No additional configuration is needed. +--8<-- 'text/code-reviews/pr-reviews-enterprise.md' + --8<-- 'text/code-reviews/pr-reviews-tip.md' !!! warning "Custom rules not supported" @@ -22,9 +24,12 @@ Once connected, the bot reviews every new pull request and every new commit push Before getting started, ensure you have: - A [kluster.ai](https://platform.kluster.ai/signup){target=\_blank} account. -- An Azure DevOps account with at least **Basic** access to the projects you want to review. +- An Azure DevOps account that is a member of **Project Collection Administrators** in your organization. - A personal access token with the required scopes. See [Create a personal access token](#create-a-personal-access-token) for instructions. +!!! warning "Verify account permissions" + The account that generates the personal access token must be a member of **Project Collection Administrators**. Having the correct token scopes is not enough — the account itself needs this role to install webhooks. If the account has insufficient permissions, webhook installation will fail silently and pull request reviews will not appear. To fix this, navigate to **Organization Settings** > **Security** > **Permissions**, find the user, and add them to **Project Collection Administrators**. After updating permissions, click **Re-install** on the PR Reviews page in the kluster.ai platform to complete the setup. + ## Admin consent Before anyone in your organization can connect kluster to Azure DevOps, an administrator or organization owner must grant consent. This is a one-time step per organization that applies to both PR reviews and repo reviews. diff --git a/code-reviews/pr-reviews/bitbucket.md b/code-reviews/pr-reviews/bitbucket.md index c2937d07..5bf4fbcb 100644 --- a/code-reviews/pr-reviews/bitbucket.md +++ b/code-reviews/pr-reviews/bitbucket.md @@ -10,6 +10,8 @@ Connect the [kluster.ai](https://www.kluster.ai/){target=\_blank} bot to your Bi Once connected, the bot reviews every new pull request and every new commit pushed to an open pull request. No additional configuration is needed. +--8<-- 'text/code-reviews/pr-reviews-enterprise.md' + --8<-- 'text/code-reviews/pr-reviews-tip.md' ## Prerequisites @@ -20,6 +22,9 @@ Before getting started, ensure you have: - A Bitbucket account with **developer** access to the repositories you want to review. - A Bitbucket API token. See [Create an API token](#create-an-api-token) for instructions. +!!! warning "Verify account permissions" + The account that generates the API token must have at least **developer** access to the target repositories. Having the correct token scopes is not enough — the account itself needs developer-level permissions. If the account has insufficient access, webhook installation will fail and pull request reviews will not appear. After fixing the account's permissions, click **Re-install** on the PR Reviews page in the kluster.ai platform to complete the setup. + ## Create an API token The kluster.ai bot requires a Bitbucket API token to access your repositories and post review comments. Tokens are created through your Atlassian account settings. diff --git a/code-reviews/pr-reviews/github.md b/code-reviews/pr-reviews/github.md index a16bd8da..ce11d9bc 100644 --- a/code-reviews/pr-reviews/github.md +++ b/code-reviews/pr-reviews/github.md @@ -10,6 +10,8 @@ Connect the [kluster.ai](https://www.kluster.ai/){target=\_blank} bot to your Gi Once connected, the bot reviews every new PR and every new commit pushed to an open PR. No additional configuration is needed. +--8<-- 'text/code-reviews/pr-reviews-enterprise.md' + --8<-- 'text/code-reviews/pr-reviews-tip.md' ## Prerequisites diff --git a/code-reviews/pr-reviews/gitlab.md b/code-reviews/pr-reviews/gitlab.md index 1c3be3a0..af37771d 100644 --- a/code-reviews/pr-reviews/gitlab.md +++ b/code-reviews/pr-reviews/gitlab.md @@ -10,6 +10,8 @@ Connect the [kluster.ai](https://www.kluster.ai/){target=\_blank} bot to your Gi Once connected, the bot reviews every new merge request and every new commit pushed to an open merge request. No additional configuration is needed. +--8<-- 'text/code-reviews/pr-reviews-enterprise.md' + --8<-- 'text/code-reviews/pr-reviews-tip.md' ## Prerequisites @@ -20,6 +22,9 @@ Before getting started, ensure you have: - A GitLab account with at least **Developer** access to the projects you want to review. - A GitLab access token with the `api` scope. See [Create an access token](#create-an-access-token) for instructions. +!!! warning "Verify account permissions" + The account that generates the access token must have at least **Developer** role in the target project or group. Having the correct token scopes (such as `api`) is not enough — the account itself needs Developer-level permissions. If the account only has Guest access, webhook installation will fail silently and PR reviews will not appear. After fixing the account's role, click **Re-install** on the PR Reviews page in the kluster.ai platform to complete the setup. + ## Create an access token The kluster.ai bot requires a GitLab access token with the `api` scope to read merge requests and post review comments. diff --git a/code-reviews/pr-reviews/quickstart.md b/code-reviews/pr-reviews/quickstart.md index 29d36b49..b1fbef66 100644 --- a/code-reviews/pr-reviews/quickstart.md +++ b/code-reviews/pr-reviews/quickstart.md @@ -10,6 +10,8 @@ PR Reviews connects a [kluster.ai](https://www.kluster.ai/){target=\_blank} bot The bot acts as a last line of defense. It catches issues that were missed during development, whether you used IDE reviews, CLI checks, or no kluster tooling at all. Every PR gets an ultra-deep analysis that examines your changes for bugs, security vulnerabilities, and quality problems before they reach your main branch. +--8<-- 'text/code-reviews/pr-reviews-enterprise.md' + !!! tip "Best used as a safety net" PR Reviews is most effective when combined with earlier review stages. Install the [kluster.ai extension](/code-reviews/get-started/installation/) in your IDE or set up [CLI hooks](/code-reviews/cli/git-hooks/) to catch issues while you code. The PR bot then confirms nothing was missed. diff --git a/code-reviews/troubleshooting.md b/code-reviews/troubleshooting.md index 7485c0a1..3d0a1623 100644 --- a/code-reviews/troubleshooting.md +++ b/code-reviews/troubleshooting.md @@ -142,6 +142,23 @@ Or split the review by reviewing individual files: kluster review file src/large-file.go ``` +## PR Reviews + +### Azure DevOps PR reviews not appearing + +After connecting Azure DevOps, pull request reviews may not appear if the account used to generate the personal access token lacks the required permissions to install webhooks. + +To fix this: + +1. Navigate to **Azure DevOps** > **Organization Settings** > **Security** > **Permissions**. +2. Find the user account that generated the personal access token. +3. Open the **Member of** tab and add the user to **Project Collection Administrators**. +4. Return to the [PR Reviews](https://platform.kluster.ai/pr-bot-installation){target=\_blank} page in the kluster.ai platform and click **Re-install** on the Azure DevOps integration. + +After re-installing, each new pull request should receive review comments from the kluster.ai bot. + +For more details on the required permissions, see the [Azure DevOps setup guide](/code-reviews/pr-reviews/azure-devops/). + ## Need help? If your issue isn't listed here or you need additional support, join our [Discord community](https://discord.com/invite/klusterai){target=\_blank}.