-
Notifications
You must be signed in to change notification settings - Fork 4
Add pause reviews documentation for IDE and CLI environments #268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
52050e2
Add pause reviews documentation for IDE and CLI environments
albertov19 ed1fb11
Add controls and fallback text to pause reviews video
albertov19 c3ece30
Revert video controls to match homepage pattern
albertov19 1f5b0a2
Standardize resume command to "resume kluster"
albertov19 93b5fbf
Remove pause section from human-written automatic reviews
albertov19 f05db43
Add pause reviews section to human-written code automatic reviews
Copilot ab306bd
Move termynal blocks to .snippets/code/ directory
albertov19 6d35f28
Merge branch 'albertov19/pause-reviews' of github.com:kluster-ai/docs…
albertov19 c1d895e
Remove pause section from human-written automatic reviews
albertov19 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <div data-termynal> | ||
| <span data-ty>╭─── Claude Code v2.1.87 ────────────────────────────╮</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ Welcome back kluster.ai! │</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ ▐▛███▜▌ │</span> | ||
| <span data-ty>│ ▝▜█████▛▘ │</span> | ||
| <span data-ty>│ ▘▘ ▝▝ │</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ Opus 4.6 · Claude Max · kluster's Organization │</span> | ||
| <span data-ty>│ /workspace │</span> | ||
| <span data-ty>╰────────────────────────────────────────────────────╯</span> | ||
| <span data-ty></span> | ||
| <span data-ty="input" data-ty-prompt="❯ "> pause kluster</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● Pausing kluster reviews...</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● kluster-verify — kluster_review_pause (MCP)(action: "pause")</span> | ||
| <span data-ty></span> | ||
| <span data-ty> ⎿ kluster code review has been paused for 1 hour for this</span> | ||
| <span data-ty> project. Reviews will resume automatically after 60</span> | ||
| <span data-ty> minutes. To re-enable sooner, type "resume kluster".</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● kluster reviews have been paused for 1 hour. Automated code</span> | ||
| <span data-ty> reviews will resume automatically after that, or you can say</span> | ||
| <span data-ty> "resume kluster" to re-enable them sooner.</span> | ||
| </div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <div data-termynal> | ||
| <span data-ty>╭─── Claude Code v2.1.87 ────────────────────────────╮</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ Welcome back kluster.ai! │</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ ▐▛███▜▌ │</span> | ||
| <span data-ty>│ ▝▜█████▛▘ │</span> | ||
| <span data-ty>│ ▘▘ ▝▝ │</span> | ||
| <span data-ty>│ │</span> | ||
| <span data-ty>│ Opus 4.6 · Claude Max · kluster's Organization │</span> | ||
| <span data-ty>│ /workspace │</span> | ||
| <span data-ty>╰────────────────────────────────────────────────────╯</span> | ||
| <span data-ty></span> | ||
| <span data-ty="input" data-ty-prompt="❯ "> resume kluster</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● Resuming kluster reviews...</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● kluster-verify — kluster_review_pause (MCP)(action: "resume")</span> | ||
| <span data-ty></span> | ||
| <span data-ty> ⎿ kluster code review has been resumed for this project.</span> | ||
| <span data-ty> Code changes will be verified again from now on.</span> | ||
| <span data-ty></span> | ||
| <span data-ty>● kluster reviews have been resumed. Automated code reviews</span> | ||
| <span data-ty> are active again.</span> | ||
| </div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ### Pause from the terminal | ||
|
|
||
| In CLI tools and agentic tools such as Claude Code and Codex CLI, you can pause reviews through the chat interface. Ask your agent to pause kluster reviews, and it calls the `kluster_review_pause` MCP tool. | ||
|
|
||
| The pause lasts **1 hour** by default. Custom durations are not available in the terminal flow due to a system limitation. While paused, the system automatically resolves any MCP requests so the response is almost instantaneous. | ||
|
|
||
| To pause reviews, ask your agent to pause kluster. The following example shows the pause flow in Claude Code: | ||
|
|
||
| --8<-- 'code/code-reviews/ide-reviews/pause-reviews.md' | ||
|
|
||
| To resume reviews before the pause expires, ask your agent to resume kluster: | ||
|
|
||
| --8<-- 'code/code-reviews/ide-reviews/resume-reviews.md' | ||
|
|
||
| !!! note "Cross-environment pause" | ||
| Pause is project-specific. Pausing in a CLI tool also pauses reviews in any IDE working on the same project, and vice versa. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| You can temporarily pause all kluster code reviews for the current project. While paused, the system automatically resolves any MCP requests so the response is almost instantaneous. | ||
|
|
||
| ### Pause from the status bar | ||
|
|
||
| 1. Click the **kluster.ai** button in the IDE status bar. | ||
| 2. Select **Pause Agent Review...** from the command palette. | ||
|
albertov19 marked this conversation as resolved.
|
||
| 3. Choose a duration from the available options. | ||
| 4. Verify that kluster is paused by the pause icon in the kluster.ai IDE status bar. | ||
|
|
||
| <video autoplay loop muted playsinline style="max-width: 100%; border-radius: 8px;"> | ||
| <source src="/images/code-reviews/ide-reviews/pause-reviews/pause-reviews.webm" type="video/webm"> | ||
|
albertov19 marked this conversation as resolved.
|
||
| </video> | ||
|
|
||
| Reviews resume automatically when the selected duration expires. Select **Indefinitely (disable)** to keep reviews paused until you re-enable them manually. | ||
|
|
||
| !!! note "Pause is project-specific" | ||
| Pausing applies to the project identified by its Git remote URL or filesystem path. If you pause reviews in one tool (for example, VS Code), reviews are also paused for every other tool working on the same project, including Claude Code and Codex CLI. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious as to why this was put into a snippet? Same with the
ide-pause.mdsnippet?