helixmind 0.2.14 โ 0.2.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +382 -377
- package/dist/cli/brain/template.d.ts.map +1 -1
- package/dist/cli/brain/template.js +201 -181
- package/dist/cli/brain/template.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,377 +1,382 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
|
|
3
|
-
# ๐ง
|
|
4
|
-
|
|
5
|
-
**AI Coding Assistant with Persistent Spiral Memory**
|
|
6
|
-
|
|
7
|
-
[](https://www.npmjs.com/package/helixmind)
|
|
8
|
-
[](LICENSE)
|
|
9
|
-
[](https://nodejs.org)
|
|
10
|
-
[](https://www.typescriptlang.org/)
|
|
11
|
-
|
|
12
|
-
*Remembers context across sessions. Learns from every interaction. Full SaaS platform with CLI + Web Dashboard.*
|
|
13
|
-
|
|
14
|
-
[Installation](#-installation) โข [Features](#-features) โข [Quick Start](#-quick-start) โข [Web Platform](#-web-platform) โข [Documentation](#-documentation)
|
|
15
|
-
|
|
16
|
-
</div>
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## โจ Features
|
|
21
|
-
|
|
22
|
-
<table>
|
|
23
|
-
<tr>
|
|
24
|
-
<td width="50%">
|
|
25
|
-
|
|
26
|
-
### ๐ Spiral Memory
|
|
27
|
-
**5-level hierarchical memory** that persists across sessions. Context flows between levels based on relevance and recency.
|
|
28
|
-
|
|
29
|
-
</td>
|
|
30
|
-
<td width="50%">
|
|
31
|
-
|
|
32
|
-
### ๐ค Multi-Provider
|
|
33
|
-
**Claude, GPT-4, Ollama** and more. Switch seamlessly between AI providers with rate limiting and model limits.
|
|
34
|
-
|
|
35
|
-
</td>
|
|
36
|
-
</tr>
|
|
37
|
-
<tr>
|
|
38
|
-
<td width="50%">
|
|
39
|
-
|
|
40
|
-
### โก Autonomous Agent
|
|
41
|
-
AI can **edit files, run commands, commit changes, and browse the web** โ with a permission system and sandbox for safety.
|
|
42
|
-
|
|
43
|
-
</td>
|
|
44
|
-
<td width="50%">
|
|
45
|
-
|
|
46
|
-
### ๐ฏ Smart Context
|
|
47
|
-
**Auto-assembles relevant code** from your project. Session buffer, context trimming, and dependency tracking.
|
|
48
|
-
|
|
49
|
-
</td>
|
|
50
|
-
</tr>
|
|
51
|
-
<tr>
|
|
52
|
-
<td width="50%">
|
|
53
|
-
|
|
54
|
-
### ๐ Web Dashboard
|
|
55
|
-
**Next.js 15 platform** with 3D brain visualization, admin panel, billing (Stripe), support tickets, and CLI remote control.
|
|
56
|
-
|
|
57
|
-
</td>
|
|
58
|
-
<td width="50%">
|
|
59
|
-
|
|
60
|
-
### ๐ฌ Validation Matrix
|
|
61
|
-
**Automatic output validation** with static checks, dynamic checks, spiral checks, autofix, and quality classification.
|
|
62
|
-
|
|
63
|
-
</td>
|
|
64
|
-
</tr>
|
|
65
|
-
<tr>
|
|
66
|
-
<td width="50%">
|
|
67
|
-
|
|
68
|
-
### ๐ SWE-Bench Integration
|
|
69
|
-
**Built-in benchmark suite** โ run SWE-bench Lite/Verified, compare runs, measure Spiral Memory impact.
|
|
70
|
-
|
|
71
|
-
</td>
|
|
72
|
-
<td width="50%">
|
|
73
|
-
|
|
74
|
-
### ๐ Web Knowledge
|
|
75
|
-
**Cloud-enriched context** โ topic detection, web search, content extraction, and automatic knowledge integration.
|
|
76
|
-
|
|
77
|
-
</td>
|
|
78
|
-
</tr>
|
|
79
|
-
<tr>
|
|
80
|
-
<td width="50%">
|
|
81
|
-
|
|
82
|
-
### ๐ Bug Tracking
|
|
83
|
-
**Automatic bug detection** and persistent journal โ track bugs across sessions with evidence and status.
|
|
84
|
-
|
|
85
|
-
</td>
|
|
86
|
-
<td width="50%">
|
|
87
|
-
|
|
88
|
-
### ๐พ Checkpoints & Sessions
|
|
89
|
-
**Save and revert** to any checkpoint, multi-session tab view, session lifecycle management.
|
|
90
|
-
|
|
91
|
-
</td>
|
|
92
|
-
</tr>
|
|
93
|
-
<tr>
|
|
94
|
-
<td width="50%">
|
|
95
|
-
|
|
96
|
-
### ๐ Browser Automation
|
|
97
|
-
**Puppeteer-based browser control** โ navigate, click, type, screenshot, visual analysis with Chrome integration.
|
|
98
|
-
|
|
99
|
-
</td>
|
|
100
|
-
<td width="50%">
|
|
101
|
-
|
|
102
|
-
###
|
|
103
|
-
**OAuth login, API keys, feature gating** โ secure access control with subscription tier enforcement.
|
|
104
|
-
|
|
105
|
-
</td>
|
|
106
|
-
</tr>
|
|
107
|
-
<tr>
|
|
108
|
-
<td width="50%">
|
|
109
|
-
|
|
110
|
-
### ๐ก๏ธ Security Monitor
|
|
111
|
-
**Continuous security monitoring** โ threat detection, automated defenses, real-time dashboard with approval queue.
|
|
112
|
-
|
|
113
|
-
</td>
|
|
114
|
-
<td width="50%">
|
|
115
|
-
|
|
116
|
-
### ๐ MCP Integration
|
|
117
|
-
**Model Context Protocol** โ works with Claude Code, Cursor, VS Code, Windsurf, Codex, JetBrains AI.
|
|
118
|
-
|
|
119
|
-
</td>
|
|
120
|
-
</tr>
|
|
121
|
-
</table>
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
##
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
|
182
|
-
|
|
183
|
-
| `helixmind
|
|
184
|
-
| `helixmind
|
|
185
|
-
| `helixmind
|
|
186
|
-
| `helixmind
|
|
187
|
-
| `helixmind
|
|
188
|
-
| `helixmind
|
|
189
|
-
| `helixmind
|
|
190
|
-
| `helixmind
|
|
191
|
-
| `helixmind
|
|
192
|
-
| `helixmind
|
|
193
|
-
| `helixmind
|
|
194
|
-
| `helixmind
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
|
199
|
-
|
|
200
|
-
| `
|
|
201
|
-
| `
|
|
202
|
-
| `
|
|
203
|
-
| `
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
|
298
|
-
|
|
299
|
-
|
|
|
300
|
-
|
|
|
301
|
-
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
|
310
|
-
|
|
311
|
-
|
|
|
312
|
-
|
|
|
313
|
-
|
|
|
314
|
-
|
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
#
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
npm
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
**
|
|
360
|
-
|
|
361
|
-
**
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
1
|
+
๏ปฟ<div align="center">
|
|
2
|
+
|
|
3
|
+
# ๐ง ย HelixMind
|
|
4
|
+
|
|
5
|
+
**AI Coding Assistant with Persistent Spiral Memory**
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/helixmind)
|
|
8
|
+
[](LICENSE)
|
|
9
|
+
[](https://nodejs.org)
|
|
10
|
+
[](https://www.typescriptlang.org/)
|
|
11
|
+
|
|
12
|
+
*Remembers context across sessions. Learns from every interaction. Full SaaS platform with CLI + Web Dashboard.*
|
|
13
|
+
|
|
14
|
+
[Installation](#-installation) โข [Features](#-features) โข [Quick Start](#-quick-start) โข [Web Platform](#-web-platform) โข [Documentation](#-documentation)
|
|
15
|
+
|
|
16
|
+
</div>
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## โจ Features
|
|
21
|
+
|
|
22
|
+
<table>
|
|
23
|
+
<tr>
|
|
24
|
+
<td width="50%">
|
|
25
|
+
|
|
26
|
+
### ๐ Spiral Memory
|
|
27
|
+
**5-level hierarchical memory** that persists across sessions. Context flows between levels based on relevance and recency.
|
|
28
|
+
|
|
29
|
+
</td>
|
|
30
|
+
<td width="50%">
|
|
31
|
+
|
|
32
|
+
### ๐ค Multi-Provider
|
|
33
|
+
**Claude, GPT-4, Ollama** and more. Switch seamlessly between AI providers with rate limiting and model limits.
|
|
34
|
+
|
|
35
|
+
</td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td width="50%">
|
|
39
|
+
|
|
40
|
+
### โก Autonomous Agent
|
|
41
|
+
AI can **edit files, run commands, commit changes, and browse the web** โ with a permission system and sandbox for safety.
|
|
42
|
+
|
|
43
|
+
</td>
|
|
44
|
+
<td width="50%">
|
|
45
|
+
|
|
46
|
+
### ๐ฏ Smart Context
|
|
47
|
+
**Auto-assembles relevant code** from your project. Session buffer, context trimming, and dependency tracking.
|
|
48
|
+
|
|
49
|
+
</td>
|
|
50
|
+
</tr>
|
|
51
|
+
<tr>
|
|
52
|
+
<td width="50%">
|
|
53
|
+
|
|
54
|
+
### ๐ Web Dashboard
|
|
55
|
+
**Next.js 15 platform** with 3D brain visualization, admin panel, billing (Stripe), support tickets, and CLI remote control.
|
|
56
|
+
|
|
57
|
+
</td>
|
|
58
|
+
<td width="50%">
|
|
59
|
+
|
|
60
|
+
### ๐ฌ Validation Matrix
|
|
61
|
+
**Automatic output validation** with static checks, dynamic checks, spiral checks, autofix, and quality classification.
|
|
62
|
+
|
|
63
|
+
</td>
|
|
64
|
+
</tr>
|
|
65
|
+
<tr>
|
|
66
|
+
<td width="50%">
|
|
67
|
+
|
|
68
|
+
### ๐ SWE-Bench Integration
|
|
69
|
+
**Built-in benchmark suite** โ run SWE-bench Lite/Verified, compare runs, measure Spiral Memory impact.
|
|
70
|
+
|
|
71
|
+
</td>
|
|
72
|
+
<td width="50%">
|
|
73
|
+
|
|
74
|
+
### ๐ Web Knowledge
|
|
75
|
+
**Cloud-enriched context** โ topic detection, web search, content extraction, and automatic knowledge integration.
|
|
76
|
+
|
|
77
|
+
</td>
|
|
78
|
+
</tr>
|
|
79
|
+
<tr>
|
|
80
|
+
<td width="50%">
|
|
81
|
+
|
|
82
|
+
### ๐ Bug Tracking
|
|
83
|
+
**Automatic bug detection** and persistent journal โ track bugs across sessions with evidence and status.
|
|
84
|
+
|
|
85
|
+
</td>
|
|
86
|
+
<td width="50%">
|
|
87
|
+
|
|
88
|
+
### ๐พ Checkpoints & Sessions
|
|
89
|
+
**Save and revert** to any checkpoint, multi-session tab view, session lifecycle management.
|
|
90
|
+
|
|
91
|
+
</td>
|
|
92
|
+
</tr>
|
|
93
|
+
<tr>
|
|
94
|
+
<td width="50%">
|
|
95
|
+
|
|
96
|
+
### ๐ Browser Automation
|
|
97
|
+
**Puppeteer-based browser control** โ navigate, click, type, screenshot, visual analysis with Chrome integration.
|
|
98
|
+
|
|
99
|
+
</td>
|
|
100
|
+
<td width="50%">
|
|
101
|
+
|
|
102
|
+
### รฐลธโย Authentication & Security
|
|
103
|
+
**OAuth login, API keys, feature gating** โ secure access control with subscription tier enforcement.
|
|
104
|
+
|
|
105
|
+
</td>
|
|
106
|
+
</tr>
|
|
107
|
+
<tr>
|
|
108
|
+
<td width="50%">
|
|
109
|
+
|
|
110
|
+
### ๐ก๏ธ Security Monitor
|
|
111
|
+
**Continuous security monitoring** โ threat detection, automated defenses, real-time dashboard with approval queue.
|
|
112
|
+
|
|
113
|
+
</td>
|
|
114
|
+
<td width="50%">
|
|
115
|
+
|
|
116
|
+
### ๐ MCP Integration
|
|
117
|
+
**Model Context Protocol** โ works with Claude Code, Cursor, VS Code, Windsurf, Codex, JetBrains AI.
|
|
118
|
+
|
|
119
|
+
</td>
|
|
120
|
+
</tr>
|
|
121
|
+
</table>
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## ๐ง ย Brain Visualization
|
|
126
|
+
|
|
127
|
+
Watch the 3D brain in action:
|
|
128
|
+
|
|
129
|
+
<div align="center">
|
|
130
|
+
<video src="assets/brain_3d_vision.mp4" controls width="800">
|
|
131
|
+
Your browser does not support the video tag.
|
|
132
|
+
</video>
|
|
133
|
+
<p><em>Interactive 3D brain visualization showing memory layers and connections</em></p>
|
|
134
|
+
<p><small><em>Note: The video may not auto-play in GitHub's web view. You can <a href="assets/brain_3d_vision.mp4" download>download it directly</a> or clone the repository to view it.</em></small></p>
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## ๐ Installation
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
# Run directly (no install needed)
|
|
143
|
+
npx helixmind
|
|
144
|
+
|
|
145
|
+
# Or install globally
|
|
146
|
+
npm install -g helixmind
|
|
147
|
+
helixmind
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## ๐ฎ Quick Start
|
|
153
|
+
|
|
154
|
+
```bash
|
|
155
|
+
# Start interactive chat (default command)
|
|
156
|
+
npx helixmind
|
|
157
|
+
|
|
158
|
+
# Initialize in current project
|
|
159
|
+
npx helixmind init
|
|
160
|
+
|
|
161
|
+
# Send a single message
|
|
162
|
+
npx helixmind chat -m "fix all lint errors in src/"
|
|
163
|
+
|
|
164
|
+
# YOLO mode โ auto-approve everything
|
|
165
|
+
npx helixmind chat --yolo
|
|
166
|
+
|
|
167
|
+
# Skip permission prompts
|
|
168
|
+
npx helixmind chat -s
|
|
169
|
+
|
|
170
|
+
# Feed files into spiral memory
|
|
171
|
+
npx helixmind feed src/ --deep
|
|
172
|
+
|
|
173
|
+
# Watch files and update spiral live
|
|
174
|
+
npx helixmind feed src/ --watch
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## ๐ CLI Commands
|
|
180
|
+
|
|
181
|
+
| Command | Description |
|
|
182
|
+
|:--------|:------------|
|
|
183
|
+
| `helixmind` / `helixmind chat` | ๐ฏ Start interactive chat (default) |
|
|
184
|
+
| `helixmind helix` | ๐ฏ Alias for interactive chat |
|
|
185
|
+
| `helixmind init` | โ๏ธ Initialize HelixMind in project |
|
|
186
|
+
| `helixmind chat -m "..."` | ๐ฌ Send a single message |
|
|
187
|
+
| `helixmind chat --yolo` | ๐ Auto-approve all operations |
|
|
188
|
+
| `helixmind chat --no-validation` | ๐ Disable output validation |
|
|
189
|
+
| `helixmind chat --validation-verbose` | ๐ Detailed validation output |
|
|
190
|
+
| `helixmind chat --validation-strict` | ๐ซ Treat validation warnings as errors |
|
|
191
|
+
| `helixmind feed [paths...]` | ๐ Feed files/dirs into spiral |
|
|
192
|
+
| `helixmind feed --deep` | ๐ Deep analysis with intent detection |
|
|
193
|
+
| `helixmind feed --watch` | ๐๏ธ Watch and auto-update spiral |
|
|
194
|
+
| `helixmind spiral status` | ๐ Show spiral metrics |
|
|
195
|
+
| `helixmind spiral search <query>` | ๐ Search spiral context |
|
|
196
|
+
| `helixmind spiral compact` | ๐๏ธ Trigger spiral compaction |
|
|
197
|
+
| `helixmind config set <k> <v>` | โ๏ธ Set config value |
|
|
198
|
+
| `helixmind config get <key>` | ๐ Get config value |
|
|
199
|
+
| `helixmind config list` | ๐ Show all config |
|
|
200
|
+
| `helixmind export [dir]` | รฐลธโยฆ Export spiral to .helixmind.zip |
|
|
201
|
+
| `helixmind import <zip>` | ๐ฅ Import spiral from archive |
|
|
202
|
+
| `helixmind login` | ๐ Authenticate with web platform |
|
|
203
|
+
| `helixmind logout` | ๐ช Remove stored auth |
|
|
204
|
+
| `helixmind whoami` | ๐ค Show auth status |
|
|
205
|
+
| `helixmind bench run` | ๐๏ธ Run SWE-bench benchmark |
|
|
206
|
+
| `helixmind bench results` | ๐ Show benchmark results |
|
|
207
|
+
| `helixmind bench compare` | โ๏ธ Compare benchmark runs |
|
|
208
|
+
| `helixmind bench list` | ๐ List past runs |
|
|
209
|
+
|
|
210
|
+
### โจ๏ธ Keyboard Shortcuts
|
|
211
|
+
|
|
212
|
+
| Key | Action |
|
|
213
|
+
|:----|:-------|
|
|
214
|
+
| `Ctrl+C` | ๐ Exit |
|
|
215
|
+
| `Ctrl+L` | ๐ง ยน Clear screen |
|
|
216
|
+
| `Ctrl+D` | ๐ Toggle debug mode |
|
|
217
|
+
| `Tab` | โจ Autocomplete command |
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
## ๐ง ย Memory Architecture
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
|
|
225
|
+
โ Level 1 โ ๐ Focus โ
|
|
226
|
+
โ Most relevant, recent context โ
|
|
227
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
|
|
228
|
+
โ Level 2 โ โก Active โ
|
|
229
|
+
โ Related files, dependencies โ
|
|
230
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
|
|
231
|
+
โ Level 3 โ รฐลธโลก Reference โ
|
|
232
|
+
โ Decisions, patterns, code structure โ
|
|
233
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
|
|
234
|
+
โ Level 4 โ รฐลธโยฆ Archive โ
|
|
235
|
+
โ Compressed summaries, old sessions โ
|
|
236
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
|
|
237
|
+
โ Level 5 โ รฐลธโโรฏยธย Deep Archive โ
|
|
238
|
+
โ Long-term knowledge, project history โ
|
|
239
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Context automatically flows between levels based on relevance and recency. Cloud enrichment adds web knowledge via topic detection and content extraction.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## ๐ Web Platform
|
|
247
|
+
|
|
248
|
+
The web dashboard (available at [helix-mind.ai](https://helix-mind.ai)) is a separate **Next.js 15** application:
|
|
249
|
+
|
|
250
|
+
| Feature | Description |
|
|
251
|
+
|:--------|:------------|
|
|
252
|
+
| **3D Brain View** | Interactive Three.js visualization of your spiral memory |
|
|
253
|
+
| **Dashboard** | Manage API keys, billing, profile, and CLI connections |
|
|
254
|
+
| **Admin Panel** | User management, ticket system, plans, settings, stats |
|
|
255
|
+
| **CLI Integration** | WebSocket bridge โ control your CLI from the browser |
|
|
256
|
+
| **Support System** | Built-in ticket system with detail views |
|
|
257
|
+
| **Blog & Docs** | MDX-based with i18n (DE/EN), sidebar navigation |
|
|
258
|
+
| **Auth** | NextAuth with OAuth, staff login, CLI authorization |
|
|
259
|
+
| **Billing** | Stripe checkout, portal, webhooks |
|
|
260
|
+
| **PWA** | Service worker, install prompt, offline support |
|
|
261
|
+
| **Cookie Consent** | GDPR-compliant cookie banner and settings |
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
## โ๏ธ Configuration
|
|
267
|
+
|
|
268
|
+
Create `.helixmind/config.json` in your project:
|
|
269
|
+
|
|
270
|
+
```json
|
|
271
|
+
{
|
|
272
|
+
"provider": "anthropic",
|
|
273
|
+
"model": "claude-sonnet-4-20250514",
|
|
274
|
+
"brainEnabled": true,
|
|
275
|
+
"permissions": {
|
|
276
|
+
"writeFiles": true,
|
|
277
|
+
"runCommands": true,
|
|
278
|
+
"gitCommit": true
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### ๐ Environment Variables
|
|
284
|
+
|
|
285
|
+
```bash
|
|
286
|
+
ANTHROPIC_API_KEY=sk-ant-... # For Claude
|
|
287
|
+
OPENAI_API_KEY=sk-... # For OpenAI/GPT
|
|
288
|
+
# Ollama: no key needed (local)
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## รฐลธโบย รฏยธย Tech Stack
|
|
294
|
+
|
|
295
|
+
### CLI
|
|
296
|
+
|
|
297
|
+
| Category | Technology |
|
|
298
|
+
|:---------|:-----------|
|
|
299
|
+
| Language |  |
|
|
300
|
+
| AI SDKs |    |
|
|
301
|
+
| Database |   |
|
|
302
|
+
| Embeddings |  |
|
|
303
|
+
| Browser |  |
|
|
304
|
+
| Testing |  |
|
|
305
|
+
| MCP |  |
|
|
306
|
+
|
|
307
|
+
### Web
|
|
308
|
+
|
|
309
|
+
| Category | Technology |
|
|
310
|
+
|:---------|:-----------|
|
|
311
|
+
| Framework |   |
|
|
312
|
+
| 3D |  |
|
|
313
|
+
| Database |  |
|
|
314
|
+
| Auth |  |
|
|
315
|
+
| Payments |  |
|
|
316
|
+
| Styling |  |
|
|
317
|
+
| i18n |  |
|
|
318
|
+
| PWA |  |
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## รฐลธยโรฏยธย Development
|
|
323
|
+
|
|
324
|
+
```bash
|
|
325
|
+
# Clone repo
|
|
326
|
+
git clone https://github.com/DancingTedDanson011/HelixMind.git
|
|
327
|
+
cd HelixMind
|
|
328
|
+
|
|
329
|
+
# Install dependencies (CLI)
|
|
330
|
+
npm install
|
|
331
|
+
|
|
332
|
+
# Build CLI
|
|
333
|
+
npm run build
|
|
334
|
+
|
|
335
|
+
# Run CLI in dev mode
|
|
336
|
+
npm run dev
|
|
337
|
+
|
|
338
|
+
# Run tests
|
|
339
|
+
npm test
|
|
340
|
+
|
|
341
|
+
# Run tests with coverage
|
|
342
|
+
npm run test:coverage
|
|
343
|
+
|
|
344
|
+
# Web dashboard
|
|
345
|
+
cd web
|
|
346
|
+
npm install
|
|
347
|
+
npm run dev
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## รฐลธโลก Documentation
|
|
353
|
+
|
|
354
|
+
Complete documentation is available in the web dashboard and includes:
|
|
355
|
+
|
|
356
|
+
| Category | Topics |
|
|
357
|
+
|:---------|:-------|
|
|
358
|
+
| **Core Concepts** | Spiral Memory, Validation Matrix, Web Knowledge, Bug Tracking, Browser Automation |
|
|
359
|
+
| **Usage Guides** | Getting Started, Configuration, Authentication, Project Setup |
|
|
360
|
+
| **Advanced** | Autonomous Modes, Agent Tools, MCP Integration, SWE-Bench |
|
|
361
|
+
| **Reference** | CLI Commands, Slash Commands, Permission System, Export/Import |
|
|
362
|
+
|
|
363
|
+
**Web Dashboard Docs**: Start the web dashboard (`cd web && npm run dev`) and navigate to `/docs`.
|
|
364
|
+
|
|
365
|
+
**CLI Help**: Use `helixmind --help` or `helixmind chat --help` for command reference.
|
|
366
|
+
|
|
367
|
+
---
|
|
368
|
+
|
|
369
|
+
## รฐลธโโ License
|
|
370
|
+
|
|
371
|
+
[AGPL-3.0](LICENSE) โ Free for open-source use. Commercial licenses available.
|
|
372
|
+
|
|
373
|
+
---
|
|
374
|
+
|
|
375
|
+
<div align="center">
|
|
376
|
+
|
|
377
|
+
**Made with โค๏ธ by [HelixMind](https://github.com/DancingTedDanson011)**
|
|
378
|
+
|
|
379
|
+
[โฌ Back to Top](#-helixmind)
|
|
380
|
+
|
|
381
|
+
</div>
|
|
382
|
+
|