You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/features/custom-modes.mdx
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -166,21 +166,23 @@ Note: The automatic slug change handling during import ensures that rule file pa
166
166
167
167
You can create and configure custom modes in several ways:
168
168
169
+
To configure modes, open the Roo Code panel, click the Mode menu under the chatbox, then click the <Codicon name="settings-gear" />. From there, use "Edit Global Modes" to open settings/custom_modes.yaml, or "Edit Project Modes (.roomodes)" to open your workspace-level configuration.
170
+
169
171
### 1. Ask Roo! (Recommended)
170
172
171
173
You can quickly create a basic custom mode by asking Roo Code to do it for you. For example:
172
174
```
173
175
Create a new mode called "Documentation Writer". It should only be able to read files and write Markdown files.
174
176
```
175
-
Roo Code will guide you through the process, prompting for necessary information for the properties described in the [What's Included in a Custom Mode?](#whats-included-in-a-custom-mode) table. Roo will create the mode using the preferred YAML format. For fine-tuning or making specific adjustments later, you can use the Prompts tab or manual configuration.
177
+
Roo Code will guide you through the process, prompting for necessary information for the properties described in the [What's Included in a Custom Mode?](#whats-included-in-a-custom-mode) table. Roo will create the mode using the preferred YAML format. For fine-tuning or making specific adjustments later, you can use the Modes page or manual configuration.
176
178
177
-
### 2. Using the Prompts Tab
179
+
### 2. Using the Modes Page
178
180
179
-
1. **Open Prompts Tab:** Click the <Codicon name="notebook" /> icon in the Roo Code top menu bar.
181
+
1. **Open the Modes page:** Open the Roo Code panel, click the Mode menu under the chatbox, then click the <Codicon name="settings-gear" />.
180
182
2. **Create New Mode:** Click the <Codicon name="add" /> button to the right of the Modes heading.
181
183
3. **Fill in Fields:**
182
184
183
-
<img src="/img/custom-modes/custom-modes-4.png" alt="Custom mode creation interface in the Prompts tab" width="600" />
185
+
<img src="/img/custom-modes/custom-modes-4.png" alt="Custom mode creation interface on the Modes page" width="600" />
184
186
185
187
*The custom mode creation interface showing fields for name, slug, description, save location, role definition, available tools, custom instructions.*
186
188
@@ -192,8 +194,8 @@ Roo Code will guide you through the process, prompting for necessary information
192
194
193
195
You can directly edit the configuration files to create or modify custom modes. This method offers the most control over all properties. Roo Code now supports both YAML (preferred) and JSON formats.
194
196
195
-
* **Global Modes:** Edit the `custom_modes.yaml` (preferred) or `custom_modes.json` file. Access it via **Prompts Tab** > <Codicon name="settings-gear" /> (Settings Menu icon next to "Global Prompts") > "Edit Global Modes".
196
-
* **Project Modes:** Edit the `.roomodes` file (which can be YAML or JSON) in your project root. Access it via **Prompts Tab** > <Codicon name="settings-gear" /> (Settings Menu icon next to "Project Prompts") > "Edit Project Modes".
197
+
* **Global Modes:** Edit the `custom_modes.yaml` (preferred) or `custom_modes.json` file. From the Modes page, click "Edit Global Modes" to open `settings/custom_modes.yaml`.
198
+
* **Project Modes:** Edit the `.roomodes` file (which can be YAML or JSON) in your project root. From the Modes page, click "Edit Project Modes (.roomodes)" to open or create the workspace file.
197
199
198
200
These files define an array/list of custom modes.
199
201
@@ -392,7 +394,7 @@ When editing YAML manually, keep these points in mind:
392
394
* **Project Modes (`.roomodes`):**
393
395
* **No automatic startup migration:** Unlike global modes, project-specific `.roomodes` files are not automatically converted from JSON to YAML when Roo Code starts. Manual conversion is required for existing JSON `.roomodes` files.
394
396
* **Format Detection:** Roo Code can read `.roomodes` files in either YAML or JSON format. Roo Code automatically detects the format of `.roomodes` files by attempting to parse them as YAML first.
395
-
* **Conversion on UI Edit:** If you edit a project-specific mode through the Roo Code UI (e.g., via the Prompts Tab), and the existing `.roomodes` file is in JSON format, Roo Code will save the changes in YAML format. This effectively converts the file to YAML. The original JSON content will be overwritten with YAML.
397
+
* **Conversion on UI Edit:** If you edit a project-specific mode through the Roo Code UI (e.g., via the Modes page), and the existing `.roomodes` file is in JSON format, Roo Code will save the changes in YAML format. This effectively converts the file to YAML. The original JSON content will be overwritten with YAML.
396
398
* **Manual Conversion:** If you want to convert an existing `.roomodes` JSON file to YAML without making UI edits, you'll need to do this manually. You can:
397
399
1. Open your existing JSON `.roomodes` file.
398
400
2. Convert its content to YAML (you can ask Roo to help with this, or use an online converter).
@@ -492,10 +494,9 @@ You can override Roo Code's built-in modes (like `💻 Code`, `🪲 Debug`, `❓
492
494
493
495
To customize a default mode across all your projects:
494
496
495
-
1. **Open Prompts Tab:** Click the <Codicon name="notebook" /> icon.
496
-
2. **Access Settings Menu:** Click the <Codicon name="settings-gear" /> icon next to "Global Prompts".
497
-
3. **Edit Global Modes:** Select "Edit Global Modes" to edit `custom_modes.yaml` (or `custom_modes.json`).
498
-
4. **Add Your Override:**
497
+
1. **Open the Modes page:** Open the Roo Code panel, click the Mode menu under the chatbox, then click the <Codicon name="settings-gear" />.
498
+
2. **Edit Global Modes:** Click "Edit Global Modes" to open `settings/custom_modes.yaml` (or `custom_modes.json`).
499
+
3. **Add Your Override:**
499
500
500
501
**YAML Example:**
501
502
```yaml
@@ -534,10 +535,9 @@ This example replaces the default `💻 Code` mode with a version restricted to
534
535
535
536
To override a default mode for just one project:
536
537
537
-
1.**Open Prompts Tab:** Click the <Codiconname="notebook" /> icon.
538
-
2.**Access Settings Menu:** Click the <Codiconname="settings-gear" /> icon next to "Project Prompts".
539
-
3.**Edit Project Modes:** Select "Edit Project Modes" to edit the `.roomodes` file (YAML or JSON).
540
-
4.**Add Your Override:**
538
+
1.**Open the Modes page:** Open the Roo Code panel, click the Mode menu under the chatbox, then click the <Codiconname="settings-gear" />.
539
+
2.**Edit Project Modes (.roomodes):** Click "Edit Project Modes (.roomodes)" to open or create the workspace file.
0 commit comments