Skip to content

Commit 67275a2

Browse files
hannesrudolphhannesrudolph
committed
docs: add keyboard shortcuts documentation and v3.12.x release notes
- Add comprehensive keyboard shortcuts documentation page explaining the roo.acceptInput command - Update suggested-responses documentation to reference keyboard shortcut option - Add keyboard shortcut tip to tips-and-tricks page - Add release notes for versions 3.12.0, 3.12.1, and 3.12.2 - Update sidebar configuration to include new pages - Update update-notes index to include v3.12.x releases
1 parent f6b05ae commit 67275a2

File tree

8 files changed

+232
-2
lines changed

8 files changed

+232
-2
lines changed

‎docs/features/keyboard-shortcuts.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
sidebar_label: Keyboard Shortcuts
3+
---
4+
5+
# Keyboard Shortcuts
6+
7+
The Roo Code interface supports keyboard shortcuts to streamline your workflow and reduce dependence on mouse interactions.
8+
9+
## Available Keyboard Commands
10+
11+
Roo Code offers several keyboard commands to enhance your workflow. This page focuses on the `roo.acceptInput` command, but here's a quick reference to all keyboard commands:
12+
13+
| Command | Description | Default Shortcut |
14+
|---------|-------------|-----------------|
15+
| `roo.acceptInput` | Submit text or accept the primary suggestion | None (configurable) |
16+
| `roo.focus` | Focus the Roo input box | None (configurable) |
17+
| `roo.openChat` | Open Roo sidebar | Ctrl+Shift+R (⌘+Shift+R on Mac) |
18+
19+
### Key Benefits of Keyboard Commands
20+
21+
* **Keyboard-Driven Interface**: Submit text or select the primary suggestion button without mouse interaction
22+
* **Improved Accessibility**: Essential for users with mobility limitations or those who experience discomfort with mouse usage
23+
* **Vim/Neovim Compatibility**: Supports seamless transitions for developers coming from keyboard-centric environments
24+
* **Workflow Efficiency**: Reduces context switching between keyboard and mouse during development tasks
25+
26+
## roo.acceptInput Command
27+
28+
The `roo.acceptInput` command lets you submit text or accept suggestions with keyboard shortcuts instead of clicking buttons or pressing Enter in the input area.
29+
30+
### What It Does
31+
32+
When triggered, the command:
33+
- Clicks the primary (first) button when suggestion buttons are visible (see [Suggested Responses](/features/suggested-responses))
34+
- Submits your current text input when in regular text input mode
35+
36+
### Detailed Setup Guide
37+
38+
#### Method 1: Using the VS Code UI
39+
40+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac)
41+
2. Type "Preferences: Open Keyboard Shortcuts"
42+
3. In the search box, type "roo.acceptInput"
43+
4. Locate "Roo: Accept Input/Suggestion" in the results
44+
5. Click the + icon to the left of the command
45+
6. Press your desired key combination (e.g., `Ctrl+Enter` or `Alt+Enter`)
46+
7. Press Enter to confirm
47+
48+
<img src="/img/keyboard-shortcuts/keyboard-shortcut-setup.png" alt="Setting up the roo.acceptInput keyboard shortcut in VS Code's Keyboard Shortcuts UI" width="700" />
49+
50+
#### Method 2: Editing keybindings.json directly
51+
52+
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac)
53+
2. Type "Preferences: Open Keyboard Shortcuts (JSON)"
54+
3. Add the following entry to the JSON array:
55+
56+
```json
57+
{
58+
"key": "ctrl+enter", // or your preferred key combination
59+
"command": "roo.acceptInput",
60+
"when": "rooViewFocused"
61+
}
62+
```
63+
64+
#### Recommended Key Combinations
65+
66+
Choose a key combination that doesn't conflict with existing VS Code shortcuts:
67+
68+
- `Alt+Enter` - Easy to press while typing
69+
- `Ctrl+Space` - Familiar for those who use autocomplete
70+
- `Ctrl+Enter` - Intuitive for command execution
71+
- `Alt+A` - Mnemonic for "Accept"
72+
73+
### Practical Use Cases
74+
75+
#### Quick Development Workflows
76+
77+
- **Multi-Step Code Generation**: When Roo asks clarifying questions during code generation, accept the primary suggestion without breaking your flow
78+
- **Rapid Prototyping**: Quickly move through a series of inputs when creating a prototype
79+
- **Confirmations**: Accept default confirmation options during processes like creating files, running terminal commands, or applying diffs
80+
- **Consecutive Tasks**: Chain multiple small tasks together with minimal interruption
81+
82+
#### Keyboard-Centric Development
83+
84+
- **Vim/Neovim Workflows**: If you're coming from a Vim/Neovim background, maintain your keyboard-focused workflow
85+
- **IDE Integration**: Use alongside other VS Code keyboard shortcuts for a seamless experience
86+
- **Code Reviews**: Quickly accept suggestions when reviewing code with Roo
87+
- **Documentation Writing**: Submit text and accept formatting suggestions when generating documentation
88+
89+
#### Accessibility Use Cases
90+
91+
- **Hand Mobility Limitations**: Essential for users who have difficulty using a mouse
92+
- **Repetitive Strain Prevention**: Reduce mouse usage to prevent or manage repetitive strain injuries
93+
- **Screen Reader Integration**: Works well with screen readers for visually impaired users
94+
- **Voice Control Compatibility**: Can be triggered via voice commands when using voice control software
95+
96+
### Accessibility Benefits
97+
98+
The `roo.acceptInput` command was designed with accessibility in mind:
99+
100+
- **Reduced Mouse Dependence**: Complete entire workflows without reaching for the mouse
101+
- **Reduced Physical Strain**: Helps users who experience discomfort or pain from mouse usage
102+
- **Alternative Input Method**: Supports users with mobility impairments who rely on keyboard navigation
103+
- **Workflow Optimization**: Particularly valuable for users coming from keyboard-centric environments like Vim/Neovim
104+
105+
### Keyboard-Centric Workflows
106+
107+
Here are some complete workflow examples showing how to effectively use keyboard shortcuts with Roo:
108+
109+
#### Development Workflow Example
110+
111+
1. Open VS Code and navigate to your project
112+
2. Open Roo (`Ctrl+Shift+R` or via sidebar)
113+
3. Type your request: "Create a REST API endpoint for user registration"
114+
4. When Roo asks for framework preferences, use your `roo.acceptInput` shortcut to select the first suggestion
115+
5. Continue using the shortcut to accept code generation suggestions
116+
6. When Roo offers to save the file, use the shortcut again to confirm
117+
7. Use VS Code's built-in shortcuts to navigate through the created files
118+
119+
#### Code Review Workflow
120+
121+
1. Select code you want to review and use VS Code's "Copy" command
122+
2. Ask Roo to review it: "Review this code for security issues"
123+
3. As Roo asks clarifying questions about the code context, use your shortcut to accept suggestions
124+
4. When Roo provides improvement recommendations, use the shortcut again to accept implementation suggestions
125+
126+
### Troubleshooting
127+
128+
| Issue | Solution |
129+
|-------|----------|
130+
| Shortcut doesn't work | Ensure Roo is focused (click in the Roo panel first) |
131+
| Wrong suggestion selected | The command always selects the first (primary) button; use mouse if you need a different option |
132+
| Conflicts with existing shortcuts | Try a different key combination in VS Code keyboard settings |
133+
| No visual feedback when used | This is normal - the command silently activates the function without visual confirmation |
134+
| Shortcut works inconsistently | Make sure the `when: "rooViewFocused"` clause is in your keybindings.json |
135+
136+
### Technical Implementation
137+
138+
The `roo.acceptInput` command is implemented as follows:
139+
140+
- Command registered as `roo.acceptInput` with display title "Roo: Accept Input/Suggestion" in the command palette
141+
- When triggered, it sends an "acceptInput" message to the active Roo webview
142+
- The webview determines the appropriate action based on the current UI state
143+
- Designed to work with the `rooViewFocused` context condition
144+
- No default key binding - users assign their preferred shortcut
145+
146+
### Limitations
147+
148+
- Works only when the Roo interface is active
149+
- Has no effect if no inputs or suggestions are currently available
150+
- Prioritizes the primary (first) button when multiple suggestions are shown
151+
- Cannot be used to select specific suggestions (always picks the first one)

