|
|
1 месяц назад | |
|---|---|---|
| .. | ||
| src | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| README.md | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| eslint.config.mjs | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| package.json | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| tsconfig.json | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| tsup.config.ts | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
| vitest.config.ts | b11d53adf4 VSCode shim + basic cli (#10452) | 1 месяц назад |
Command Line Interface for Roo Code - Run the Roo Code agent from the terminal without VSCode.
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.
# 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
By default, the CLI prompts for approval before executing actions:
export OPENROUTER_API_KEY=sk-or-v1-...
pnpm --filter @roo-code/cli start \
-x \
-p openrouter \
-k $OPENROUTER_API_KEY \
-m anthropic/claude-sonnet-4.5 \
--workspace ~/Documents/my-project \
"What is this project?"
In interactive mode:
-y)For automation and scripts, use -y to auto-approve all actions:
pnpm --filter @roo-code/cli start \
-y \
-x \
-p openrouter \
-k $OPENROUTER_API_KEY \
-m anthropic/claude-sonnet-4.5 \
--workspace ~/Documents/my-project \
"Refactor the utils.ts file"
In non-interactive mode:
| 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.
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 |
┌─────────────────┐
│ CLI Entry │
│ (index.ts) │
└────────┬────────┘
│
▼
┌─────────────────┐
│ ExtensionHost │
│ (extension- │
│ host.ts) │
└────────┬────────┘
│
┌────┴────┐
│ │
▼ ▼
┌───────┐ ┌──────────┐
│vscode │ │Extension │
│-shim │ │ Bundle │
└───────┘ └──────────┘
CLI Entry Point (index.ts): Parses command line arguments and initializes the ExtensionHost
ExtensionHost (extension-host.ts):
@roo-code/vscode-shimrequire('vscode') to return the mockMessage Flow:
emit("webviewMessage", {...})emit("extensionWebviewMessage", {...})# Watch mode for development
pnpm dev
# Run tests
pnpm test
# Type checking
pnpm check-types
# Linting
pnpm lint
Make sure you've built the main extension first:
cd src
pnpm bundle
The CLI expects the extension to be a CommonJS bundle. Make sure the extension's esbuild config outputs CommonJS.
The CLI intercepts require('vscode') calls. If you see this error, the module resolution interception may have failed.