### Install Roo Code Dependencies

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/local-development-setup.mdx

Installs all necessary project dependencies using pnpm, the package manager for Roo Code. Ensure pnpm is installed globally before running this command.

```bash
pnpm install
```

--------------------------------

### Install Roo Code VSIX via CLI

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/local-development-setup.mdx

Installs a generated VSIX package for the Roo Code extension using the VS Code command-line interface. Replace `<version>` with the actual version number found in the `.vsix` filename.

```bash
code --install-extension bin/roo-cline-<version>.vsix
```

--------------------------------

### Website Creation Example

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/attempt-completion.md

Illustrates completing a website creation task. It provides a summary of the implemented features and includes an `npm start` command to demonstrate the running application.

```APIDOC
<attempt_completion>
  <result>
    I've created a simple React application with the following features:
    1. A responsive landing page with the requested hero section
    2. A working contact form with validation
    3. Navigation between all three requested pages
    4. Styling that matches the provided design mockup
  </result>
  <command>npm start</command>
</attempt_completion>
```

--------------------------------

### Search Testing Utilities

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/codebase-search.md

Example of searching for testing utilities, including test setup and mock data creation, within the 'tests' directory.

```xml
<codebase_search>
<query>test setup and mock data creation</query>
<path>tests</path>
</codebase_search>
```

--------------------------------

### Roo Code MCP Server Creation Request Examples

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/mcp/using-mcp-in-roo.mdx

Examples of user requests to Roo Code for creating new MCP servers with specific functionalities. These requests guide Roo in fetching instructions and scaffolding the new server project.

```English
Create an MCP tool that gets the current price of Bitcoin.
I need a tool that connects to my company's internal user database via its API.
Build an MCP server to interact with the GitHub Gist API.
```

--------------------------------

### LiteLLM Configuration Example

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/providers/litellm.md

A conceptual example of a LiteLLM configuration file, showing how models and their properties might be defined, which Roo Code then consumes.

```YAML
model_list:
  - model_name: "openrouter/anthropic/claude-3.5-sonnet"
    litellm_params:
      model: "claude-3.5-sonnet"
      api_key: "sk-xxxxxxxxxxxx"
      provider: "anthropic"
    model_info:
      max_tokens: 200000
      context_window: 200000
      supports_vision: true
      supports_prompt_caching: true
      input_cost_per_token: 0.0000015
      output_cost_per_token: 0.0000075
  - model_name: "openai/gpt-4o"
    litellm_params:
      model: "gpt-4o"
      api_key: "sk-yyyyyyyyyyyy"
      provider: "openai"
    model_info:
      max_tokens: 128000
      context_window: 128000
      supports_vision: true
      input_cost_per_token: 0.000005
      output_cost_per_token: 0.000015
```

--------------------------------

### Examples of Custom Instructions

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/custom-instructions.md

Provides a list of example custom instructions that users can provide to guide the system's behavior, covering aspects like code style, testing, and development practices.

```text
"Always use spaces for indentation, with a width of 4 spaces"
"Use camelCase for variable names"
"Write unit tests for all new functions"
"Explain your reasoning before providing code"
"Focus on code readability and maintainability"
"Prioritize using the most common library in the community"
"When adding new features to websites, ensure they are responsive and accessible"
```

--------------------------------

### Git Installation on Windows

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/checkpoints.mdx

Steps to download and install Git for Windows, including recommended installer options and verification via Command Prompt or PowerShell.

```bash
Download from https://git-scm.com/download/win

Run the installer, accepting defaults or recommended options.

Verify installation:
Open Command Prompt or PowerShell
Type:
git --version
```

--------------------------------

### Start LiteLLM Server (Bash)

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/providers/litellm.md

Starts the LiteLLM proxy server. The recommended method uses a configuration file. Alternatively, a quick start option allows running with a single model by setting environment variables.

```bash
# Using configuration file (recommended)
litellm --config config.yaml

# Or quick start with a single model
export ANTHROPIC_API_KEY=your-anthropic-key
litellm --model claude-3-7-sonnet-20250219
```

--------------------------------

### Execute npm Run Dev Command

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/execute-command.md

Runs the 'npm run dev' command, typically used to start a development server for a project. This example demonstrates executing a single command in the current directory.

```shell
npm run dev
```

--------------------------------