‎docs/features/suggested-responses.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,18 @@ Suggested Responses appear as clickable buttons directly below Roo's question in
2222

2323
## Interacting with Suggestions
2424

25-
You have two options for using suggested responses:
25+
You have three options for using suggested responses:
2626

2727
1. **Direct Selection**:
2828
* **Action**: Simply click the button containing the answer you want to provide.
2929
* **Result**: The selected answer is immediately sent back to Roo as your response. This is the quickest way to reply if one of the suggestions perfectly matches your intent.
3030

31-
2. **Edit Before Sending**:
31+
2. **Keyboard Shortcut**:
32+
* **Action**: Use the `roo.acceptInput` command with your configured keyboard shortcut.
33+
* **Result**: The primary (first) suggestion button is automatically selected.
34+
* **Note**: For setup details, see [Keyboard Shortcuts](/features/keyboard-shortcuts).
35+
36+
3. **Edit Before Sending**:
3237
* **Action**:
3338
* Hold down `Shift` and click the suggestion button.
3439
* *Alternatively*, hover over the suggestion button and click the pencil icon (<Codicon name="edit" />) that appears.

‎docs/tips-and-tricks.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ A collection of quick tips to help you get the most out of Roo Code.
1414
- When using Debug mode, ask Roo to "start a new task in Debug mode with all of the necessary context needed to figure out X" so that the debugging process uses its own context window and doesn't pollute the main task
1515
- Add your own tips by clicking "Edit this page" below!
1616
- To manage large files and reduce context/resource usage, adjust the `File read auto-truncate threshold` setting. This setting controls the number of lines read from a file in one batch. Lower values can improve performance when working with very large files, but may require more read operations. You can find this setting in the Roo Code settings under 'Advanced Settings'.
17+
- Set up a keyboard shortcut for the [`roo.acceptInput` command](/features/keyboard-shortcuts) to accept suggestions or submit text input without using the mouse. Perfect for keyboard-focused workflows and reducing hand strain.

