|
| 1 | +--- |
| 2 | +sidebar_label: Claude Code |
| 3 | +--- |
| 4 | + |
| 5 | +# Claude Code Provider |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +**Website:** [https://docs.anthropic.com/en/docs/claude-code/setup](https://docs.anthropic.com/en/docs/claude-code/setup) |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +## Key Features |
| 14 | +- **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 |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Why Use This Provider |
| 22 | + |
| 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 |
| 27 | + |
| 28 | +## How it Works |
| 29 | + |
| 30 | +The Claude Code provider works by: |
| 31 | + |
| 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 |
| 36 | + |
| 37 | +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 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Configuration |
| 42 | + |
| 43 | +You only need to configure one optional setting: |
| 44 | + |
| 45 | +### **Claude Code Path** |
| 46 | +- **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 |
| 50 | + |
| 51 | +**Example custom paths:** |
| 52 | +- Windows: `C:\tools\claude\claude.exe` |
| 53 | +- macOS/Linux: `/usr/local/bin/claude` or `~/bin/claude` |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## Supported Models |
| 58 | + |
| 59 | +The Claude Code provider supports these Claude models: |
| 60 | + |
| 61 | +- **Claude Sonnet 4** (latest, recommended) |
| 62 | +- **Claude Opus 4** (most capable) |
| 63 | +- **Claude 3.7 Sonnet** |
| 64 | +- **Claude 3.5 Sonnet** |
| 65 | +- **Claude 3.5 Haiku** (fast responses) |
| 66 | + |
| 67 | +The specific models available depend on your Claude CLI subscription and plan. |
| 68 | + |
| 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 (<Codicon name="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 | + |
| 91 | +--- |
| 92 | + |
| 93 | + |
| 94 | +## Common Questions |
| 95 | + |
| 96 | +**"Do I need a Claude API key for this provider?"** |
| 97 | +- No! This provider uses your Claude CLI setup instead of the web API |
| 98 | +- You'll need the Claude CLI installed and authenticated on your system |
| 99 | + |
| 100 | +**"How do I install the Claude CLI?"** |
| 101 | +- Visit [Anthropic's CLI documentation](https://docs.anthropic.com/en/docs/claude-code/setup) for installation instructions |
| 102 | +- The CLI handles its own authentication and setup |
| 103 | + |
| 104 | +**"Why would I use this instead of the regular Anthropic provider?"** |
| 105 | +- Potential cost benefits depending on your subscription |
| 106 | + |
| 107 | +**"What if the CLI isn't in my PATH?"** |
| 108 | +- Set a custom path in the Claude Code Path setting |
| 109 | +- Point to the full path where you installed the CLI |
| 110 | + |
| 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: |
| 139 | + |
| 140 | +```bash |
| 141 | +# Example custom paths |
| 142 | +/opt/claude/bin/claude # Linux custom install |
| 143 | +/Applications/Claude/claude # macOS app bundle |
| 144 | +C:\claude\claude.exe # Windows custom location |
| 145 | +``` |
0 commit comments