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/advanced-usage/auto-approving-actions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ At the top of the Auto-Approve Toolbar is a toggle to enable/disable auto-approv
27
27
28
28
## Advanced Configuration (Settings)
29
29
30
-
You can also find these auto-approval options in the Roo Code settings panel (gear icon ⚙️ in the top right corner). The settings panel provides the same functionality as the auto-approve menu, but in a different location. The auto-approve menu is generally the quickest way to change these settings.
30
+
You can also find these auto-approval options in the Roo Code settings panel (<Codiconname="gear" /> in the top right corner). The settings panel provides the same functionality as the auto-approve menu, but in a different location. The auto-approve menu is generally the quickest way to change these settings.
Copy file name to clipboardExpand all lines: docs/advanced-usage/code-actions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ Each code action gives you two options:
61
61
62
62
You can customize the prompts used for each Code Action by modifying the "Support Prompts" in the **Prompts** tab. This allows you to fine-tune the instructions given to the AI model and tailor the responses to your specific needs.
63
63
64
-
1.**Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
64
+
1.**Open the Prompts Tab:** Click the <Codiconname="notebook" /> icon in the Roo Code top menu bar.
65
65
2.**Find "Support Prompts":** You will see the support prompts, including "Enhance Prompt", "Explain Code", "Fix Code", and "Improve Code".
66
66
3.**Edit the Prompts:** Modify the text in the text area for the prompt you want to customize. You can use placeholders like `${filePath}` and `${selectedText}` to include information about the current file and selection.
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:
3
+
Roo Code allows you to create **custom modes**to tailor Roo's behavior to specific tasks or workflows. Custom modes can be either **global** (available across all projects) or **project-specific** (defined within a single project). They allow you to define:
4
4
5
5
***A unique name and slug:** For easy identification.
6
6
***A role definition:** A description of the mode's purpose and expertise.
@@ -15,7 +15,7 @@ Roo Code allows you to create **custom modes** that can be either global (availa
15
15
***Experimentation:** Safely experiment with different prompts and configurations without affecting other modes.
16
16
***Team Collaboration:** Share custom modes with your team to standardize workflows.
17
17
18
-
## Creating a Custom Mode
18
+
## Creating Custom Modes
19
19
20
20
You have three options for creating custom modes:
21
21
@@ -33,36 +33,54 @@ Roo Code will guide you through the process.
33
33
34
34
### 2. Using the Prompts Tab
35
35
36
-
1.**Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
37
-
2.**Click "Create New Mode":** Use the "+" button to add a new mode.
36
+
1.**Open the Prompts Tab:** Click the <Codiconname="notebook" /> icon in the Roo Code top menu bar.
37
+
2.**Click "Create New Mode":** Use the <Codiconname="add" /> button to add a new mode.
38
38
3.**Fill in the Fields:** Enter the mode's name, role definition, custom instructions, and select the allowed tool groups.
39
39
4.**Click "Create Mode":** Save your new mode.
40
40
41
41
Note: Adding/editing file type restrictions is not yet supported in the prompts tab UI.
42
42
43
-
### 3. Manual Configuration (Advanced)
43
+
### 3. Manual Configuration
44
44
45
-
Custom modes can be configured in two locations:
45
+
Custom modes can be configured by directly editing JSON files. There are two locations for custom mode configurations:
46
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
47
+
1.**Global Configuration:**
48
+
*Located at `[path to global extension storage]/rooveterinaryinc.roo-cline/settings/cline_custom_modes.json`
49
+
*These modes are available across all projects.
50
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
51
+
2.**Project-Specific Configuration:**
52
+
*Located in a `.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.** This means if you define a mode with the slug "code" in your `.roomodes` file, it will override the global "code" mode when you're working in that project.
55
55
56
56
To edit either configuration:
57
57
58
-
1.**Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
59
-
2.**Open the Settings File:** Click the code icon (`<>`) in the top right corner of the "Prompts" tab.
58
+
1.**Open the Prompts Tab:** Click the <Codiconname="notebook" /> icon in the Roo Code top menu bar.
59
+
2.**Open the Settings File:** Click the <Codiconname="code" /> icon in the top right corner of the "Prompts" tab. (This will allow you to edit either the Global or project-specific configuration file. You can also edit the project-specific configuration by manually creating/opening the `.roomodes` file in your project's root directory.)
60
60
3.**Edit the JSON:** Add or modify mode configurations within the `customModes` array, following the format described below.
61
61
4.**Save the File:** Roo Code will automatically detect the changes.
62
62
63
63
## Custom Mode Configuration (JSON Format)
64
64
65
-
Both global and project-specific configuration files use the same JSON format. Here's an example:
65
+
Both global and project-specific configuration files use the same JSON format. The configuration is a JSON object with a `customModes` key, which contains an array of mode definitions. Each mode definition is a JSON object with the following properties:
66
+
67
+
*`slug`: (Required) A unique identifier for the mode (lowercase letters, numbers, and hyphens). Shorter is better.
68
+
*`name`: (Required) The display name for the mode.
69
+
*`roleDefinition`: (Required) A detailed description of the mode's role and capabilities.
70
+
*`groups`: (Required) An array of allowed tool groups. Each group can be specified either as a string (e.g., `"edit"` to allow editing any file) or with file restrictions (e.g., `["edit", { "fileRegex": "\\.md$", "description": "Markdown files only" }]` to only allow editing markdown files).
71
+
* Available tool groups are: `"read"`, `"edit"`, `"browser"`, `"command"`, `"mcp"`.
72
+
***Understanding `fileRegex`:** The `fileRegex` property uses a *regular expression* (or *regex*) to define which files the mode is allowed to edit. A regular expression is a sequence of characters that specifies a search pattern. Here's a breakdown of some common regex components used in the examples:
73
+
*`\.`: Matches a literal dot (`.`). The backslash is used to "escape" the dot, since a dot has a special meaning in regular expressions (matching any character).
74
+
*`(test|spec)`: Matches either "test" or "spec". The parentheses create a *capturing group*, and the pipe (`|`) acts as an "or".
75
+
*`(js|ts|jsx|tsx)`: Matches "js", "ts", "jsx", or "tsx".
76
+
*`$`: Matches the end of the string. This ensures that the entire filename matches the pattern, not just a part of it.
77
+
* For example, `\\.md$` matches any filename that ends with ".md". `\\.(test|spec)\\.(js|ts|jsx|tsx)$` matches filenames like "myComponent.test.js", "utils.spec.ts", etc.
78
+
* You can learn more about regular expressions on websites like [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions).
79
+
*`customInstructions`: (Optional) Additional instructions for the mode.
80
+
81
+
Here are some examples:
82
+
83
+
**Example 1: A simple documentation writer mode (could be global or project-specific):**
66
84
67
85
```json
68
86
{
@@ -76,7 +94,16 @@ Both global and project-specific configuration files use the same JSON format. H
"customInstructions": "Focus on editing and formatting markdown files."
173
+
}
174
+
]
175
+
}
176
+
```
177
+
By following these instructions, you can create and manage custom modes to enhance your workflow with Roo-Code.
178
+
93
179
## Community Gallery
94
180
95
-
Ready to explore more? Check out the [Custom Modes Gallery](../community#custom-modes-gallery) to discover and share custom modes created by the community!
181
+
Ready to explore more? Check out the [Custom Modes Gallery](/community#custom-modes-gallery) to discover and share custom modes created by the community!
Copy file name to clipboardExpand all lines: docs/advanced-usage/enhance-prompt.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,15 @@ The "Enhance Prompt" feature in Roo Code helps you improve the quality and effec
13
13
## How to Use Enhance Prompt
14
14
15
15
1.**Type your initial prompt:** Enter your request in the Roo Code chat input box as you normally would. This can be a simple question, a complex task description, or anything in between.
16
-
2.**Click the ✨ (Sparkle) Icon:** Instead of pressing Enter, click the sparkle icon located to the left of the chat input box.
16
+
2.**Click the <Codiconname="sparkle" /> Icon:** Instead of pressing Enter, click the <Codiconname="sparkle" /> icon located to the left of the chat input box.
17
17
3.**Review the Enhanced Prompt:** Roo Code will replace your original prompt with an enhanced version. Review the enhanced prompt to make sure it accurately reflects your intent. You can further refine the enhanced prompt before sending.
18
-
4.**Send the Enhanced Prompt:** Press Enter or click the Send icon (paper plane) to send the enhanced prompt to Roo Code.
18
+
4.**Send the Enhanced Prompt:** Press Enter or click the Send icon (<Codiconname="send" />) to send the enhanced prompt to Roo Code.
19
19
20
20
## Customizing the Enhancement Process
21
21
22
22
The "Enhance Prompt" feature uses a customizable prompt template. You can modify this template to tailor the enhancement process to your specific needs.
23
23
24
-
1.**Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
24
+
1.**Open the Prompts Tab:** Click the <Codiconname="notebook" /> icon in the Roo Code top menu bar.
25
25
2.**Select "ENHANCE" Tab:** You should see listed out support prompts, including "ENHANCE". Click on this tab.
26
26
3.**Edit the Prompt Template:** Modify the text in the "Prompt" field.
27
27
@@ -32,7 +32,7 @@ The default prompt template includes the placeholder `${userInput}`, which will
32
32
The API configuration used for Enhance Prompt is, by default, the same one that is selected for Roo Code tasks,
33
33
but it can be changed:
34
34
35
-
1.**Open the Prompts Tab:** Click the notebook icon in the Roo Code top menu bar.
35
+
1.**Open the Prompts Tab:** Click the <Codiconname="notebook" /> icon in the Roo Code top menu bar.
36
36
2.**Select "ENHANCE" Tab:** You should see an "API Configuration" dropdown
37
37
3.**Select an API Configuration:** Choose an existing configuration, and future Enhance Prompt requests will be sent to that configured provider/model.
Copy file name to clipboardExpand all lines: docs/advanced-usage/local-models.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,8 +73,8 @@ Roo Code currently supports two main local model providers:
73
73
74
74
75
75
4. **Configure Roo Code:**
76
-
* Open the Roo Code sidebar (🚀 icon).
77
-
* Click the settings gear icon (⚙️).
76
+
* Open the Roo Code sidebar (<Codicon name="rocket" /> icon).
77
+
* Click the settings gear icon (<Codicon name="gear" />).
78
78
* Select "ollama" as the API Provider.
79
79
* Enter the Model name from the previous step (e.g., `your_model_name`).
80
80
* (Optional) You can configure the base URL if you're running Ollama on a different machine. The default is `http://localhost:11434`.
@@ -89,8 +89,8 @@ Roo Code currently supports two main local model providers:
89
89
* Select your downloaded model.
90
90
* Click **"Start Server"**.
91
91
4. **Configure Roo Code:**
92
-
* Open the Roo Code sidebar (🚀 icon).
93
-
* Click the settings gear icon (⚙️).
92
+
* Open the Roo Code sidebar (<Codicon name="rocket" /> icon).
93
+
* Click the settings gear icon (<Codicon name="gear" />).
94
94
* Select "lmstudio" as the API Provider.
95
95
* Enter the Model ID. This should be the name of the model file you loaded in LM Studio (e.g., `codellama-7b.Q4_0.gguf`). LM Studio shows a list of "Currently loaded models" in its UI.
96
96
* (Optional) You can configure the base URL if you're running LM Studio on a different machine. The default is `http://localhost:1234`.
Copy file name to clipboardExpand all lines: docs/advanced-usage/model-temperature.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,8 @@ Different tasks benefit from different temperature settings. For example:
21
21
22
22
You can adjust the temperature in the Roo Code settings:
23
23
24
-
1.**Open the Roo Code Panel:** Click the Roo Code icon (🚀) in the VS Code Activity Bar.
25
-
2.**Open Settings:** Click the gear icon (⚙️) in the top right corner of the Roo Code panel.
24
+
1.**Open the Roo Code Panel:** Click the Roo Code icon (<Codiconname="rocket" />) in the VS Code Activity Bar.
25
+
2.**Open Settings:** Click the <Codiconname="gear" /> icon in the top right corner of the Roo Code panel.
26
26
3.**Find the Temperature Setting:** In the settings panel, you'll find a "Use custom temperature" setting within the API configuration section.
27
27
4.**Enter the Temperature Value:** Check the box and enter the temperature value you want to use. The range is typically from 0.0 to 1.0, but this may depend on the specific model and provider.
0 commit comments