Merge branch 'RooCodeInc:main' into add-litellm-docs

colesmcintosh · web-flow · commit aee8a2170d0d · 2025-07-08T12:15:15.000-06:00
diff --git a/.roomodes b/.roomodes
@@ -1,29 +1,8 @@
 customModes:
-  - slug: documentation-writer
-    name: 📝 Documentation Writer
-    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.
-    whenToUse: Use this mode for creating or updating documentation in Markdown (.md, .mdx) files.
-    groups:
-      - read
-      - command
-      - - edit
-        - fileRegex: \.(md|mdx)$
-          description: Documentation files
-    source: project
   - slug: release-notes-writer
     name: Release Notes Writer
-    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.
-    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.
+    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."
+    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.
     groups:
       - read
       - command
@@ -34,25 +13,23 @@ customModes:
     source: project
   - slug: mode-writer
     name: ✍️ Mode Writer
-    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
+    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"
     whenToUse: Use this mode when you need to create a new custom mode.
     groups:
       - read
       - - edit
         - fileRegex: (\.roomodes$|\.roo/.*\.xml$|\.yaml$)
           description: Mode configuration files and XML instructions
       - command
+  - slug: documentation-writer
+    name: 📝 Documentation Writer
+    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.
+    whenToUse: Use this mode for creating or updating documentation in Markdown (.md, .mdx) files.
+    groups:
+      - read
+      - command
+      - - edit
+        - fileRegex: (\.(md|mdx)$|sidebars\.ts$)
+          description: Documentation files and sidebar configuration
+      - mcp
+    source: project
diff --git a/docs/providers/claude-code.md b/docs/providers/claude-code.md
@@ -6,33 +6,54 @@ sidebar_label: Claude Code
 
 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.
 
