22
33> Transform your IDE into a cognitive memory system that remembers your coding context across sessions.
44
5+ ## ✨ Zero-Config AI Integration
6+
7+ ** Install once. Use everywhere.**
8+
9+ OpenMemory automatically links with:
10+
11+ - 🚀 ** GitHub Copilot** - Context provider auto-configured
12+ - 🎯 ** Cursor** - Context provider auto-configured
13+ - 🤖 ** Claude Code** - MCP integration enabled
14+ - 🌊 ** Windsurf** - Context API connected
15+ - � ** Codex** - Context provider enabled
16+ - 🧠 ** Any MCP-compatible AI** - Universal memory access
17+
18+ ** No manual setup required!** Extension detects backend and auto-generates all config files.
19+
20+ ## Quick Start
21+
22+ ** 3 Steps to Get Started:**
23+
24+ 1 . ** Start Backend** : ` cd backend && npm start ` (runs on port 8080)
25+ 2 . ** Open IDE Folder** : Open ` IDE/ ` folder in VS Code
26+ 3 . ** Press F5** : Launches extension in development mode
27+
28+ ** That's it!** OpenMemory is now tracking your coding activity.
29+
530## Features
631
732- ** Automatic Context Capture** : Tracks file opens, edits, and saves
1237
1338## Installation
1439
15- ### Prerequisites
40+ ### Method 1: Quick Install (For Users)
1641
17- 1 . OpenMemory backend running (default: ` http://localhost:3000 ` )
18- 2 . VS Code 1.85.0 or higher
42+ 1 . ** Start OpenMemory Backend** (if not running):
1943
20- ### Setup
44+ ``` powershell
45+ cd backend
46+ npm install
47+ npm start
48+ ```
2149
22- 1 . Install dependencies:
50+ Backend runs on ` http://localhost:8080 ` by default
2351
24- ``` bash
25- cd IDE/vscode
26- npm install
27- ```
52+ 2 . ** Install the VS Code Extension** :
2853
29- 2 . Compile the extension:
54+ - Open VS Code
55+ - Go to Extensions view (Ctrl+Shift+X)
56+ - Click the ` ... ` menu → "Install from VSIX..."
57+ - Navigate to ` IDE/ ` folder and select the ` .vsix ` file (if available)
3058
31- ``` bash
32- npm run compile
33- ```
59+ ** OR** for development:
60+
61+ - Open the ` IDE/ ` folder in VS Code
62+ - Press F5 to launch Extension Development Host
63+ - A new VS Code window opens with OpenMemory active
64+
65+ 3 . ** Configure Backend URL** (if different from default):
66+ - Open VS Code Settings (Ctrl+,)
67+ - Search for "OpenMemory"
68+ - Set ` openmemory.backendUrl ` to your backend URL (default: ` http://localhost:8080 ` )
69+
70+ ### Method 2: Build from Source (For Developers)
71+
72+ 1 . ** Install Dependencies** :
73+
74+ ``` powershell
75+ cd IDE
76+ npm install
77+ ```
78+
79+ 2 . ** Compile the Extension** :
3480
35- 3 . Press F5 in VS Code to launch Extension Development Host
81+ ``` powershell
82+ npm run compile
83+ ```
84+
85+ 3 . ** Run in Development Mode** :
86+ - Press F5 in VS Code to launch Extension Development Host
87+ - Or package as VSIX: ` npx vsce package `
88+
89+ ### Prerequisites
90+
91+ - ✅ VS Code 1.85.0 or higher
92+ - ✅ Node.js 18+ installed
93+ - ✅ OpenMemory backend running (port 8080 by default)
3694
3795## Configuration
3896
3997Configure OpenMemory through VS Code settings:
4098
41- - ** ` openmemory.backendUrl ` ** : URL of your OpenMemory backend (default: ` http://localhost:3000 ` )
99+ - ** ` openmemory.backendUrl ` ** : URL of your OpenMemory backend (default: ` http://localhost:8080 ` )
42100
43101## Usage
44102
@@ -79,7 +137,7 @@ Results appear in the Output panel with salience scores.
79137┌────────▼────────┐
80138│ OpenMemory │
81139│ Backend │
82- │ (port 3000 ) │
140+ │ (port 8080 ) │
83141└─────────────────┘
84142```
85143
@@ -175,8 +233,8 @@ npm run watch
175233
176234Check backend is running:
177235
178- ``` bash
179- curl http://localhost:3000 /api/system/health
236+ ``` powershell
237+ curl http://localhost:8080 /api/system/health
180238```
181239
182240### Events not appearing
@@ -189,10 +247,8 @@ curl http://localhost:3000/api/system/health
189247
190248Ensure backend ` /api/ide/session/start ` endpoint is available:
191249
192- ``` bash
193- curl -X POST http://localhost:3000/api/ide/session/start \
194- -H " Content-Type: application/json" \
195- -d ' {"user_identifier_for_session":"test","project_name_or_workspace":"test","ide_name_and_version":"test"}'
250+ ``` powershell
251+ curl -X POST http://localhost:8080/api/ide/session/start -H "Content-Type: application/json" -d '{\"user_identifier_for_session\":\"test\",\"project_name_or_workspace\":\"test\",\"ide_name_and_version\":\"test\"}'
196252```
197253
198254## License
0 commit comments