mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
861139ca24
Co-authored-by: roomote[bot] <219738659+roomote[bot]@users.noreply.github.com> Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
231 lines
7 KiB
Markdown
231 lines
7 KiB
Markdown
# @roo-code/cli
|
|
|
|
Command Line Interface for Roo Code - Run the Roo Code agent from the terminal without VSCode.
|
|
|
|
## Overview
|
|
|
|
This CLI uses the `@roo-code/vscode-shim` package to provide a VSCode API compatibility layer, allowing the main Roo Code extension to run in a Node.js environment.
|
|
|
|
## Installation
|
|
|
|
### Quick Install (Recommended)
|
|
|
|
Install the Roo Code CLI with a single command:
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/RooCodeInc/Roo-Code/main/apps/cli/install.sh | sh
|
|
```
|
|
|
|
**Requirements:**
|
|
|
|
- Node.js 20 or higher
|
|
- macOS (Intel or Apple Silicon) or Linux (x64 or ARM64)
|
|
|
|
**Custom installation directory:**
|
|
|
|
```bash
|
|
ROO_INSTALL_DIR=/opt/roo-code ROO_BIN_DIR=/usr/local/bin curl -fsSL ... | sh
|
|
```
|
|
|
|
**Install a specific version:**
|
|
|
|
```bash
|
|
ROO_VERSION=0.1.0 curl -fsSL https://raw.githubusercontent.com/RooCodeInc/Roo-Code/main/apps/cli/install.sh | sh
|
|
```
|
|
|
|
### Updating
|
|
|
|
Re-run the install script to update to the latest version:
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/RooCodeInc/Roo-Code/main/apps/cli/install.sh | sh
|
|
```
|
|
|
|
### Uninstalling
|
|
|
|
```bash
|
|
rm -rf ~/.roo/cli ~/.local/bin/roo
|
|
```
|
|
|
|
### Development Installation
|
|
|
|
For contributing or development:
|
|
|
|
```bash
|
|
# From the monorepo root.
|
|
pnpm install
|
|
|
|
# Build the main extension first.
|
|
pnpm --filter roo-cline bundle
|
|
|
|
# Build the cli.
|
|
pnpm --filter @roo-code/cli build
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Interactive Mode (Default)
|
|
|
|
By default, the CLI prompts for approval before executing actions:
|
|
|
|
```bash
|
|
export OPENROUTER_API_KEY=sk-or-v1-...
|
|
|
|
roo "What is this project?" --workspace ~/Documents/my-project
|
|
```
|
|
|
|
In interactive mode:
|
|
|
|
- Tool executions prompt for yes/no approval
|
|
- Commands prompt for yes/no approval
|
|
- Followup questions show suggestions and wait for user input
|
|
- Browser and MCP actions prompt for approval
|
|
|
|
### Non-Interactive Mode (`-y`)
|
|
|
|
For automation and scripts, use `-y` to auto-approve all actions:
|
|
|
|
```bash
|
|
roo -y "Refactor the utils.ts file" --workspace ~/Documents/my-project
|
|
```
|
|
|
|
In non-interactive mode:
|
|
|
|
- Tool, command, browser, and MCP actions are auto-approved
|
|
- Followup questions show a 10-second timeout, then auto-select the first suggestion
|
|
- Typing any key cancels the timeout and allows manual input
|
|
|
|
## Options
|
|
|
|
| Option | Description | Default |
|
|
| --------------------------------- | ------------------------------------------------------------------------------ | ----------------- |
|
|
| `-w, --workspace <path>` | Workspace path to operate in | Current directory |
|
|
| `-e, --extension <path>` | Path to the extension bundle directory | Auto-detected |
|
|
| `-v, --verbose` | Enable verbose output (show VSCode and extension logs) | `false` |
|
|
| `-d, --debug` | Enable debug output (includes detailed debug information, prompts, paths, etc) | `false` |
|
|
| `-x, --exit-on-complete` | Exit the process when task completes (useful for testing) | `false` |
|
|
| `-y, --yes` | Non-interactive mode: auto-approve all actions | `false` |
|
|
| `-k, --api-key <key>` | API key for the LLM provider | From env var |
|
|
| `-p, --provider <provider>` | API provider (anthropic, openai, openrouter, etc.) | `openrouter` |
|
|
| `-m, --model <model>` | Model to use | Provider default |
|
|
| `-M, --mode <mode>` | Mode to start in (code, architect, ask, debug, etc.) | `code` |
|
|
| `-r, --reasoning-effort <effort>` | Reasoning effort level (none, minimal, low, medium, high, xhigh) | `medium` |
|
|
|
|
By default, the CLI runs in quiet mode (suppressing VSCode/extension logs) and only shows assistant output. Use `-v` to see all logs, or `-d` for detailed debug information.
|
|
|
|
## Environment Variables
|
|
|
|
The CLI will look for API keys in environment variables if not provided via `--api-key`:
|
|
|
|
| Provider | Environment Variable |
|
|
| ------------- | -------------------- |
|
|
| anthropic | `ANTHROPIC_API_KEY` |
|
|
| openai | `OPENAI_API_KEY` |
|
|
| openrouter | `OPENROUTER_API_KEY` |
|
|
| google/gemini | `GOOGLE_API_KEY` |
|
|
| mistral | `MISTRAL_API_KEY` |
|
|
| deepseek | `DEEPSEEK_API_KEY` |
|
|
| bedrock | `AWS_ACCESS_KEY_ID` |
|
|
|
|
## Architecture
|
|
|
|
```
|
|
┌─────────────────┐
|
|
│ CLI Entry │
|
|
│ (index.ts) │
|
|
└────────┬────────┘
|
|
│
|
|
▼
|
|
┌─────────────────┐
|
|
│ ExtensionHost │
|
|
│ (extension- │
|
|
│ host.ts) │
|
|
└────────┬────────┘
|
|
│
|
|
┌────┴────┐
|
|
│ │
|
|
▼ ▼
|
|
┌───────┐ ┌──────────┐
|
|
│vscode │ │Extension │
|
|
│-shim │ │ Bundle │
|
|
└───────┘ └──────────┘
|
|
```
|
|
|
|
## How It Works
|
|
|
|
1. **CLI Entry Point** (`index.ts`): Parses command line arguments and initializes the ExtensionHost
|
|
|
|
2. **ExtensionHost** (`extension-host.ts`):
|
|
|
|
- Creates a VSCode API mock using `@roo-code/vscode-shim`
|
|
- Intercepts `require('vscode')` to return the mock
|
|
- Loads and activates the extension bundle
|
|
- Manages bidirectional message flow
|
|
|
|
3. **Message Flow**:
|
|
- CLI → Extension: `emit("webviewMessage", {...})`
|
|
- Extension → CLI: `emit("extensionWebviewMessage", {...})`
|
|
|
|
## Current Limitations
|
|
|
|
- **No TUI**: Output is plain text (no React/Ink UI yet)
|
|
- **No configuration file**: Settings are passed via command line flags
|
|
- **No persistence**: Each run is a fresh session
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Watch mode for development
|
|
pnpm dev
|
|
|
|
# Run tests
|
|
pnpm test
|
|
|
|
# Type checking
|
|
pnpm check-types
|
|
|
|
# Linting
|
|
pnpm lint
|
|
```
|
|
|
|
## Releasing
|
|
|
|
To create a new release, run the release script from the monorepo root:
|
|
|
|
```bash
|
|
# Release using version from package.json
|
|
./apps/cli/scripts/release.sh
|
|
|
|
# Release with a specific version
|
|
./apps/cli/scripts/release.sh 0.1.0
|
|
```
|
|
|
|
The script will:
|
|
|
|
1. Build the extension and CLI
|
|
2. Create a platform-specific tarball (for your current OS/architecture)
|
|
3. Create a GitHub release with the tarball attached
|
|
|
|
**Prerequisites:**
|
|
|
|
- GitHub CLI (`gh`) installed and authenticated (`gh auth login`)
|
|
- pnpm installed
|
|
|
|
## Troubleshooting
|
|
|
|
### Extension bundle not found
|
|
|
|
Make sure you've built the main extension first:
|
|
|
|
```bash
|
|
cd src
|
|
pnpm bundle
|
|
```
|
|
|
|
### Module resolution errors
|
|
|
|
The CLI expects the extension to be a CommonJS bundle. Make sure the extension's esbuild config outputs CommonJS.
|
|
|
|
### "vscode" module not found
|
|
|
|
The CLI intercepts `require('vscode')` calls. If you see this error, the module resolution interception may have failed.
|