+:::info Setup Instructions
+Before using the Claude Code provider, ensure you have completed the following steps:
+
+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).
+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.
+3.  **Verify Setup**: Confirm the CLI is working by running `claude --version`. This ensures that Roo Code can find and use the executable.
+4.  **Configure in Roo Code**:
+    *   Go to Roo Code settings and select **"Claude Code"** as your API provider.
+    *   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.
+    *   Choose your desired model from the list of available options.
+
+Once configured, Roo Code will use your local Claude CLI installation to interact with Anthropic's models, leveraging your existing subscription.
+:::
+
+
+:::warning Environment Variable Usage
+The `claude` command-line tool, like other Anthropic SDKs, can use the `ANTHROPIC_API_KEY` environment variable for authentication. This is a common method for authorizing CLI tools in non-interactive environments.
+
+If this environment variable is set on your system, the `claude` tool may use it for authentication instead of the interactive `/login` method. When Roo Code executes the tool, it will accurately reflect that an API key is being used, as this is the underlying behavior of the `claude` CLI itself.
+:::
+
 **Website:** [https://docs.anthropic.com/en/docs/claude-code/setup](https://docs.anthropic.com/en/docs/claude-code/setup)
 
 ---
 
 ## Key Features
-- **Direct CLI Access**: Uses Anthropic's official Claude CLI tool for model interactions
-- **Advanced Reasoning**: Full support for Claude's thinking mode and reasoning capabilities
-- **Cost Transparency**: Shows exact usage costs as reported by the CLI
-- **Flexible Configuration**: Works with your existing Claude CLI setup
+- **Direct CLI Access**: Uses Anthropic's official Claude CLI tool for model interactions.
+- **Advanced Reasoning**: Full support for Claude's thinking mode and reasoning capabilities.
+- **Cost Transparency**: Shows exact usage costs as reported by the CLI.
+- **Flexible Configuration**: Works with your existing Claude CLI setup.
 
 ---
 
 ## Why Use This Provider
 
-- **No API Keys**: Uses your existing Claude CLI authentication
-- **Cost Benefits**: Leverage CLI subscription rates and transparent cost reporting
-- **Latest Features**: Access new Claude capabilities as they're released in the CLI
-- **Advanced Reasoning**: Full support for Claude's thinking modes
+- **No API Keys**: Uses your existing Claude CLI authentication.
+- **Cost Benefits**: Leverage CLI subscription rates and transparent cost reporting.
+- **Latest Features**: Access new Claude capabilities as they're released in the CLI.
+- **Advanced Reasoning**: Full support for Claude's thinking modes.
 
 ## How it Works
 
 The Claude Code provider works by:
 
-1. **Running Commands**: Executes the `claude` CLI command with your prompts
-2. **Processing Output**: Handles the CLI's JSON output in chunks with advanced parsing
-3. **Handling Reasoning**: Captures and displays Claude's thinking process when available
-4. **Tracking Usage**: Reports token usage and costs as provided by the CLI
+1. **Running Commands**: Executes the `claude` CLI command with your prompts.
+2. **Processing Output**: Handles the CLI's JSON output in chunks with advanced parsing.
+3. **Handling Reasoning**: Captures and displays Claude's thinking process when available.
+4. **Tracking Usage**: Reports token usage and costs as provided by the CLI.
 
 The provider integrates with Roo Code's interface, giving you the same experience as other providers while using the Claude CLI under the hood.
 
@@ -44,12 +65,11 @@ You only need to configure one optional setting:
 
 ### **Claude Code Path**
 - **Setting**: `claudeCodePath`
-- **Description**: Path to your Claude CLI executable
-- **Default**: `claude` (assumes it's in your system PATH)
-- **When to change**: If you installed Claude CLI in a custom location
+- **Description**: Path to your Claude CLI executable.
+- **Default**: `claude` (assumes it's in your system PATH).
+- **When to change**: If you installed Claude CLI in a custom location.
 
 **Example custom paths:**
-- Windows: `C:\tools\claude\claude.exe`
 - macOS/Linux: `/usr/local/bin/claude` or `~/bin/claude`
 
 ---
@@ -66,36 +86,15 @@ The Claude Code provider supports these Claude models:
 
 The specific models available depend on your Claude CLI subscription and plan.
 
----
-
-## Prerequisites
-
-Before using the Claude Code provider:
-
-1. **Install Claude CLI**: Download and install from Anthropic
-2. **Authenticate**: Run `claude auth` to sign in to your account
-3. **Verify Setup**: Test with `claude --version` to ensure it's working
-4. **Optional**: Add CLI location to PATH or configure custom path in settings
-
-## Configuration in Roo Code
-
-**Initial Setup Option:**
-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.
-
-**Manual Configuration:**
-1. **Open Roo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Roo Code panel.
-2. **Select Provider:** Choose "Claude Code" from the "API Provider" dropdown.
-3. **Configure Path (Optional):** If needed, set the "Claude Code Path" to your CLI executable location.
-4. **Select Model:** Choose your desired Claude model from the "Model" dropdown.
 
 ---
 
 
 ## Common Questions
 
 **"Do I need a Claude API key for this provider?"**
-- No! This provider uses your Claude CLI setup instead of the web API
-- You'll need the Claude CLI installed and authenticated on your system
+- Typically no. You can authenticate interactively using the `/login` command within the `claude` application.
+- However, if the `ANTHROPIC_API_KEY` environment variable is set, the Claude CLI may use it for authentication. See the warning above for details.
 
 **"How do I install the Claude CLI?"**
 - Visit [Anthropic's CLI documentation](https://docs.anthropic.com/en/docs/claude-code/setup) for installation instructions
@@ -108,38 +107,3 @@ The Claude Code provider can be selected during your initial Roo Code setup with
 - Set a custom path in the Claude Code Path setting
 - Point to the full path where you installed the CLI
 
-
----
-
-## Troubleshooting
-
-### **"Claude Code process exited with error"**
-**Common causes:**
-- Claude CLI not installed or not in PATH
-
-**Solutions:**
-1. Verify CLI installation: `claude --version`
-2. Re-authenticate: `claude auth`
-3. Check your subscription includes the selected model
-4. Try a different model
-
-
-### **Custom path not working**
-**Problem**: Roo Code can't find your Claude CLI
-**Solutions:**
-- Use the full absolute path to the CLI executable
-- Verify the path exists and the file is executable
-- On Windows, you may need to include the `.exe` extension
-
-
-## Advanced Usage
-
-### **Custom Installation Paths**
-If you installed Claude CLI in a non-standard location:
-
-```bash
-# Example custom paths
-/opt/claude/bin/claude          # Linux custom install
-/Applications/Claude/claude     # macOS app bundle
-C:\claude\claude.exe           # Windows custom location
-```
diff --git a/docs/providers/gemini-cli.md b/docs/providers/gemini-cli.md
diff --git a/sidebars.ts b/sidebars.ts
@@ -131,7 +131,6 @@ const sidebars: SidebarsConfig = {
         'providers/deepseek',
         'providers/chutes',
         'providers/gemini',
-        'providers/gemini-cli',
         'providers/glama',
         'providers/groq',
         'providers/human-relay',
