Skip to content

Commit f4fdd7f

Browse files
docs(custom-modes): update configuration instructions for creating and editing custom modes (#349)
1 parent f7b364d commit f4fdd7f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/features/custom-modes.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -166,21 +166,23 @@ Note: The automatic slug change handling during import ensures that rule file pa
166166

167167
You can create and configure custom modes in several ways:
168168

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+
169171
### 1. Ask Roo! (Recommended)
170172

171173
You can quickly create a basic custom mode by asking Roo Code to do it for you. For example:
172174
```
173175
Create a new mode called "Documentation Writer". It should only be able to read files and write Markdown files.
174176
```
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.
176178

177-
### 2. Using the Prompts Tab
179+
### 2. Using the Modes Page
178180

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" />.
180182
2. **Create New Mode:** Click the <Codicon name="add" /> button to the right of the Modes heading.
181183
3. **Fill in Fields:**
182184

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" />
184186

185187
*The custom mode creation interface showing fields for name, slug, description, save location, role definition, available tools, custom instructions.*
186188

@@ -192,8 +194,8 @@ Roo Code will guide you through the process, prompting for necessary information
192194

193195
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.
194196

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.
197199

198200
These files define an array/list of custom modes.
199201

@@ -392,7 +394,7 @@ When editing YAML manually, keep these points in mind:
392394
* **Project Modes (`.roomodes`):**
393395
* **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.
394396
* **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.
396398
* **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:
397399
1. Open your existing JSON `.roomodes` file.
398400
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`, `❓
492494
493495
To customize a default mode across all your projects:
494496
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:**
499500
500501
**YAML Example:**
501502
```yaml
@@ -534,10 +535,9 @@ This example replaces the default `💻 Code` mode with a version restricted to
534535

535536
To override a default mode for just one project:
536537

537-
1. **Open Prompts Tab:** Click the <Codicon name="notebook" /> icon.
538-
2. **Access Settings Menu:** Click the <Codicon name="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 <Codicon name="settings-gear" />.
539+
2. **Edit Project Modes (.roomodes):** Click "Edit Project Modes (.roomodes)" to open or create the workspace file.
540+
3. **Add Your Override:**
541541

542542
**YAML Example:**
543543
```yaml

0 commit comments

Comments
 (0)