‎docs/update-notes/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
This section contains notes about recent updates to Roo Code, listed by version number.
44

5+
## Version 3.12
6+
7+
* [3.12.2](/update-notes/v3.12.2) (2025-04-16)
8+
* [3.12.1](/update-notes/v3.12.1) (2025-04-16)
9+
* [3.12.0](/update-notes/v3.12.0) (2025-04-15)
10+
511
## Version 3.11
612

713
* [3.11.17](/update-notes/v3.11.17) (2025-04-14)

‎docs/update-notes/v3.12.0.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Roo Code 3.12.0 Release Notes (2025-04-15)
2+
3+
This release introduces xAI provider support, improves diff editing, enhances UI with search capabilities, and includes various usability improvements and bug fixes.
4+
5+
## Provider Updates
6+
7+
* Added xAI provider and exposed reasoning effort options for Grok on OpenRouter. (thanks Cline!)
8+
9+
## Keyboard Shortcuts
10+
11+
### Keyboard Shortcuts for Input Acceptance
12+
13+
Added the `roo.acceptInput` command to allow users to accept input or suggestions using keyboard shortcuts instead of mouse clicks. (thanks axkirillov!) This feature:
14+
15+
#### Key Benefits
16+
17+
* **Keyboard-Driven Interface**: Submit text or select the primary suggestion button without mouse interaction
18+
* **Improved Accessibility**: Essential for users with mobility limitations or those who experience discomfort with mouse usage
19+
* **Vim/Neovim Compatibility**: Supports seamless transitions for developers coming from keyboard-centric environments
20+
* **Workflow Efficiency**: Reduces context switching between keyboard and mouse during development tasks
21+
22+
#### Technical Implementation
23+
24+
* Command registered as `roo.acceptInput` with display title "Roo: Accept Input/Suggestion"
25+
* Designed to work with the `rooViewFocused` context condition
26+
* No default key binding - users can assign their preferred shortcut
27+
* Works in conjunction with other keyboard shortcuts for a complete keyboard-driven experience
28+
29+
For detailed setup and usage instructions, see our new [Keyboard Shortcuts](/features/keyboard-shortcuts) documentation page.
30+
31+
## Improvements
32+
33+
* Made diff editing configuration per-profile and improved pre-diff string normalization for better editing reliability.
34+
* Made checkpoints faster and more reliable for smoother project state management.
35+
* Added a search bar to mode and profile select dropdowns for easier navigation. (thanks samhvw8!)
36+
* Added telemetry for code action usage, prompt enhancement usage, and consecutive mistake errors to improve product stability.
37+
* Suppressed zero cost values in the task header for cleaner UI. (thanks do-it!)
38+
* Made JSON parsing safer to avoid crashing the webview on bad input.

‎docs/update-notes/v3.12.1.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Roo Code 3.12.1 Release Notes (2025-04-16)
2+
3+
This patch release addresses a UI visibility issue.
4+
5+
## Bug Fixes
6+
7+
* Fixed a bug affecting the Edit button visibility in the select dropdowns.

‎docs/update-notes/v3.12.2.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Roo Code 3.12.2 Release Notes (2025-04-16)
2+
3+
This patch release adds OpenAI model support and improves UI and telemetry aspects.
4+
5+
## Provider Updates
6+
7+
* Added support for OpenAI `o3` & `4o-mini` models. (thanks PeterDaveHello!)
8+
9+
## Improvements
10+
11+
* Improved file/folder context mention UI for better usability. (thanks elianiva!)
12+
* Enhanced diff error telemetry for better troubleshooting capabilities.

‎sidebars.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ const sidebars: SidebarsConfig = {
3333
'features/enhance-prompt',
3434
'features/fast-edits',
3535
'features/footgun-prompting',
36+
'features/keyboard-shortcuts',
3637
'features/model-temperature',
3738
'features/settings-management',
3839
'features/suggested-responses',
@@ -136,6 +137,15 @@ const sidebars: SidebarsConfig = {
136137
label: 'Update Notes',
137138
items: [
138139
'update-notes/index',
140+
{
141+
type: 'category',
142+
label: '3.12',
143+
items: [
144+
{ type: 'doc', id: 'update-notes/v3.12.2', label: '3.12.2' },
145+
{ type: 'doc', id: 'update-notes/v3.12.1', label: '3.12.1' },
146+
{ type: 'doc', id: 'update-notes/v3.12.0', label: '3.12.0' },
147+
],
148+
},
139149
{
140150
type: 'category',
141151
label: '3.11',

0 commit comments

Comments
 (0)