Skip to content

Commit d67fcd6

Browse files
committed
docs: add Windows WSL installation instructions for all documentation
1 parent 31a90cf commit d67fcd6

File tree

5 files changed

+143
-0
lines changed

5 files changed

+143
-0
lines changed

QUICKSTART.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,35 @@ Expand-Archive ragcode.zip -DestinationPath . -Force
3030
.\ragcode-installer.exe -ollama=docker -qdrant=docker
3131
```
3232

33+
### Windows with WSL (alternative)
34+
35+
If you run Docker via WSL and have IDEs on Windows:
36+
37+
```bash
38+
# Inside WSL terminal
39+
curl -fsSL https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz && ./ragcode-installer -ollama=docker -qdrant=docker
40+
```
41+
42+
Then configure your Windows IDE manually (e.g., Windsurf at `%USERPROFILE%\.codeium\windsurf\mcp_config.json`):
43+
44+
```json
45+
{
46+
"mcpServers": {
47+
"ragcode": {
48+
"command": "wsl.exe",
49+
"args": ["-e", "/home/YOUR_USERNAME/.local/share/ragcode/bin/rag-code-mcp"],
50+
"env": {
51+
"OLLAMA_BASE_URL": "http://localhost:11434",
52+
"OLLAMA_MODEL": "phi3:medium",
53+
"OLLAMA_EMBED": "nomic-embed-text",
54+
"QDRANT_URL": "http://localhost:6333"
55+
},
56+
"disabled": false
57+
}
58+
}
59+
}
60+
```
61+
3362
> **Prerequisite:** Docker must be installed and running.
3463
3564
---

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,37 @@ Expand-Archive ragcode.zip -DestinationPath . -Force
203203
```
204204
> ⚠️ Windows requires [Docker Desktop](https://www.docker.com/products/docker-desktop/) to be installed and running.
205205
206+
**Windows with WSL (alternative):**
207+
208+
If you prefer to run RagCode inside WSL while using Windows IDEs (Windsurf, Cursor, VS Code):
209+
210+
```bash
211+
# Inside WSL terminal
212+
curl -fsSL https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz && ./ragcode-installer -ollama=docker -qdrant=docker
213+
```
214+
215+
Then manually configure your Windows IDE to use the WSL binary. Example for Windsurf (`%USERPROFILE%\.codeium\windsurf\mcp_config.json`):
216+
217+
```json
218+
{
219+
"mcpServers": {
220+
"ragcode": {
221+
"command": "wsl.exe",
222+
"args": ["-e", "/home/YOUR_USERNAME/.local/share/ragcode/bin/rag-code-mcp"],
223+
"env": {
224+
"OLLAMA_BASE_URL": "http://localhost:11434",
225+
"OLLAMA_MODEL": "phi3:medium",
226+
"OLLAMA_EMBED": "nomic-embed-text",
227+
"QDRANT_URL": "http://localhost:6333"
228+
},
229+
"disabled": false
230+
}
231+
}
232+
}
233+
```
234+
235+
> 💡 Replace `YOUR_USERNAME` with your WSL username. The `localhost` URLs work because WSL2 shares network ports with Windows.
236+
206237
### What the installer does:
207238
1. ✅ Downloads and installs the `rag-code-mcp` binary
208239
2. ✅ Sets up Ollama and Qdrant (Docker or local, your choice)

docs/vscode-copilot-integration.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,54 @@ If you need to configure manually or customize the setup:
9191

9292
4. **Restart VS Code** to load the new configuration.
9393

94+
### Windows Setup
95+
96+
On Windows, the MCP configuration file is located at:
97+
```
98+
%APPDATA%\Code\User\mcp.json
99+
```
100+
101+
Example configuration:
102+
```json
103+
{
104+
"servers": {
105+
"ragcode": {
106+
"command": "C:\\Users\\YOUR_USERNAME\\.local\\share\\ragcode\\bin\\rag-code-mcp.exe",
107+
"args": [],
108+
"env": {
109+
"OLLAMA_BASE_URL": "http://localhost:11434",
110+
"OLLAMA_MODEL": "phi3:medium",
111+
"OLLAMA_EMBED": "nomic-embed-text",
112+
"QDRANT_URL": "http://localhost:6333"
113+
}
114+
}
115+
}
116+
}
117+
```
118+
119+
### Windows with WSL Setup
120+
121+
If you installed RagCode in WSL but use VS Code on Windows:
122+
123+
```json
124+
{
125+
"servers": {
126+
"ragcode": {
127+
"command": "wsl.exe",
128+
"args": ["-e", "/home/YOUR_USERNAME/.local/share/ragcode/bin/rag-code-mcp"],
129+
"env": {
130+
"OLLAMA_BASE_URL": "http://localhost:11434",
131+
"OLLAMA_MODEL": "phi3:medium",
132+
"OLLAMA_EMBED": "nomic-embed-text",
133+
"QDRANT_URL": "http://localhost:6333"
134+
}
135+
}
136+
}
137+
}
138+
```
139+
140+
> 💡 The `localhost` URLs work because WSL2 shares network ports with Windows.
141+
94142
---
95143

96144
## Verification

llms-full.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,37 @@ Expand-Archive ragcode.zip -DestinationPath . -Force
194194
```
195195
> ⚠️ Windows requires [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running.
196196

197+
**Windows with WSL (alternative):**
198+
199+
If you run Docker via WSL and have IDEs on Windows, install the Linux version inside WSL:
200+
201+
```bash
202+
# Inside WSL terminal
203+
curl -fsSL https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz && ./ragcode-installer -ollama=docker -qdrant=docker
204+
```
205+
206+
Then manually configure your Windows IDE (e.g., Windsurf at `%USERPROFILE%\.codeium\windsurf\mcp_config.json`):
207+
208+
```json
209+
{
210+
"mcpServers": {
211+
"ragcode": {
212+
"command": "wsl.exe",
213+
"args": ["-e", "/home/YOUR_USERNAME/.local/share/ragcode/bin/rag-code-mcp"],
214+
"env": {
215+
"OLLAMA_BASE_URL": "http://localhost:11434",
216+
"OLLAMA_MODEL": "phi3:medium",
217+
"OLLAMA_EMBED": "nomic-embed-text",
218+
"QDRANT_URL": "http://localhost:6333"
219+
},
220+
"disabled": false
221+
}
222+
}
223+
}
224+
```
225+
226+
> 💡 Replace `YOUR_USERNAME` with your WSL username. The `localhost` URLs work because WSL2 shares network ports with Windows.
227+
197228
The installer is end-to-end:
198229
1. ✅ Installs the `rag-code-mcp` and `index-all` binaries into `~/.local/share/ragcode/bin`
199230
2. ✅ Configures Windsurf, Cursor, Claude, VS Code, etc.
@@ -563,6 +594,8 @@ Expand-Archive ragcode.zip -DestinationPath . -Force
563594
```
564595
> ⚠️ Windows requires [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running.
565596

597+
**Windows with WSL:** Install Linux version in WSL, then configure Windows IDEs to use `wsl.exe` as command with args `["-e", "/home/USER/.local/share/ragcode/bin/rag-code-mcp"]`. See README for full config example.
598+
566599
The installer will:
567600
1. ✅ Download and install the `rag-code-mcp` and `index-all` binaries into `~/.local/share/ragcode/bin`
568601
2. ✅ Add the binaries to your PATH

llms.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ curl -fsSL https://github.com/doITmagic/rag-code-mcp/releases/latest/download/ra
3939
Invoke-WebRequest -Uri "https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_windows_amd64.zip" -OutFile "ragcode.zip"; Expand-Archive ragcode.zip -DestinationPath . -Force; .\ragcode-installer.exe -ollama=docker -qdrant=docker
4040
```
4141

42+
**Windows with WSL:** Install Linux version in WSL, then configure Windows IDEs to use `wsl.exe` as command with args `["-e", "/home/USER/.local/share/ragcode/bin/rag-code-mcp"]`.
43+
4244
Key flags: `-ollama` (docker/local), `-qdrant` (docker/remote), `-gpu`, `-models-dir`, `-skip-build`
4345

4446
## Example Usage

0 commit comments

Comments
 (0)