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
You are a technical documentation writer for the Roo Code project.
6
-
Your writing is direct, concise, and technical.
7
-
You write for a developer audience and follow the instructions in the .roo/rules-docs/ directory to produce clear, high-signal Markdown documentation.
8
-
whenToUse: Use this mode for creating or updating documentation in Markdown (.md, .mdx) files.
9
-
groups:
10
-
- read
11
-
- command
12
-
- - edit
13
-
- fileRegex: \.(md|mdx)$
14
-
description: Documentation files
15
-
source: project
16
2
- slug: release-notes-writer
17
3
name: Release Notes Writer
18
-
roleDefinition: >-
19
-
You are a technical writer for Roo Code release notes. Your job is to:
20
-
- Automate release note creation.
21
-
- Fetch and analyze GitHub pull requests.
22
-
- Convert technical changes into user benefits.
23
-
- Ensure updates align with documentation standards.
24
-
- Update all required documentation files in the docs/update-notes directory.
25
-
whenToUse: >-
26
-
Use this mode to create release notes for a new Roo Code version. It automates the full workflow from fetching PRs to updating documentation. Provide a version number to start.
4
+
roleDefinition: "You are a technical writer for Roo Code release notes. Your job is to: - Automate release note creation. - Fetch and analyze GitHub pull requests. - Convert technical changes into user benefits. - Ensure updates align with documentation standards. - Update all required documentation files in the docs/update-notes directory."
5
+
whenToUse: Use this mode to create release notes for a new Roo Code version. It automates the full workflow from fetching PRs to updating documentation. Provide a version number to start.
27
6
groups:
28
7
- read
29
8
- command
@@ -34,25 +13,23 @@ customModes:
34
13
source: project
35
14
- slug: mode-writer
36
15
name: ✍️ Mode Writer
37
-
roleDefinition: >-
38
-
You are Roo, a mode creation specialist focused on designing and implementing custom modes for the Roo-Code project. Your expertise includes:
39
-
- Understanding the mode system architecture and configuration
40
-
- Creating well-structured mode definitions with clear roles and responsibilities
41
-
- Writing comprehensive XML-based special instructions using best practices
42
-
- Ensuring modes have appropriate tool group permissions
43
-
- Crafting clear whenToUse descriptions for the Orchestrator
44
-
- Following XML structuring best practices for clarity and parseability
45
-
You help users create new modes by:
46
-
- Gathering requirements about the mode's purpose and workflow
47
-
- Defining appropriate roleDefinition and whenToUse descriptions
48
-
- Selecting the right tool groups and file restrictions
49
-
- Creating detailed XML instruction files in the .roo folder
50
-
- Ensuring instructions are well-organized with proper XML tags
51
-
- Following established patterns from existing modes
16
+
roleDefinition: "You are Roo, a mode creation specialist focused on designing and implementing custom modes for the Roo-Code project. Your expertise includes: - Understanding the mode system architecture and configuration - Creating well-structured mode definitions with clear roles and responsibilities - Writing comprehensive XML-based special instructions using best practices - Ensuring modes have appropriate tool group permissions - Crafting clear whenToUse descriptions for the Orchestrator - Following XML structuring best practices for clarity and parseability You help users create new modes by: - Gathering requirements about the mode's purpose and workflow - Defining appropriate roleDefinition and whenToUse descriptions - Selecting the right tool groups and file restrictions - Creating detailed XML instruction files in the .roo folder - Ensuring instructions are well-organized with proper XML tags - Following established patterns from existing modes"
52
17
whenToUse: Use this mode when you need to create a new custom mode.
53
18
groups:
54
19
- read
55
20
- - edit
56
21
- fileRegex: (\.roomodes$|\.roo/.*\.xml$|\.yaml$)
57
22
description: Mode configuration files and XML instructions
58
23
- command
24
+
- slug: documentation-writer
25
+
name: 📝 Documentation Writer
26
+
roleDefinition: You are a technical documentation writer for the Roo Code project. Your writing is direct, concise, and technical. You write for a developer audience and follow the instructions in the .roo/rules-docs/ directory to produce clear, high-signal Markdown documentation.
27
+
whenToUse: Use this mode for creating or updating documentation in Markdown (.md, .mdx) files.
Copy file name to clipboardExpand all lines: docs/providers/claude-code.md
+29-72Lines changed: 29 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,35 +4,49 @@ sidebar_label: Claude Code
4
4
5
5
# Claude Code Provider
6
6
7
+
:::info Setup Instructions
8
+
Before using the Claude Code provider, ensure you have completed the following steps:
9
+
10
+
1.**Install Claude CLI**: Download and install the official command-line tool from [Anthropic's documentation](https://docs.anthropic.com/en/docs/claude-code/setup).
11
+
2.**Authenticate**: Run `claude` in your terminal to start the application. Once the application is running, type `/login` to sign in to your Anthropic account. This step is required to grant Roo Code access to your Claude subscription.
12
+
3.**Verify Setup**: Confirm the CLI is working by running `claude --version`. This ensures that Roo Code can find and use the executable.
13
+
4.**Configure in Roo Code**:
14
+
* Go to Roo Code settings and select **"Claude Code"** as your API provider.
15
+
* If you installed the CLI in a custom location, set the **"Claude Code Path"** to the full executable path (e.g., `/usr/local/bin/claude`). Otherwise, you can leave it blank.
16
+
* Choose your desired model from the list of available options.
17
+
18
+
Once configured, Roo Code will use your local Claude CLI installation to interact with Anthropic's models, leveraging your existing subscription.
19
+
:::
20
+
7
21
The Claude Code provider allows you to use Anthropic's Claude models through their official CLI (Command Line Interface) instead of the web API. This provides direct access to your Claude Max subscription right from Roo Code.
-**Direct CLI Access**: Uses Anthropic's official Claude CLI tool for model interactions
15
-
-**Advanced Reasoning**: Full support for Claude's thinking mode and reasoning capabilities
16
-
-**Cost Transparency**: Shows exact usage costs as reported by the CLI
17
-
-**Flexible Configuration**: Works with your existing Claude CLI setup
28
+
-**Direct CLI Access**: Uses Anthropic's official Claude CLI tool for model interactions.
29
+
-**Advanced Reasoning**: Full support for Claude's thinking mode and reasoning capabilities.
30
+
-**Cost Transparency**: Shows exact usage costs as reported by the CLI.
31
+
-**Flexible Configuration**: Works with your existing Claude CLI setup.
18
32
19
33
---
20
34
21
35
## Why Use This Provider
22
36
23
-
-**No API Keys**: Uses your existing Claude CLI authentication
24
-
-**Cost Benefits**: Leverage CLI subscription rates and transparent cost reporting
25
-
-**Latest Features**: Access new Claude capabilities as they're released in the CLI
26
-
-**Advanced Reasoning**: Full support for Claude's thinking modes
37
+
-**No API Keys**: Uses your existing Claude CLI authentication.
38
+
-**Cost Benefits**: Leverage CLI subscription rates and transparent cost reporting.
39
+
-**Latest Features**: Access new Claude capabilities as they're released in the CLI.
40
+
-**Advanced Reasoning**: Full support for Claude's thinking modes.
27
41
28
42
## How it Works
29
43
30
44
The Claude Code provider works by:
31
45
32
-
1.**Running Commands**: Executes the `claude` CLI command with your prompts
33
-
2.**Processing Output**: Handles the CLI's JSON output in chunks with advanced parsing
34
-
3.**Handling Reasoning**: Captures and displays Claude's thinking process when available
35
-
4.**Tracking Usage**: Reports token usage and costs as provided by the CLI
46
+
1.**Running Commands**: Executes the `claude` CLI command with your prompts.
47
+
2.**Processing Output**: Handles the CLI's JSON output in chunks with advanced parsing.
48
+
3.**Handling Reasoning**: Captures and displays Claude's thinking process when available.
49
+
4.**Tracking Usage**: Reports token usage and costs as provided by the CLI.
36
50
37
51
The provider integrates with Roo Code's interface, giving you the same experience as other providers while using the Claude CLI under the hood.
38
52
@@ -44,12 +58,11 @@ You only need to configure one optional setting:
44
58
45
59
### **Claude Code Path**
46
60
-**Setting**: `claudeCodePath`
47
-
-**Description**: Path to your Claude CLI executable
48
-
-**Default**: `claude` (assumes it's in your system PATH)
49
-
-**When to change**: If you installed Claude CLI in a custom location
61
+
-**Description**: Path to your Claude CLI executable.
62
+
-**Default**: `claude` (assumes it's in your system PATH).
63
+
-**When to change**: If you installed Claude CLI in a custom location.
50
64
51
65
**Example custom paths:**
52
-
- Windows: `C:\tools\claude\claude.exe`
53
66
- macOS/Linux: `/usr/local/bin/claude` or `~/bin/claude`
54
67
55
68
---
@@ -66,27 +79,6 @@ The Claude Code provider supports these Claude models:
66
79
67
80
The specific models available depend on your Claude CLI subscription and plan.
68
81
69
-
---
70
-
71
-
## Prerequisites
72
-
73
-
Before using the Claude Code provider:
74
-
75
-
1.**Install Claude CLI**: Download and install from Anthropic
76
-
2.**Authenticate**: Run `claude auth` to sign in to your account
77
-
3.**Verify Setup**: Test with `claude --version` to ensure it's working
78
-
4.**Optional**: Add CLI location to PATH or configure custom path in settings
79
-
80
-
## Configuration in Roo Code
81
-
82
-
**Initial Setup Option:**
83
-
The Claude Code provider can be selected during your initial Roo Code setup without requiring additional configuration, making it one of the easiest providers to get started with.
84
-
85
-
**Manual Configuration:**
86
-
1.**Open Roo Code Settings:** Click the gear icon (<Codiconname="gear" />) in the Roo Code panel.
87
-
2.**Select Provider:** Choose "Claude Code" from the "API Provider" dropdown.
88
-
3.**Configure Path (Optional):** If needed, set the "Claude Code Path" to your CLI executable location.
89
-
4.**Select Model:** Choose your desired Claude model from the "Model" dropdown.
90
82
91
83
---
92
84
@@ -108,38 +100,3 @@ The Claude Code provider can be selected during your initial Roo Code setup with
108
100
- Set a custom path in the Claude Code Path setting
109
101
- Point to the full path where you installed the CLI
110
102
111
-
112
-
---
113
-
114
-
## Troubleshooting
115
-
116
-
### **"Claude Code process exited with error"**
117
-
**Common causes:**
118
-
- Claude CLI not installed or not in PATH
119
-
120
-
**Solutions:**
121
-
1. Verify CLI installation: `claude --version`
122
-
2. Re-authenticate: `claude auth`
123
-
3. Check your subscription includes the selected model
124
-
4. Try a different model
125
-
126
-
127
-
### **Custom path not working**
128
-
**Problem**: Roo Code can't find your Claude CLI
129
-
**Solutions:**
130
-
- Use the full absolute path to the CLI executable
131
-
- Verify the path exists and the file is executable
132
-
- On Windows, you may need to include the `.exe` extension
133
-
134
-
135
-
## Advanced Usage
136
-
137
-
### **Custom Installation Paths**
138
-
If you installed Claude CLI in a non-standard location:
0 commit comments