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-instructions.md
+6-11Lines changed: 6 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,6 @@ Custom Instructions allow you to personalize how Roo behaves, providing specific
5
5
## What Are Custom Instructions?
6
6
7
7
Custom Instructions define specific behaviors, preferences, and constraints beyond Roo's basic role definition. Examples include coding style, documentation standards, testing requirements, and workflow guidelines.
8
-
:::info Rules Files
9
-
Custom Instructions are simply .rules files. They use the common convention of `.clinerules`, `.cursorrules`, and `.windsurfrules` files, which can be placed in your workspace root for version control or configured through the UI.
10
-
:::
11
8
12
9
## Setting Custom Instructions
13
10
@@ -29,7 +26,7 @@ These instructions only apply within your current workspace, allowing you to cus
29
26
30
27
#### Workspace-Wide Instructions
31
28
32
-
Workspace-wide instructions are defined through rule files in your workspace root, primarily using `.clinerules`. Additional support for `.cursorrules` and `.windsurfrules` is available for editor compatibility.
29
+
Workspace-wide instructions can be defined in a `.roorules` file in your workspace root.
33
30
34
31
#### Mode-Specific Instructions
35
32
@@ -47,7 +44,7 @@ Mode-specific instructions can be set in two independent ways that can be used s
47
44
If the mode itself is global (not workspace-specific), any custom instructions you set for it will also apply globally for that mode across all workspaces.
48
45
:::
49
46
50
-
2.**Using Rule Files:** Create a `.clinerules-[mode]` file in your workspace root (e.g., `.clinerules-code`)
47
+
2.**Using Rule Files:** Create a `.roorules-[mode]` file in your workspace root (e.g., `.roorules-code`)
51
48
52
49
When both tab instructions and rule files are set for a mode, both sets of instructions will be included in the system prompt.
53
50
@@ -64,10 +61,8 @@ The following additional instructions are provided by the user, and should be fo
64
61
[Mode-specific Instructions]
65
62
66
63
Rules:
67
-
[.clinerules-{mode} rules]
68
-
[.clinerules rules]
69
-
[.cursorrules rules]
70
-
[.windsurfrules rules]
64
+
[.roorules-{mode} rules]
65
+
[.roorules rules]
71
66
```
72
67
73
68
## Rules about .rules files
@@ -88,9 +83,9 @@ Rules:
88
83
* "When adding new features to websites, ensure they are responsive and accessible"
89
84
90
85
:::tip Pro Tip: File-Based Team Standards
91
-
When working in team environments, placing `.clinerules` files under version control allows you to standardize Roo's behavior across your entire development team. This ensures consistent code style, documentation practices, and development workflows for everyone on the project.
86
+
When working in team environments, placing `.roorules` files under version control allows you to standardize Roo's behavior across your entire development team. This ensures consistent code style, documentation practices, and development workflows for everyone on the project.
92
87
:::
93
88
94
89
## Combining with Custom Modes
95
90
96
-
For advanced customization, combine with [Custom Modes](/features/custom-modes) to create specialized environments with specific tool access, file restrictions, and tailored instructions.
91
+
For advanced customization, combine with [Custom Modes](/features/custom-modes) to create specialized environments with specific tool access, file restrictions, and tailored instructions.
Copy file name to clipboardExpand all lines: docs/features/custom-modes.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
@@ -18,7 +18,7 @@ Custom modes allow you to define:
18
18
19
19
***A unique name and slug:** For easy identification
20
20
***A role definition:** Placed at the beginning of the system prompt, this defines Roo's core expertise and personality for the mode. This placement is crucial as it shapes Roo's fundamental understanding and approach to tasks
21
-
***Custom instructions:** Added at the end of the system prompt, these provide specific guidelines that modify or refine Roo's behavior. Unlike `.clinerules` files (which only add rules at the end), this structured placement of role and instructions allows for more nuanced control over Roo's responses
21
+
***Custom instructions:** Added at the end of the system prompt, these provide specific guidelines that modify or refine Roo's behavior. Unlike `.roorules` files (which only add rules at the end), this structured placement of role and instructions allows for more nuanced control over Roo's responses
22
22
***Allowed tools:** Which Roo Code tools the mode can use (e.g., read files, write files, execute commands)
23
23
***File restrictions:** (Optional) Limit file access to specific file types or patterns (e.g., only allow editing `.md` files)
24
24
@@ -101,8 +101,8 @@ Common regex patterns:
101
101
102
102
In addition to the `customInstructions` property in JSON, you can use a dedicated file for mode-specific instructions:
103
103
104
-
1. Create a file named `.clinerules-{mode-slug}` in your workspace root
105
-
* Replace `{mode-slug}` with your mode's slug (e.g., `.clinerules-docs-writer`)
104
+
1. Create a file named `.roorules-{mode-slug}` in your workspace root
105
+
* Replace `{mode-slug}` with your mode's slug (e.g., `.roorules-docs-writer`)
106
106
2. Add your custom instructions to this file
107
107
3. Roo Code will automatically apply these instructions to the specified mode
108
108
@@ -111,7 +111,7 @@ This approach is particularly useful for:
111
111
* Managing instructions with version control
112
112
* Allowing non-technical team members to modify instructions without editing JSON
113
113
114
-
Note: If both `.clinerules-{mode-slug}` and the `customInstructions` property exist, they will be combined, with the file contents appended after the JSON property.
114
+
Note: If both `.roorules-{mode-slug}` and the `customInstructions` property exist, they will be combined, with the file contents appended after the JSON property.
0 commit comments