Skip to content

Commit 3e9cffa

Browse files
committed
docs: unify documentation, improve AI discoverability, add manual IDE integration
- Translate all docs to English (excluding .agent/) - Add ONE-SHOT install command for Linux - Add Option A/B installation (Docker-only vs local Ollama) - Add Manual IDE Integration section with config paths for all IDEs - Expand Advanced Configuration with installation directory, env vars, logs - Improve llms.txt for AI agents (Why RagCode, Compatibility, Example Usage) - Remove .env.example (info moved to README Advanced Configuration) - Add keywords for SEO and AI discoverability
1 parent ae6f648 commit 3e9cffa

File tree

6 files changed

+288
-336
lines changed

6 files changed

+288
-336
lines changed

.env.example

Lines changed: 0 additions & 134 deletions
This file was deleted.

QUICKSTART.md

Lines changed: 43 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,12 @@ RagCode is an MCP (Model Context Protocol) server that allows you to navigate an
2121

2222
**Linux (amd64):**
2323
```bash
24-
curl -L https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz
25-
./ragcode-installer -ollama=docker -qdrant=docker
24+
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
2625
```
2726

28-
**macOS (Apple Silicon):**
29-
```bash
30-
curl -L https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_darwin_arm64.tar.gz | tar xz
31-
./ragcode-installer -ollama=docker -qdrant=docker
32-
```
27+
That's it! One command downloads, extracts, and runs the installer.
3328

34-
**macOS (Intel):**
35-
```bash
36-
curl -L https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_darwin_amd64.tar.gz | tar xz
37-
./ragcode-installer -ollama=docker -qdrant=docker
38-
```
39-
40-
**Windows (PowerShell – in progress):**
41-
```powershell
42-
Invoke-WebRequest -Uri "https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_windows_amd64.zip" -OutFile "rag-code-mcp.zip"
43-
Expand-Archive rag-code-mcp.zip -DestinationPath .
44-
.\ragcode-installer.exe -ollama docker -qdrant docker
45-
```
46-
> ⚠️ Windows support is still being finalized. Use WSL/Linux/macOS if you hit issues.
29+
**macOS & Windows:** Coming soon. For now, use the [Local Build](#option-2-local-build-for-developers) option or run Linux in WSL/Docker.
4730

4831
The installer is end-to-end:
4932
1. ✅ Installs the `rag-code-mcp` and `index-all` binaries into `~/.local/share/ragcode/bin`
@@ -102,9 +85,10 @@ go run ./cmd/install
10285

10386
## 📋 Step-by-Step Setup
10487

105-
### 1. Install Dependencies
88+
### 1. Install Prerequisites
89+
90+
**Docker is required** (for Qdrant, and optionally for Ollama):
10691

107-
#### Docker (for Qdrant)
10892
```bash
10993
# Ubuntu/Debian
11094
sudo apt update && sudo apt install docker.io
@@ -115,21 +99,20 @@ sudo usermod -aG docker $USER # Logout/login after
11599
brew install docker
116100
```
117101

118-
#### Ollama (for AI)
119-
```bash
120-
# Linux
121-
curl -fsSL https://ollama.com/install.sh | sh
102+
### 2. Run the Installer
122103

123-
# macOS
124-
brew install ollama
104+
**Option A: Everything in Docker (recommended, no extra installs needed)**
105+
```bash
106+
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
125107
```
126108

127-
### 2. Run the Installer
128-
109+
**Option B: Use local Ollama (if you already have Ollama installed)**
129110
```bash
130-
# Linux (amd64)
131-
curl -L https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz
132-
./ragcode-installer -ollama=docker -qdrant=docker
111+
# First, install Ollama locally (skip if already installed)
112+
curl -fsSL https://ollama.com/install.sh | sh
113+
114+
# Then run installer with local Ollama
115+
curl -fsSL https://github.com/doITmagic/rag-code-mcp/releases/latest/download/rag-code-mcp_linux_amd64.tar.gz | tar xz && ./ragcode-installer -ollama=local -qdrant=docker
133116
```
134117

135118
**Installation time:** 5-10 minutes (model downloads dominate)
@@ -232,6 +215,32 @@ Each project gets its own collection in Qdrant, and RagCode automatically switch
232215

233216
After installation, RagCode is automatically available in the IDE. **No manual action required!**
234217

218+
### Manual IDE Integration
219+
220+
If you install a new IDE **after** running `ragcode-installer`, you'll need to configure it manually. Below are the configuration file paths for each supported IDE.
221+
222+
#### Configuration File Locations
223+
224+
| IDE | Config File Path |
225+
| --- | --- |
226+
| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` |
227+
| **Cursor** | `~/.cursor/mcp.config.json` |
228+
| **Antigravity** | `~/.gemini/antigravity/mcp_config.json` |
229+
| **Claude Desktop (Linux)** | `~/.config/Claude/mcp-servers.json` |
230+
| **Claude Desktop (macOS)** | `~/Library/Application Support/Claude/mcp-servers.json` |
231+
| **Claude Desktop (Windows)** | `%APPDATA%\Claude\mcp-servers.json` |
232+
| **VS Code + Copilot** | `~/.config/Code/User/globalStorage/mcp-servers.json` |
233+
234+
#### Re-running the Installer
235+
236+
Alternatively, re-run the installer to auto-configure newly installed IDEs:
237+
238+
```bash
239+
~/.local/share/ragcode/bin/ragcode-installer -skip-build -ollama=local -qdrant=docker
240+
```
241+
242+
The `-skip-build` flag skips binary compilation and only updates IDE configurations.
243+
235244
### In VS Code with GitHub Copilot
236245

237246
RagCode integrates with **GitHub Copilot's Agent Mode** in VS Code through the Model Context Protocol (MCP). This allows Copilot to use RagCode's semantic search capabilities as part of its autonomous coding workflow.
@@ -243,7 +252,7 @@ RagCode integrates with **GitHub Copilot's Agent Mode** in VS Code through the M
243252

244253
#### Setup
245254

246-
`ragcode-installer` configurează automat RagCode pentru VS Code și creează:
255+
`ragcode-installer` automatically configures RagCode for VS Code and creates:
247256
```
248257
~/.config/Code/User/globalStorage/mcp-servers.json
249258
```

0 commit comments

Comments
 (0)