Skip to content

README.md

Latest commit

 

History

History
202 lines (141 loc) · 9.71 KB

README.md

File metadata and controls

202 lines (141 loc) · 9.71 KB
Raw

VS Code Marketplace X YouTube Join Discord Join r/RooCode

Get help fast → Join Discord • Prefer async? → Join r/RooCode

Roo Code

Your AI-Powered Dev Team, Right in Your Editor

🌐 Available languages

What Can Roo Code Do For YOU?

  • Generate Code from natural language descriptions and specs
  • Adapt with Modes: Code, Architect, Ask, Debug, and Custom Modes
  • Refactor & Debug existing code
  • Write & Update documentation
  • Answer Questions about your codebase
  • Automate repetitive tasks
  • Utilize MCP Servers

Modes

Roo Code adapts to how you work:

  • Code Mode: everyday coding, edits, and file ops
  • Architect Mode: plan systems, specs, and migrations
  • Ask Mode: fast answers, explanations, and docs
  • Debug Mode: trace issues, add logs, isolate root causes
  • Custom Modes: build specialized modes for your team or workflow
  • Roomote Control: Roomote Control lets you remotely control tasks running in your local VS Code instance.

Learn more: Using Modes • Custom Modes • Roomote Control

Tutorial & Feature Videos

Installing Roo Code
Configuring Profiles
Codebase Indexing

Custom Modes
Checkpoints
Context Management

More quick tutorial and feature videos...

Resources

Local Setup & Development

  1. Clone the repo:
git clone https://github.com/RooCodeInc/Roo-Code.git
  1. Install dependencies:
pnpm install
  1. Run the extension:

There are several ways to run the Roo Code extension:

Development Mode (F5)

For active development, use VSCode's built-in debugging:

Press F5 (or go to Run → Start Debugging) in VSCode. This will open a new VSCode window with the Roo Code extension running.

  • Changes to the webview will appear immediately.
  • Changes to the core extension will also hot reload automatically.

Automated VSIX Installation

To build and install the extension as a VSIX package directly into VSCode:

pnpm install:vsix [-y] [--editor=<command>]

This command will:

  • Ask which editor command to use (code/cursor/code-insiders) - defaults to 'code'
  • Uninstall any existing version of the extension.
  • Build the latest VSIX package.
  • Install the newly built VSIX.
  • Prompt you to restart VS Code for changes to take effect.

Options:

  • -y: Skip all confirmation prompts and use defaults
  • --editor=<command>: Specify the editor command (e.g., --editor=cursor or --editor=code-insiders)

Manual VSIX Installation

If you prefer to install the VSIX package manually:

  1. First, build the VSIX package: 
    pnpm vsix
  2. A .vsix file will be generated in the bin/ directory (e.g., bin/roo-cline-<version>.vsix).
  3. Install it manually using the VSCode CLI: 
    code --install-extension bin/roo-cline-<version>.vsix

Nix Flake

A flake.nix is provided for Nix users:

nix develop        # Enter dev shell with all dependencies
pnpm install       # Install npm packages
pnpm build         # Build the project
pnpm test          # Run tests
pnpm vsix          # Create VSIX package

To build and install the extension directly:

nix build .#vsix && code --install-extension result/*.vsix

The dev shell provides Node.js 20.x, pnpm, ripgrep, and build tools for native modules.

After updating dependencies, run nix run .#update-deps to update flake.lock and the pnpm dependency hash.

If flakes aren't enabled, prefix commands with: nix --extra-experimental-features 'nix-command flakes' <command>

Note: Roo Code is also available as a pre-built extension in nixpkgs via vscode-extensions.rooveterinaryinc.roo-cline.

We use changesets for versioning and publishing. Check our CHANGELOG.md for release notes.

Disclaimer

Please note that Roo Code, Inc does not make any representations or warranties regarding any code, models, or other tools provided or made available in connection with Roo Code, any associated third-party tools, or any resulting outputs. You assume all risks associated with the use of any such tools or outputs; such tools are provided on an "AS IS" and "AS AVAILABLE" basis. Such risks may include, without limitation, intellectual property infringement, cyber vulnerabilities or attacks, bias, inaccuracies, errors, defects, viruses, downtime, property loss or damage, and/or personal injury. You are solely responsible for your use of any such tools or outputs (including, without limitation, the legality, appropriateness, and results thereof).

Contributing

We love community contributions! Get started by reading our CONTRIBUTING.md.

License

Apache 2.0 © 2025 Roo Code, Inc.

Enjoy Roo Code! Whether you keep it on a short leash or let it roam autonomously, we can’t wait to see what you build. If you have questions or feature ideas, drop by our Reddit community or Discord. Happy coding!