### Switch Mode Command Examples

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/switch-mode.md

Examples demonstrating how to switch Roo's operational mode using a custom XML-like syntax. Each example specifies the target mode and the reason for the switch.

```XML
<switch_mode>
<mode_slug>code</mode_slug>
<reason>Need to implement the login functionality based on the architecture we've discussed</reason>
</switch_mode>
```

```XML
<switch_mode>
<mode_slug>architect</mode_slug>
<reason>Need to design the system architecture before implementation</reason>
</switch_mode>
```

```XML
<switch_mode>
<mode_slug>debug</mode_slug>
<reason>Need to systematically diagnose the authentication error</reason>
</switch_mode>
```

```XML
<switch_mode>
<mode_slug>ask</mode_slug>
<reason>Need to answer questions about the implemented feature</reason>
</switch_mode>
```

--------------------------------

### MCP Tool Invocation Examples

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/use-mcp-tool.md

Provides examples of how to invoke the `use_mcp_tool` for various tasks, including requesting text data, analyzing code, generating images, and accessing resources. Each example shows the required XML-like structure with server, tool, and arguments.

```APIDOC
Example: Requesting weather forecast data with text response:
<use_mcp_tool>
<server_name>weather-server</server_name>
<tool_name>get_forecast</tool_name>
<arguments>
{
  "city": "San Francisco",
  "days": 5,
  "format": "text"
}
</arguments>
</use_mcp_tool>

Example: Analyzing source code with a specialized tool returning JSON:
<use_mcp_tool>
<server_name>code-analysis</server_name>
<tool_name>complexity_metrics</tool_name>
<arguments>
{
  "language": "typescript",
  "file_path": "src/app.ts",
  "include_functions": true,
  "metrics": ["cyclomatic", "cognitive"]
}
</arguments>
</use_mcp_tool>

Example: Generating an image with specific parameters:
<use_mcp_tool>
<server_name>image-generation</server_name>
<tool_name>create_image</tool_name>
<arguments>
{
  "prompt": "A futuristic city with flying cars",
  "style": "photorealistic",
  "dimensions": {
    "width": 1024,
    "height": 768
  },
  "format": "webp"
}
</arguments>
</use_mcp_tool>

Example: Accessing a resource through a tool returning a resource reference:
<use_mcp_tool>
<server_name>database-connector</server_name>
<tool_name>query_and_store</tool_name>
<arguments>
{
  "database": "users",
  "type": "select",
  "fields": ["name", "email", "last_login"],
  "where": {
    "status": "active"
  },
  "store_as": "active_users"
}
</arguments>
</use_mcp_tool>

Example: Tool with no required arguments:
<use_mcp_tool>
<server_name>system-monitor</server_name>
<tool_name>get_current_status</tool_name>
<arguments>
{}
</arguments>
</use_mcp_tool>
```

--------------------------------

### Claude CLI Setup and Authentication

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/providers/claude-code.md

Instructions for setting up and authenticating the Claude CLI for use with Roo Code. This includes installing the CLI, running it to start the application, and using the `/login` command to authenticate with your Anthropic account.

```APIDOC
Claude CLI Setup:

1. Install Claude CLI: Download and install from Anthropic's documentation.
2. Authenticate:
   - Run `claude` in your terminal.
   - Type `/login` to sign in to your Anthropic account.
3. Verify Setup:
   - Run `claude --version` to confirm the CLI is working.
```

--------------------------------

### Qdrant Docker Setup

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/codebase-indexing.mdx

Provides instructions for setting up a Qdrant vector database locally using Docker. This is a free option for storing and searching code embeddings.

```bash
docker run -p 6333:6333 qdrant/qdrant
```

--------------------------------

### Verify Git Installation (Linux)

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/checkpoints.mdx

Checks if Git is installed and displays its version. This command is run in the terminal after installation to confirm successful setup.

```Shell
git --version
```

--------------------------------

### Initialize SPARC Project

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/community/sparc.md

Scaffold a new SPARC project structure, including subdirectories, configurations, and boilerplate code. This command is run from your root directory to initiate the project setup.

```bash
npx create-sparc init
npx create-sparc --help
```

--------------------------------

### Build and Start Project with npm

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/execute-command.md

Executes a sequence of commands: first, 'npm run build' to compile or bundle the project, followed by 'npm start' to launch the application. This shows running multiple commands in a single execution block.

