Skip to content

Commit e606b11

Browse files
authored
Update docs for .roomodes (#30)
1 parent e982cfd commit e606b11

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/advanced-usage/custom-modes.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom Modes
22

3-
Roo Code allows you to create **custom modes** to tailor its behavior to specific tasks or workflows. Custom modes let you define:
3+
Roo Code allows you to create **custom modes** that can be either global (available across all projects) or project-specific (defined within a single project). These modes let you tailor Roo's behavior to specific tasks or workflows by defining:
44

55
* **A unique name and slug:** For easy identification.
66
* **A role definition:** A description of the mode's purpose and expertise.
@@ -36,21 +36,33 @@ Roo Code will guide you through the process.
3636
1. **Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
3737
2. **Click "Create New Mode":** Use the "+" button to add a new mode.
3838
3. **Fill in the Fields:** Enter the mode's name, role definition, custom instructions, and select the allowed tool groups.
39-
4. **Add File Restrictions:** For the "edit" group, you can optionally specify a regular expression to restrict file access.
40-
5. **Click "Create Mode":** Save your new mode.
39+
4. **Click "Create Mode":** Save your new mode.
40+
41+
Note: Adding/editing file type restrictions is not yet supported in the prompts tab UI.
4142

4243
### 3. Manual Configuration (Advanced)
4344

44-
For advanced users, you can directly edit the `cline_custom_modes.json` file:
45+
Custom modes can be configured in two locations:
46+
47+
1. **Global Configuration:**
48+
- Located at `~/Library/Application Support/Cursor/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_custom_modes.json`
49+
- These modes are available across all projects
50+
51+
2. **Project-Specific Configuration:**
52+
- Located in `.roomodes` file in your project's root directory
53+
- These modes are only available within that specific project
54+
- Project-specific modes take precedence over global modes with the same slug
55+
56+
To edit either configuration:
4557

4658
1. **Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
47-
2. **Open the Settings File:** Click the code icon (`<>`) in the top right corner of the "Prompts" tab. This will open the `cline_custom_modes.json` file in a VS Code editor.
59+
2. **Open the Settings File:** Click the code icon (`<>`) in the top right corner of the "Prompts" tab.
4860
3. **Edit the JSON:** Add or modify mode configurations within the `customModes` array, following the format described below.
4961
4. **Save the File:** Roo Code will automatically detect the changes.
5062

5163
## Custom Mode Configuration (JSON Format)
5264

53-
The `cline_custom_modes.json` file uses a JSON format. Here's an example:
65+
Both global and project-specific configuration files use the same JSON format. Here's an example:
5466

5567
```json
5668
{

0 commit comments

Comments
 (0)