helixmind 0.2.17 → 0.2.19

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 CHANGED
@@ -1,6 +1,6 @@
1
- <div align="center">
1
+ <div align="center">
2
2
 
3
- # 🧠  HelixMind
3
+ # HelixMind
4
4
 
5
5
  **AI Coding Assistant with Persistent Spiral Memory**
6
6
 
@@ -11,25 +11,25 @@
11
11
 
12
12
  *Remembers context across sessions. Learns from every interaction. Full SaaS platform with CLI + Web Dashboard.*
13
13
 
14
- [Installation](#-installation) [Features](#-features) [Quick Start](#-quick-start) [Web Platform](#-web-platform) [Documentation](#-documentation)
14
+ [Installation](#installation) &bull; [Features](#features) &bull; [Quick Start](#quick-start) &bull; [Web Platform](#web-platform) &bull; [Documentation](#documentation)
15
15
 
16
16
  </div>
17
17
 
18
18
  ---
19
19
 
20
- ## Features
20
+ ## Features
21
21
 
22
22
  <table>
23
23
  <tr>
24
24
  <td width="50%">
25
25
 
26
- ### 🔄 Spiral Memory
26
+ ### Spiral Memory
27
27
  **5-level hierarchical memory** that persists across sessions. Context flows between levels based on relevance and recency.
28
28
 
29
29
  </td>
30
30
  <td width="50%">
31
31
 
32
- ### 🤖 Multi-Provider
32
+ ### Multi-Provider
33
33
  **Claude, GPT-4, Ollama** and more. Switch seamlessly between AI providers with rate limiting and model limits.
34
34
 
35
35
  </td>
@@ -37,13 +37,13 @@
37
37
  <tr>
38
38
  <td width="50%">
39
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.
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
42
 
43
43
  </td>
44
44
  <td width="50%">
45
45
 
46
- ### 🎯 Smart Context
46
+ ### Smart Context
47
47
  **Auto-assembles relevant code** from your project. Session buffer, context trimming, and dependency tracking.
48
48
 
49
49
  </td>
@@ -51,13 +51,13 @@ AI can **edit files, run commands, commit changes, and browse the web** — with
51
51
  <tr>
52
52
  <td width="50%">
53
53
 
54
- ### 🌐 Web Dashboard
54
+ ### Web Dashboard
55
55
  **Next.js 15 platform** with 3D brain visualization, admin panel, billing (Stripe), support tickets, and CLI remote control.
56
56
 
57
57
  </td>
58
58
  <td width="50%">
59
59
 
60
- ### 🔬 Validation Matrix
60
+ ### Validation Matrix
61
61
  **Automatic output validation** with static checks, dynamic checks, spiral checks, autofix, and quality classification.
62
62
 
63
63
  </td>
@@ -65,27 +65,27 @@ AI can **edit files, run commands, commit changes, and browse the web** — with
65
65
  <tr>
66
66
  <td width="50%">
67
67
 
68
- ### 📊 SWE-Bench Integration
69
- **Built-in benchmark suite** run SWE-bench Lite/Verified, compare runs, measure Spiral Memory impact.
68
+ ### SWE-Bench Integration
69
+ **Built-in benchmark suite** &mdash; run SWE-bench Lite/Verified, compare runs, measure Spiral Memory impact.
70
70
 
71
71
  </td>
72
72
  <td width="50%">
73
73
 
74
- ### 🌍 Web Knowledge
75
- **Cloud-enriched context** topic detection, web search, content extraction, and automatic knowledge integration.
74
+ ### Web Knowledge
75
+ **Cloud-enriched context** &mdash; topic detection, web search, content extraction, and automatic knowledge integration.
76
76
 
77
77
  </td>
78
78
  </tr>
79
79
  <tr>
80
80
  <td width="50%">
81
81
 
82
- ### 🐛 Bug Tracking
83
- **Automatic bug detection** and persistent journal track bugs across sessions with evidence and status.
82
+ ### Bug Tracking
83
+ **Automatic bug detection** and persistent journal &mdash; track bugs across sessions with evidence and status.
84
84
 
85
85
  </td>
86
86
  <td width="50%">
87
87
 
88
- ### 💾 Checkpoints & Sessions
88
+ ### Checkpoints & Sessions
89
89
  **Save and revert** to any checkpoint, multi-session tab view, session lifecycle management.
90
90
 
91
91
  </td>
@@ -93,28 +93,28 @@ AI can **edit files, run commands, commit changes, and browse the web** — with
93
93
  <tr>
94
94
  <td width="50%">
95
95
 
96
- ### 🌐 Browser Automation
97
- **Puppeteer-based browser control** navigate, click, type, screenshot, visual analysis with Chrome integration.
96
+ ### Browser Automation
97
+ **Puppeteer-based browser control** &mdash; navigate, click, type, screenshot, visual analysis with Chrome integration.
98
98
 
99
99
  </td>
100
100
  <td width="50%">
101
101
 
102
- ### 🔐 Authentication & Security
103
- **OAuth login, API keys, feature gating** secure access control with subscription tier enforcement.
102
+ ### Authentication & Security
103
+ **OAuth login, API keys, feature gating** &mdash; secure access control with subscription tier enforcement.
104
104
 
105
105
  </td>
106
106
  </tr>
107
107
  <tr>
108
108
  <td width="50%">
109
109
 
110
- ### 🛡️ Security Monitor
111
- **Continuous security monitoring** threat detection, automated defenses, real-time dashboard with approval queue.
110
+ ### Security Monitor
111
+ **Continuous security monitoring** &mdash; threat detection, automated defenses, real-time dashboard with approval queue.
112
112
 
113
113
  </td>
114
114
  <td width="50%">
115
115
 
116
- ### 📈 MCP Integration
117
- **Model Context Protocol** works with Claude Code, Cursor, VS Code, Windsurf, Codex, JetBrains AI.
116
+ ### MCP Integration
117
+ **Model Context Protocol** &mdash; works with Claude Code, Cursor, VS Code, Windsurf, Codex, JetBrains AI.
118
118
 
119
119
  </td>
120
120
  </tr>
@@ -122,21 +122,23 @@ AI can **edit files, run commands, commit changes, and browse the web** — with
122
122
 
123
123
  ---
124
124
 
125
- ## 🧠  Brain Visualization
126
-
127
- Watch the 3D brain in action:
125
+ ## Brain Visualization
128
126
 
129
127
  <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>
128
+
129
+ https://github.com/user-attachments/assets/brain_3d_vision.mp4
130
+
131
+ [![Watch the 3D Brain in action](https://img.shields.io/badge/Watch-3D_Brain_Demo-blue?style=for-the-badge&logo=youtube)](assets/brain_3d_vision.mp4)
132
+
133
+ *Interactive 3D brain visualization showing memory layers and connections*
134
+
135
135
  </div>
136
136
 
137
+ > **Note:** If the video above does not play, [download it directly](assets/brain_3d_vision.mp4) or clone the repository to view it locally.
138
+
137
139
  ---
138
140
 
139
- ## 🚀 Installation
141
+ ## Installation
140
142
 
141
143
  ```bash
142
144
  # Run directly (no install needed)
@@ -149,7 +151,7 @@ helixmind
149
151
 
150
152
  ---
151
153
 
152
- ## 🎮 Quick Start
154
+ ## Quick Start
153
155
 
154
156
  ```bash
155
157
  # Start interactive chat (default command)
@@ -161,7 +163,7 @@ npx helixmind init
161
163
  # Send a single message
162
164
  npx helixmind chat -m "fix all lint errors in src/"
163
165
 
164
- # YOLO mode auto-approve everything
166
+ # YOLO mode - auto-approve everything
165
167
  npx helixmind chat --yolo
166
168
 
167
169
  # Skip permission prompts
@@ -176,74 +178,76 @@ npx helixmind feed src/ --watch
176
178
 
177
179
  ---
178
180
 
179
- ## 📋 CLI Commands
181
+ ## CLI Commands
180
182
 
181
183
  | Command | Description |
182
184
  |:--------|:------------|
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
185
+ | `helixmind` / `helixmind chat` | Start interactive chat (default) |
186
+ | `helixmind helix` | Alias for interactive chat |
187
+ | `helixmind init` | Initialize HelixMind in project |
188
+ | `helixmind chat -m "..."` | Send a single message |
189
+ | `helixmind chat --yolo` | Auto-approve all operations |
190
+ | `helixmind chat --no-validation` | Disable output validation |
191
+ | `helixmind chat --validation-verbose` | Detailed validation output |
192
+ | `helixmind chat --validation-strict` | Treat validation warnings as errors |
193
+ | `helixmind feed [paths...]` | Feed files/dirs into spiral |
194
+ | `helixmind feed --deep` | Deep analysis with intent detection |
195
+ | `helixmind feed --watch` | Watch and auto-update spiral |
196
+ | `helixmind spiral status` | Show spiral metrics |
197
+ | `helixmind spiral search <query>` | Search spiral context |
198
+ | `helixmind spiral compact` | Trigger spiral compaction |
199
+ | `helixmind config set <k> <v>` | Set config value |
200
+ | `helixmind config get <key>` | Get config value |
201
+ | `helixmind config list` | Show all config |
202
+ | `helixmind export [dir]` | Export spiral to .helixmind.zip |
203
+ | `helixmind import <zip>` | Import spiral from archive |
204
+ | `helixmind login` | Authenticate with web platform |
205
+ | `helixmind logout` | Remove stored auth |
206
+ | `helixmind whoami` | Show auth status |
207
+ | `helixmind bench run` | Run SWE-bench benchmark |
208
+ | `helixmind bench results` | Show benchmark results |
209
+ | `helixmind bench compare` | Compare benchmark runs |
210
+ | `helixmind bench list` | List past runs |
211
+
212
+ ### Keyboard Shortcuts
211
213
 
212
214
  | Key | Action |
213
215
  |:----|:-------|
214
- | `Ctrl+C` | 🛑 Exit |
215
- | `Ctrl+L` | 🧠¹ Clear screen |
216
- | `Ctrl+D` | 🐛 Toggle debug mode |
217
- | `Tab` | Autocomplete command |
216
+ | `ESC ESC` | Emergency stop (abort all sessions) |
217
+ | `Ctrl+C` | Exit |
218
+ | `Ctrl+L` | Clear screen |
219
+ | `Ctrl+D` | Toggle debug mode |
220
+ | `Ctrl+PageUp/Down` | Switch session tabs |
221
+ | `Tab` | Autocomplete command |
218
222
 
219
223
  ---
220
224
 
221
- ## 🧠  Memory Architecture
225
+ ## Memory Architecture
222
226
 
223
227
  ```
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
- └─────────────────────────────────────────────────────┘
228
+ +-----------------------------------------------------+
229
+ | Level 1 - Focus |
230
+ | Most relevant, recent context |
231
+ +-----------------------------------------------------+
232
+ | Level 2 - Active |
233
+ | Related files, dependencies |
234
+ +-----------------------------------------------------+
235
+ | Level 3 - Reference |
236
+ | Decisions, patterns, code structure |
237
+ +-----------------------------------------------------+
238
+ | Level 4 - Archive |
239
+ | Compressed summaries, old sessions |
240
+ +-----------------------------------------------------+
241
+ | Level 5 - Deep Archive |
242
+ | Long-term knowledge, project history |
243
+ +-----------------------------------------------------+
240
244
  ```
241
245
 
242
246
  Context automatically flows between levels based on relevance and recency. Cloud enrichment adds web knowledge via topic detection and content extraction.
243
247
 
244
248
  ---
245
249
 
246
- ## 🌐 Web Platform
250
+ ## Web Platform
247
251
 
248
252
  The web dashboard (available at [helix-mind.ai](https://helix-mind.ai)) is a separate **Next.js 15** application:
249
253
 
@@ -252,7 +256,7 @@ The web dashboard (available at [helix-mind.ai](https://helix-mind.ai)) is a sep
252
256
  | **3D Brain View** | Interactive Three.js visualization of your spiral memory |
253
257
  | **Dashboard** | Manage API keys, billing, profile, and CLI connections |
254
258
  | **Admin Panel** | User management, ticket system, plans, settings, stats |
255
- | **CLI Integration** | WebSocket bridge control your CLI from the browser |
259
+ | **CLI Integration** | WebSocket bridge &mdash; control your CLI from the browser |
256
260
  | **Support System** | Built-in ticket system with detail views |
257
261
  | **Blog & Docs** | MDX-based with i18n (DE/EN), sidebar navigation |
258
262
  | **Auth** | NextAuth with OAuth, staff login, CLI authorization |
@@ -260,10 +264,9 @@ The web dashboard (available at [helix-mind.ai](https://helix-mind.ai)) is a sep
260
264
  | **PWA** | Service worker, install prompt, offline support |
261
265
  | **Cookie Consent** | GDPR-compliant cookie banner and settings |
262
266
 
263
-
264
267
  ---
265
268
 
266
- ## ⚙️ Configuration
269
+ ## Configuration
267
270
 
268
271
  Create `.helixmind/config.json` in your project:
269
272
 
@@ -280,7 +283,7 @@ Create `.helixmind/config.json` in your project:
280
283
  }
281
284
  ```
282
285
 
283
- ### 🔑 Environment Variables
286
+ ### Environment Variables
284
287
 
285
288
  ```bash
286
289
  ANTHROPIC_API_KEY=sk-ant-... # For Claude
@@ -290,7 +293,7 @@ OPENAI_API_KEY=sk-... # For OpenAI/GPT
290
293
 
291
294
  ---
292
295
 
293
- ## 🛠️ Tech Stack
296
+ ## Tech Stack
294
297
 
295
298
  ### CLI
296
299
 
@@ -319,7 +322,7 @@ OPENAI_API_KEY=sk-... # For OpenAI/GPT
319
322
 
320
323
  ---
321
324
 
322
- ## 🏗️ Development
325
+ ## Development
323
326
 
324
327
  ```bash
325
328
  # Clone repo
@@ -349,7 +352,7 @@ npm run dev
349
352
 
350
353
  ---
351
354
 
352
- ## 📚 Documentation
355
+ ## Documentation
353
356
 
354
357
  Complete documentation is available in the web dashboard and includes:
355
358
 
@@ -366,17 +369,16 @@ Complete documentation is available in the web dashboard and includes:
366
369
 
367
370
  ---
368
371
 
369
- ## 📄 License
372
+ ## License
370
373
 
371
- [AGPL-3.0](LICENSE) Free for open-source use. Commercial licenses available.
374
+ [AGPL-3.0](LICENSE) &mdash; Free for open-source use. Commercial licenses available.
372
375
 
373
376
  ---
374
377
 
375
378
  <div align="center">
376
379
 
377
- **Made with ❤️ by [HelixMind](https://github.com/DancingTedDanson011)**
380
+ **Made with care by [HelixMind](https://helix-mind.ai)**
378
381
 
379
- [Back to Top](#-helixmind)
382
+ [Back to Top](#helixmind)
380
383
 
381
384
  </div>
382
-
@@ -1 +1 @@
1
- {"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/chat.ts"],"names":[],"mappings":"AAwDA,UAAU,WAAW;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAkLD,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAq7DrE"}
1
+ {"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/chat.ts"],"names":[],"mappings":"AAwDA,UAAU,WAAW;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAkLD,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAs7DrE"}
@@ -383,7 +383,8 @@ export async function chatCommand(options) {
383
383
  await engine.initialize();
384
384
  return engine;
385
385
  }
386
- catch {
386
+ catch (err) {
387
+ console.error('[Spiral] Init failed:', err instanceof Error ? err.message : err);
387
388
  return null;
388
389
  }
389
390
  }