```shell
npm run build && npm start
```

--------------------------------

### Write File Example (XML)

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/basic-usage/how-tools-work.md

Demonstrates the usage of the `write_to_file` tool, which creates or overwrites a file with specified content. This example shows the XML structure for proposing the tool, including the file path, content, and line count, pending user approval.

```xml
<write_to_file>
<path>greeting.js</path>
<content>
function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet('World');
</content>
<line_count>5</line_count>
</write_to_file>
```

--------------------------------

### Project-Level Configuration for Context7 (Windows cmd.exe)

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/mcp/recommended-mcp-servers.md

This JSON snippet offers a Windows-specific configuration for Context7 within a project's `.roo/mcp.json` file. It specifies 'cmd' to execute npx, ensuring proper server launch in the Windows command prompt for project-specific setups.

```json
{
  "mcpServers": {
    "context7": {
      "type": "stdio",
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@upstash/context7-mcp@latest"]
    }
  }
}
```

--------------------------------

### Effective Query Patterns for Codebase Search

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/codebase-search.md

Provides examples of effective and less effective query patterns for the codebase search tool, guiding users to formulate precise and relevant searches.

```XML
<codebase_search>
  <query>user authentication and password validation</query>
</codebase_search>

<codebase_search>
  <query>database connection pool setup</query>
</codebase_search>

<codebase_search>
  <query>error handling for API requests</query>
</codebase_search>

<codebase_search>
  <query>function</query>
</codebase_search>
```

--------------------------------

### Fetch System Configuration

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/access-mcp-resource.md

This example shows how to retrieve system configuration, specifically for a production database. It uses the 'infra-monitor' server and a 'config://' URI.

```xml
<access_mcp_resource>
<server_name>infra-monitor</server_name>
<uri>config://production/database</uri>
</access_mcp_resource>
```

--------------------------------

### Build Roo Code VSIX Package

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/local-development-setup.mdx

Builds a VSIX (Visual Studio Code Extension) package for the Roo Code extension. This package can be installed manually in VS Code.

```bash
pnpm vsix
```

--------------------------------

### Roo Code UI Components

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/getting-started/your-first-task.md

Illustrates the usage of custom UI components within the Roo Code VS Code extension for user interaction.

```JavaScript
import KangarooIcon from '@site/src/components/KangarooIcon';

// Usage example:
// <KangarooIcon />

// Another component example:
// <Codicon name="send" />
```

--------------------------------

### List Code Definitions in Current Directory

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/advanced-usage/available-tools/list-code-definition-names.md

Lists key code definitions within the current directory. This is useful for getting an overview of the project's structure when starting new tasks or exploring unfamiliar codebases.

```APIDOC
Command: list_code_definition_names

Description:
  Lists key code definitions (e.g., classes, functions) within a specified path to understand project structure and identify relevant code constructs.

Parameters:
  - path: (string) The directory or module path to examine.

Usage Examples:

1. Listing code definitions in the current directory:
   <list_code_definition_names>
     <path>.</path>
   </list_code_definition_names>

2. Examining a specific module's structure:
   <list_code_definition_names>
     <path>src/components</path>
   </list_code_definition_names>

3. Exploring a utility library:
   <list_code_definition_names>
     <path>lib/utils</path>
   </list_code_definition_names>

Purpose:
  Helps developers understand project structure, identify affected components during refactoring, and locate potential sources of issues when troubleshooting bugs.
```

--------------------------------

### Create Custom Mode via Natural Language

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/custom-modes.mdx

Example of using natural language prompts to create a new custom mode with Roo Code. The system guides the user through necessary information for mode properties and generates the mode in YAML format.

```natural-language
Create a new mode called "Documentation Writer". It should only be able to read files and write Markdown files.
```

--------------------------------

### Qdrant Docker Compose Setup

Source: https://github.com/roovetgit/roo-code-docs/blob/main/docs/features/codebase-indexing.mdx

Provides instructions for setting up a Qdrant vector database locally using Docker Compose. This configuration includes persistent storage for the Qdrant data.

```yaml
version: '3.8'
services:
  qdrant:
    image: qdrant/qdrant
    ports:
      - "6333:6333"
    volumes:
      - qdrant_storage:/qdrant/storage
volumes:
  qdrant_storage:
```