Skip to content

Commit 2bcacdc

Browse files
committed
docs: enhance installation instructions for Roo Code extension
1 parent 3143b56 commit 2bcacdc

File tree

5 files changed

+55
-44
lines changed

5 files changed

+55
-44
lines changed

docs/getting-started/installing.md

Lines changed: 55 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,73 @@ sidebar_label: Installing Roo Code
44

55
# Installing Roo Code
66

7-
Roo Code is a VS Code extension that brings AI-powered coding assistance to your editor. There are three main ways to install it:
7+
Roo Code is a VS Code extension that brings AI-powered coding assistance directly to your editor. Install using one of these methods:
88

9-
1. **From the VS Code Marketplace (Recommended)**
10-
2. **From the Open VSX Registry**
11-
3. **From a VSIX file (Advanced)**
9+
1. **VS Code Marketplace (Recommended)** - fastest method for standard VS Code users
10+
2. **Open VSX Registry** - for VS Code-compatible editors like VSCodium
11+
3. **VSIX File (Advanced)** - offline installation or specific builds
1212

13-
## 1. Installation from the VS Code Marketplace
13+
## VS Code Marketplace
1414

15-
This is the easiest and recommended method for most users.
15+
1. Open VS Code
16+
2. Access Extensions: Click the Extensions icon in the Activity Bar or press `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (macOS)
17+
3. Search for "Roo Code"
18+
4. Select "Roo Code" by RooVeterinaryInc and click **Install**
19+
5. Reload VS Code if prompted
1620

17-
1. **Open VS Code.**
18-
2. **Open the Extensions View:**
19-
* Click the Extensions icon in the Activity Bar on the side of VS Code. (It looks like four squares, with one detached.)
20-
* Or, use the keyboard shortcut: `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (macOS).
21-
3. **Search for Roo Code:** In the Extensions view search box, type `Roo Code`.
22-
4. **Install:** Find "Roo Code" in the search results (by RooVeterinaryInc). Click the **Install** button.
23-
5. **Reload (if required):** VS Code may prompt you to reload. If so, click the **Reload** button.
21+
After installation, find the Roo Code icon (<Codicon name="rocket" />) in the Activity Bar to open the Roo Code panel.
2422

25-
Once installed, you'll see the Roo Code icon (<Codicon name="rocket" />) in the Activity Bar. Click it to open the Roo Code panel.
23+
<img src="/img/installing/installing.png" alt="VS Code marketplace with Roo Code extension ready to install" width="400" />
24+
*VS Code marketplace with Roo Code extension ready to install*
2625

27-
## 2. Installation from the Open VSX Registry
26+
## Open VSX Registry
2827

29-
If you're using a VS Code-compatible editor that doesn't have access to the VS Code Marketplace (like VSCodium), you can install Roo Code from the Open VSX Registry.
28+
For VS Code-compatible editors without Marketplace access (like VSCodium):
3029

31-
1. **Open your editor.**
32-
2. **Open the Extensions View.**
33-
3. **Search for Roo Code:** Type `Roo Code` in the Extensions view search box.
34-
4. **Install:** Find "Roo Code" in the search results (by RooVeterinaryInc). Click the **Install** button.
35-
5. **Reload (if required):** Your editor may prompt you to reload. If so, click the reload button.
30+
1. Open your editor
31+
2. Access the Extensions view
32+
3. Search for "Roo Code"
33+
4. Select "Roo Code" by RooVeterinaryInc and click **Install**
34+
5. Reload if prompted
3635

37-
## 3. Installation from a VSIX File (Advanced)
36+
<img src="/img/installing/installing-1.png" alt="Open VSX Registry with Roo Code extension ready to install" width="400" />
37+
*Open VSX Registry with Roo Code extension ready to install*
3838

39-
This method is useful if you're developing Roo Code, testing a specific build, or need to install it offline.
39+
## VSIX File Installation
4040

41-
1. **Download the VSIX file:**
42-
* **Releases:** You can find official releases on the [Roo Code GitHub Releases page](https://github.com/RooVetGit/Roo-Code/releases). Download the `.vsix` file from the latest release.
43-
* **Development Builds:** If you're building the extension yourself, the `.vsix` file is located in the `bin/` directory after running `npm run package`.
41+
For offline installation, development testing, or specific builds:
4442

45-
2. **Open VS Code.**
46-
3. **Open the Extensions View.**
47-
4. **Install from VSIX:**
48-
* Click the **"..."** (Views and More Actions...) menu in the top-right corner of the Extensions view.
49-
* Select **"Install from VSIX..."**
50-
* Browse to the downloaded `.vsix` file and select it.
51-
5. **Reload (if required):** VS Code may prompt you to reload. If so, click the **Reload** button.
43+
1. Get the VSIX file:
44+
* Download from [GitHub Releases](https://github.com/RooVetGit/Roo-Code/releases)
45+
* For development builds: find in `bin/` after running `npm run build`
46+
2. In VS Code, open Extensions view
47+
3. Click "..." menu (top-right) and select "Install from VSIX..."
48+
4. Browse to and select the downloaded or generated `.vsix` file
49+
5. Reload VS Code if prompted
5250

53-
## Troubleshooting Installation
51+
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="400" />
52+
*VS Code's "Install from VSIX" dialog with Roo Code VSIX file selected*
5453

55-
* **Extension Doesn't Appear:**
56-
* Make sure you've restarted VS Code after installation.
57-
* Check the Extensions view to see if Roo Code is listed and enabled.
58-
* Try disabling and re-enabling the extension.
59-
* Check for any error messages in the VS Code Output panel (View -> Output, then select "Roo Code" from the dropdown).
60-
* **Marketplace Issues:**
61-
* If you're having trouble with the VS Code Marketplace, try installing from a VSIX file (see instructions above).
62-
* Ensure you have a stable internet connection.
63-
* **Compatibility:** Roo Code requires VS Code version 1.84.0 or later.
54+
## Troubleshooting
6455

65-
If you continue to experience problems, please visit our [GitHub Issues page](https://github.com/RooVetGit/Roo-Code/issues) or [Reddit community](https://www.reddit.com/r/RooCode) to report the issue or ask for help.
56+
<img src="/img/installing/installing-4.png" alt="VS Code Output panel showing Roo Code logs for troubleshooting" width="100%" />
57+
*VS Code Output panel showing Roo Code logs for troubleshooting*
58+
59+
**Extension Not Visible**
60+
* Restart VS Code
61+
* Verify Roo Code is listed and enabled in Extensions
62+
* Try disabling and re-enabling
63+
* Check Output panel for errors (View → Output, select "Roo Code")
64+
65+
**Installation Problems**
66+
* Try the VSIX installation method if Marketplace access fails
67+
* Ensure stable internet connection
68+
* Verify VS Code version 1.84.0 or later
69+
70+
## Getting Support
71+
72+
If you encounter issues not covered here:
73+
74+
* Join our [Discord community](https://discord.gg/roocode) for real-time support
75+
* Submit issues on [GitHub](https://github.com/RooVetGit/Roo-Code/issues)
76+
* Visit our [Reddit community](https://www.reddit.com/r/RooCode)
56.5 KB
Loading
193 KB
Loading
206 KB
Loading
40.5 KB
Loading

0 commit comments

Comments
 (0)