helixmind 0.2.13 → 0.2.15

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.

Potentially problematic release.

This version of helixmind might be problematic. Click here for more details.

Files changed (8) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +455 -377
  3. package/dist/cli/commands/chat.d.ts.map +1 -1
  4. package/dist/cli/commands/chat.js +73 -111
  5. package/dist/cli/commands/chat.js.map +1 -1
  6. package/dist/cli/index.js +1 -1
  7. package/dist/cli/index.js.map +1 -1
  8. package/package.json +2 -2
package/README.md CHANGED
@@ -1,377 +1,455 @@
1
- <div align="center">
2
-
3
- # 🧠 HelixMind
4
-
5
- **AI Coding Assistant with Persistent Spiral Memory**
6
-
7
- [![npm version](https://img.shields.io/npm/v/helixmind?color=blue&logo=npm)](https://www.npmjs.com/package/helixmind)
8
- [![License](https://img.shields.io/badge/License-AGPL_3.0-blue?logo=gnu)](LICENSE)
9
- [![Node](https://img.shields.io/badge/Node-18%2B-green?logo=node.js)](https://nodejs.org)
10
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue?logo=typescript)](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
- ## 🚀 Installation
126
-
127
- ```bash
128
- # Run directly (no install needed)
129
- npx helixmind
130
-
131
- # Or install globally
132
- npm install -g helixmind
133
- helixmind
134
- ```
135
-
136
- ---
137
-
138
- ## 🎮 Quick Start
139
-
140
- ```bash
141
- # Start interactive chat (default command)
142
- npx helixmind
143
-
144
- # Initialize in current project
145
- npx helixmind init
146
-
147
- # Send a single message
148
- npx helixmind chat -m "fix all lint errors in src/"
149
-
150
- # YOLO mode — auto-approve everything
151
- npx helixmind chat --yolo
152
-
153
- # Skip permission prompts
154
- npx helixmind chat -s
155
-
156
- # Feed files into spiral memory
157
- npx helixmind feed src/ --deep
158
-
159
- # Watch files and update spiral live
160
- npx helixmind feed src/ --watch
161
- ```
162
-
163
- ---
164
-
165
- ## 📋 CLI Commands
166
-
167
- | Command | Description |
168
- |:--------|:------------|
169
- | `helixmind` / `helixmind chat` | 🎯 Start interactive chat (default) |
170
- | `helixmind helix` | 🎯 Alias for interactive chat |
171
- | `helixmind init` | ⚙️ Initialize HelixMind in project |
172
- | `helixmind chat -m "..."` | 💬 Send a single message |
173
- | `helixmind chat --yolo` | 🚀 Auto-approve all operations |
174
- | `helixmind chat --no-validation` | 🔇 Disable output validation |
175
- | `helixmind chat --validation-verbose` | 🔍 Detailed validation output |
176
- | `helixmind chat --validation-strict` | 🚫 Treat validation warnings as errors |
177
- | `helixmind feed [paths...]` | 📂 Feed files/dirs into spiral |
178
- | `helixmind feed --deep` | 🔍 Deep analysis with intent detection |
179
- | `helixmind feed --watch` | 👁️ Watch and auto-update spiral |
180
- | `helixmind spiral status` | 📊 Show spiral metrics |
181
- | `helixmind spiral search <query>` | 🔎 Search spiral context |
182
- | `helixmind spiral compact` | 🗜️ Trigger spiral compaction |
183
- | `helixmind config set <k> <v>` | ⚙️ Set config value |
184
- | `helixmind config get <key>` | 📖 Get config value |
185
- | `helixmind config list` | 📋 Show all config |
186
- | `helixmind export [dir]` | 📦 Export spiral to .helixmind.zip |
187
- | `helixmind import <zip>` | 📥 Import spiral from archive |
188
- | `helixmind login` | 🔑 Authenticate with web platform |
189
- | `helixmind logout` | 🚪 Remove stored auth |
190
- | `helixmind whoami` | 👤 Show auth status |
191
- | `helixmind bench run` | 🏋️ Run SWE-bench benchmark |
192
- | `helixmind bench results` | 📈 Show benchmark results |
193
- | `helixmind bench compare` | ⚖️ Compare benchmark runs |
194
- | `helixmind bench list` | 📋 List past runs |
195
-
196
- ### ⌨️ Keyboard Shortcuts
197
-
198
- | Key | Action |
199
- |:----|:-------|
200
- | `Ctrl+C` | 🛑 Exit |
201
- | `Ctrl+L` | 🧹 Clear screen |
202
- | `Ctrl+D` | 🐛 Toggle debug mode |
203
- | `Tab` | ✨ Autocomplete command |
204
-
205
- ---
206
-
207
- ## 🧠 Memory Architecture
208
-
209
- ```
210
- ┌─────────────────────────────────────────────────────┐
211
- │ Level 1 — 🔍 Focus │
212
- │ Most relevant, recent context │
213
- ├─────────────────────────────────────────────────────┤
214
- │ Level 2 — ⚡ Active │
215
- │ Related files, dependencies │
216
- ├─────────────────────────────────────────────────────┤
217
- │ Level 3 — 📚 Reference │
218
- │ Decisions, patterns, code structure │
219
- ├─────────────────────────────────────────────────────┤
220
- │ Level 4 — 📦 Archive │
221
- │ Compressed summaries, old sessions │
222
- ├─────────────────────────────────────────────────────┤
223
- │ Level 5 — 🗄️ Deep Archive │
224
- │ Long-term knowledge, project history │
225
- └─────────────────────────────────────────────────────┘
226
- ```
227
-
228
- Context automatically flows between levels based on relevance and recency. Cloud enrichment adds web knowledge via topic detection and content extraction.
229
-
230
- ---
231
-
232
- ## 🌐 Web Platform
233
-
234
- The web dashboard (`web/`) is a full **Next.js 15** application:
235
-
236
- | Feature | Description |
237
- |:--------|:------------|
238
- | **3D Brain View** | Interactive Three.js visualization of your spiral memory |
239
- | **Dashboard** | Manage API keys, billing, profile, and CLI connections |
240
- | **Admin Panel** | User management, ticket system, plans, settings, stats |
241
- | **CLI Integration** | WebSocket bridge — control your CLI from the browser |
242
- | **Support System** | Built-in ticket system with detail views |
243
- | **Blog & Docs** | MDX-based with i18n (DE/EN), sidebar navigation |
244
- | **Auth** | NextAuth with OAuth, staff login, CLI authorization |
245
- | **Billing** | Stripe checkout, portal, webhooks |
246
- | **PWA** | Service worker, install prompt, offline support |
247
- | **Cookie Consent** | GDPR-compliant cookie banner and settings |
248
-
249
- ### Web Setup
250
-
251
- ```bash
252
- cd web
253
- npm install
254
- cp .env.example .env # Configure database, auth, stripe
255
- npx prisma db push # Set up database
256
- npm run db:seed # Seed initial data
257
- npm run dev # Start dev server (Turbopack)
258
- ```
259
-
260
- ---
261
-
262
- ## ⚙️ Configuration
263
-
264
- Create `.helixmind/config.json` in your project:
265
-
266
- ```json
267
- {
268
- "provider": "anthropic",
269
- "model": "claude-sonnet-4-20250514",
270
- "brainEnabled": true,
271
- "permissions": {
272
- "writeFiles": true,
273
- "runCommands": true,
274
- "gitCommit": true
275
- }
276
- }
277
- ```
278
-
279
- ### 🔑 Environment Variables
280
-
281
- ```bash
282
- ANTHROPIC_API_KEY=sk-ant-... # For Claude
283
- OPENAI_API_KEY=sk-... # For OpenAI/GPT
284
- # Ollama: no key needed (local)
285
- ```
286
-
287
- ---
288
-
289
- ## 🛠️ Tech Stack
290
-
291
- ### CLI
292
-
293
- | Category | Technology |
294
- |:---------|:-----------|
295
- | Language | ![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue) |
296
- | AI SDKs | ![Anthropic](https://img.shields.io/badge/Anthropic-SDK-orange) ![OpenAI](https://img.shields.io/badge/OpenAI-SDK-green) ![Ollama](https://img.shields.io/badge/Ollama-local-purple) |
297
- | Database | ![SQLite](https://img.shields.io/badge/SQLite-better--sqlite3-lightgrey) ![sqlite-vec](https://img.shields.io/badge/sqlite--vec-vectors-blue) |
298
- | Embeddings | ![Transformers](https://img.shields.io/badge/HuggingFace-Transformers-yellow) |
299
- | Browser | ![Puppeteer](https://img.shields.io/badge/Puppeteer-headless-green) |
300
- | Testing | ![Vitest](https://img.shields.io/badge/Vitest-70%2B_tests-yellowgreen) |
301
- | MCP | ![MCP](https://img.shields.io/badge/MCP-SDK-blue) |
302
-
303
- ### Web
304
-
305
- | Category | Technology |
306
- |:---------|:-----------|
307
- | Framework | ![Next.js](https://img.shields.io/badge/Next.js-15-black) ![React](https://img.shields.io/badge/React-19-blue) |
308
- | 3D | ![Three.js](https://img.shields.io/badge/Three.js-R3F-green) |
309
- | Database | ![Prisma](https://img.shields.io/badge/Prisma-6-purple) |
310
- | Auth | ![NextAuth](https://img.shields.io/badge/NextAuth-v5-orange) |
311
- | Payments | ![Stripe](https://img.shields.io/badge/Stripe-17-blue) |
312
- | Styling | ![Tailwind](https://img.shields.io/badge/Tailwind-4-cyan) |
313
- | i18n | ![next-intl](https://img.shields.io/badge/next--intl-DE%2FEN-yellow) |
314
- | PWA | ![Serwist](https://img.shields.io/badge/Serwist-PWA-green) |
315
-
316
- ---
317
-
318
- ## 🏗️ Development
319
-
320
- ```bash
321
- # Clone repo
322
- git clone https://github.com/DancingTedDanson011/HelixMind.git
323
- cd HelixMind
324
-
325
- # Install dependencies (CLI)
326
- npm install
327
-
328
- # Build CLI
329
- npm run build
330
-
331
- # Run CLI in dev mode
332
- npm run dev
333
-
334
- # Run tests
335
- npm test
336
-
337
- # Run tests with coverage
338
- npm run test:coverage
339
-
340
- # Web dashboard
341
- cd web
342
- npm install
343
- npm run dev
344
- ```
345
-
346
- ---
347
-
348
- ## 📚 Documentation
349
-
350
- Complete documentation is available in the web dashboard and includes:
351
-
352
- | Category | Topics |
353
- |:---------|:-------|
354
- | **Core Concepts** | Spiral Memory, Validation Matrix, Web Knowledge, Bug Tracking, Browser Automation |
355
- | **Usage Guides** | Getting Started, Configuration, Authentication, Project Setup |
356
- | **Advanced** | Autonomous Modes, Agent Tools, MCP Integration, SWE-Bench |
357
- | **Reference** | CLI Commands, Slash Commands, Permission System, Export/Import |
358
-
359
- **Web Dashboard Docs**: Start the web dashboard (`cd web && npm run dev`) and navigate to `/docs`.
360
-
361
- **CLI Help**: Use `helixmind --help` or `helixmind chat --help` for command reference.
362
-
363
- ---
364
-
365
- ## 📄 License
366
-
367
- [AGPL-3.0](LICENSE) — Free for open-source use. Commercial licenses available.
368
-
369
- ---
370
-
371
- <div align="center">
372
-
373
- **Made with ❤️ by [HelixMind](https://github.com/DancingTedDanson011)**
374
-
375
- [⬆ Back to Top](#-helixmind)
376
-
377
- </div>
1
+ <div align="center">
2
+
3
+ # 🧠 HelixMind
4
+
5
+ **AI Coding Assistant with Persistent Spiral Memory**
6
+
7
+ [![npm version](https://img.shields.io/npm/v/helixmind?color=blue&logo=npm)](https://www.npmjs.com/package/helixmind)
8
+ [![License](https://img.shields.io/badge/License-AGPL_3.0-blue?logo=gnu)](LICENSE)
9
+ [![Node](https://img.shields.io/badge/Node-18%2B-green?logo=node.js)](https://nodejs.org)
10
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.0%2B-blue?logo=typescript)](https://www.typescriptlang.org/)
11
+
12
+ *Remembers context across sessions. Learns from every interaction. Full SaaS platform with CLI + [Web Dashboard](https://helix-mind.ai).*
13
+
14
+ **Website:** [helix-mind.ai](https://helix-mind.ai) • **npm:** [helixmind](https://www.npmjs.com/package/helixmind)
15
+
16
+ [Installation](#-installation) • [Features](#-features) • [Quick Start](#-quick-start) • [Web Platform](#-web-platform) • [Documentation](#-documentation)
17
+
18
+ </div>
19
+
20
+ ---
21
+
22
+ ## ✨ Features
23
+
24
+ <table>
25
+ <tr>
26
+ <td width="50%">
27
+
28
+ ### 🔄 Spiral Memory
29
+ **5-level hierarchical memory** that persists across sessions. Context flows between levels based on relevance and recency.
30
+
31
+ </td>
32
+ <td width="50%">
33
+
34
+ ### 🤖 Multi-Provider
35
+ **Claude, GPT-4, Ollama** and more. Switch seamlessly between AI providers with rate limiting and model limits.
36
+
37
+ </td>
38
+ </tr>
39
+ <tr>
40
+ <td width="50%">
41
+
42
+ ### ⚡ Autonomous Agent
43
+ AI can **edit files, run commands, commit changes, and browse the web** — with a permission system and sandbox for safety.
44
+
45
+ </td>
46
+ <td width="50%">
47
+
48
+ ### 🎯 Smart Context
49
+ **Auto-assembles relevant code** from your project. Session buffer, context trimming, and dependency tracking.
50
+
51
+ </td>
52
+ </tr>
53
+ <tr>
54
+ <td width="50%">
55
+
56
+ ### 🌐 Web Dashboard
57
+ **Next.js 15 platform** with 3D brain visualization, admin panel, billing (Stripe), support tickets, and CLI remote control.
58
+
59
+ </td>
60
+ <td width="50%">
61
+
62
+ ### 🔬 Validation Matrix
63
+ **Automatic output validation** with static checks, dynamic checks, spiral checks, autofix, and quality classification.
64
+
65
+ </td>
66
+ </tr>
67
+ <tr>
68
+ <td width="50%">
69
+
70
+ ### 📊 SWE-Bench Integration
71
+ **Built-in benchmark suite** — run SWE-bench Lite/Verified, compare runs, measure Spiral Memory impact.
72
+
73
+ </td>
74
+ <td width="50%">
75
+
76
+ ### 🌍 Web Knowledge
77
+ **Cloud-enriched context** — topic detection, web search, content extraction, and automatic knowledge integration.
78
+
79
+ </td>
80
+ </tr>
81
+ <tr>
82
+ <td width="50%">
83
+
84
+ ### 🐛 Bug Tracking
85
+ **Automatic bug detection** and persistent journal — track bugs across sessions with evidence and status.
86
+
87
+ </td>
88
+ <td width="50%">
89
+
90
+ ### 💾 Checkpoints & Sessions
91
+ **Save and revert** to any checkpoint, multi-session tab view, session lifecycle management.
92
+
93
+ </td>
94
+ </tr>
95
+ <tr>
96
+ <td width="50%">
97
+
98
+ ### 🌐 Browser Automation
99
+ **Puppeteer-based browser control** — navigate, click, type, screenshot, visual analysis with Chrome integration.
100
+
101
+ </td>
102
+ <td width="50%">
103
+
104
+ ### 🔐 Authentication & Security
105
+ **OAuth login, API keys, feature gating** — secure access control with subscription tier enforcement.
106
+
107
+ </td>
108
+ </tr>
109
+ <tr>
110
+ <td width="50%">
111
+
112
+ ### 🛡️ Security Monitor
113
+ **Continuous security monitoring** — threat detection, automated defenses, real-time dashboard with approval queue.
114
+
115
+ </td>
116
+ <td width="50%">
117
+
118
+ ### 📈 MCP Integration
119
+ **Model Context Protocol** — works with Claude Code, Cursor, VS Code, Windsurf, Codex, JetBrains AI.
120
+
121
+ </td>
122
+ </tr>
123
+ </table>
124
+
125
+ ---
126
+
127
+ ## 🚀 Installation
128
+
129
+ ```bash
130
+ # Run directly (no install needed)
131
+ npx helixmind
132
+
133
+ # Or install globally
134
+ npm install -g helixmind
135
+ helixmind
136
+ ```
137
+
138
+ ---
139
+
140
+ ## 🎮 Quick Start
141
+
142
+ ```bash
143
+ # Start interactive chat (default command)
144
+ npx helixmind
145
+
146
+ # Initialize in current project
147
+ npx helixmind init
148
+
149
+ # Send a single message
150
+ npx helixmind chat -m "fix all lint errors in src/"
151
+
152
+ # YOLO mode — auto-approve everything
153
+ npx helixmind chat --yolo
154
+
155
+ # Skip permission prompts
156
+ npx helixmind chat -s
157
+
158
+ # Feed files into spiral memory
159
+ npx helixmind feed src/ --deep
160
+
161
+ # Watch files and update spiral live
162
+ npx helixmind feed src/ --watch
163
+ ```
164
+
165
+ ---
166
+
167
+ ## 📋 CLI Commands
168
+
169
+ | Command | Description |
170
+ |:--------|:------------|
171
+ | `helixmind` / `helixmind chat` | 🎯 Start interactive chat (default) |
172
+ | `helixmind helix` | 🎯 Alias for interactive chat |
173
+ | `helixmind init` | ⚙️ Initialize HelixMind in project |
174
+ | `helixmind chat -m "..."` | 💬 Send a single message |
175
+ | `helixmind chat --yolo` | 🚀 Auto-approve all operations |
176
+ | `helixmind chat --no-validation` | 🔇 Disable output validation |
177
+ | `helixmind chat --validation-verbose` | 🔍 Detailed validation output |
178
+ | `helixmind chat --validation-strict` | 🚫 Treat validation warnings as errors |
179
+ | `helixmind feed [paths...]` | 📂 Feed files/dirs into spiral |
180
+ | `helixmind feed --deep` | 🔍 Deep analysis with intent detection |
181
+ | `helixmind feed --watch` | 👁️ Watch and auto-update spiral |
182
+ | `helixmind spiral status` | 📊 Show spiral metrics |
183
+ | `helixmind spiral search <query>` | 🔎 Search spiral context |
184
+ | `helixmind spiral compact` | 🗜️ Trigger spiral compaction |
185
+ | `helixmind config set <k> <v>` | ⚙️ Set config value |
186
+ | `helixmind config get <key>` | 📖 Get config value |
187
+ | `helixmind config list` | 📋 Show all config |
188
+ | `helixmind export [dir]` | 📦 Export spiral to .helixmind.zip |
189
+ | `helixmind import <zip>` | 📥 Import spiral from archive |
190
+ | `helixmind login` | 🔑 Authenticate with web platform |
191
+ | `helixmind logout` | 🚪 Remove stored auth |
192
+ | `helixmind whoami` | 👤 Show auth status |
193
+ | `helixmind bench run` | 🏋️ Run SWE-bench benchmark |
194
+ | `helixmind bench results` | 📈 Show benchmark results |
195
+ | `helixmind bench compare` | ⚖️ Compare benchmark runs |
196
+ | `helixmind bench list` | 📋 List past runs |
197
+
198
+ ### 💬 Slash Commands (Interactive Chat)
199
+
200
+ **Core**
201
+
202
+ | Command | Description |
203
+ |:--------|:------------|
204
+ | `/help` | Show all commands (interactive menu) |
205
+ | `/clear` | Clear conversation history |
206
+ | `/model` | Switch LLM model (interactive picker) |
207
+ | `/model <name>` | Switch directly to a model |
208
+ | `/keys` | Manage API keys |
209
+ | `/local` | Local LLM setup (Ollama) |
210
+ | `/tokens` | Show token usage & memory stats |
211
+ | `/exit` / `/quit` | Save state and exit |
212
+
213
+ **Spiral Memory & Brain**
214
+
215
+ | Command | Description |
216
+ |:--------|:------------|
217
+ | `/spiral` | Show spiral memory status (nodes per level) |
218
+ | `/feed <paths>` | Feed files/directories into spiral |
219
+ | `/context` | Show context, embeddings & session info |
220
+ | `/project` | Show project info (type, frameworks, files) |
221
+ | `/compact` | Trigger spiral evolution (promote/demote/summarize) |
222
+ | `/export [dir]` | Export spiral as ZIP archive |
223
+ | `/brain` | Show brain scope & open 3D visualization |
224
+ | `/brain local` | Switch to project-local brain (.helixmind/) |
225
+ | `/brain global` | Switch to global brain (~/.spiral-context/) |
226
+ | `/helix` | Command Center + Brain (auto-start, local scope) |
227
+ | `/helixlocal` | Command Center + Brain (local scope) |
228
+ | `/helixglobal` | Command Center + Brain (global scope) |
229
+
230
+ **Agent & Autonomous**
231
+
232
+ | Command | Description |
233
+ |:--------|:------------|
234
+ | `/auto` | Start autonomous mode (find & fix issues, background) |
235
+ | `/auto <goal>` | Start autonomous mode with specific goal |
236
+ | `/stop` | Stop autonomous mode |
237
+ | `/security` | Run security audit (background session) |
238
+ | `/monitor` | Start security monitor — passive/defensive/active modes |
239
+ | `/yolo [on\|off]` | Toggle YOLO mode (auto-approve everything) |
240
+ | `/skip-permissions [on\|off]` | Toggle skip-permissions (writes auto-approved) |
241
+
242
+ **Tools & Debugging**
243
+
244
+ | Command | Description |
245
+ |:--------|:------------|
246
+ | `/undo [n]` | Undo last n file changes (default: 1) |
247
+ | `/undo list` | Show undo history |
248
+ | `/diff` | Show git diff (uncommitted changes) |
249
+ | `/git` | Show git status & branch |
250
+ | `/bugs [status]` | List tracked bugs (all/open/fixed/verified) |
251
+ | `/bugfix` | Auto-fix all open bugs (agent mode) |
252
+ | `/browser [url]` | Open browser / navigate to URL |
253
+ | `/browser close` | Close browser |
254
+ | `/validation` | Show Validation Matrix status |
255
+ | `/validation on\|off` | Enable/disable output validation |
256
+ | `/validation verbose` | Toggle verbose validation output |
257
+ | `/validation strict` | Toggle strict mode (warnings = errors) |
258
+ | `/validation stats` | Show validation statistics |
259
+
260
+ **Sessions & Auth**
261
+
262
+ | Command | Description |
263
+ |:--------|:------------|
264
+ | `/sessions` | List all sessions & tabs |
265
+ | `/session close <id>` | Close a session by ID |
266
+ | `/session stop [id]` | Stop a running session (or all) |
267
+ | `/session switch <id>` | Switch to a session tab |
268
+ | `/login` | Log in to HelixMind web platform |
269
+ | `/logout` | Log out and revoke API key |
270
+ | `/whoami` | Show account & plan info |
271
+
272
+ ### ⌨️ Keyboard Shortcuts
273
+
274
+ | Key | Action |
275
+ |:----|:-------|
276
+ | `Ctrl+C` | Clear current input (or interrupt agent, double = exit) |
277
+ | `Esc` | Stop running agent & all background sessions |
278
+ | `Esc Esc` | Open Rewind browser (checkpoint timeline) |
279
+ | `Ctrl+PageUp/Down` | Switch between session tabs |
280
+ | `Tab` | Autocomplete slash command |
281
+ | Multi-line paste | Auto-detected — `Enter` to send, `Esc` to discard |
282
+
283
+ ---
284
+
285
+ ## 🧠 Memory Architecture
286
+
287
+ ```
288
+ ┌─────────────────────────────────────────────────────┐
289
+ │ Level 1 — 🔍 Focus │
290
+ │ Most relevant, recent context │
291
+ ├─────────────────────────────────────────────────────┤
292
+ │ Level 2 — ⚡ Active │
293
+ │ Related files, dependencies │
294
+ ├─────────────────────────────────────────────────────┤
295
+ │ Level 3 — 📚 Reference │
296
+ │ Decisions, patterns, code structure │
297
+ ├─────────────────────────────────────────────────────┤
298
+ │ Level 4 — 📦 Archive │
299
+ │ Compressed summaries, old sessions │
300
+ ├─────────────────────────────────────────────────────┤
301
+ │ Level 5 — 🗄️ Deep Archive │
302
+ │ Long-term knowledge, project history │
303
+ └─────────────────────────────────────────────────────┘
304
+ ```
305
+
306
+ Context automatically flows between levels based on relevance and recency. Cloud enrichment adds web knowledge via topic detection and content extraction.
307
+
308
+ ---
309
+
310
+ ## 🌐 Web Platform
311
+
312
+ The web dashboard (`web/`) is a full **Next.js 15** application:
313
+
314
+ | Feature | Description |
315
+ |:--------|:------------|
316
+ | **3D Brain View** | Interactive Three.js visualization of your spiral memory |
317
+ | **Dashboard** | Manage API keys, billing, profile, and CLI connections |
318
+ | **Admin Panel** | User management, ticket system, plans, settings, stats |
319
+ | **CLI Integration** | WebSocket bridge — control your CLI from the browser |
320
+ | **Support System** | Built-in ticket system with detail views |
321
+ | **Blog & Docs** | MDX-based with i18n (DE/EN), sidebar navigation |
322
+ | **Auth** | NextAuth with OAuth, staff login, CLI authorization |
323
+ | **Billing** | Stripe checkout, portal, webhooks |
324
+ | **PWA** | Service worker, install prompt, offline support |
325
+ | **Cookie Consent** | GDPR-compliant cookie banner and settings |
326
+
327
+ ### Web Setup
328
+
329
+ ```bash
330
+ cd web
331
+ npm install
332
+ cp .env.example .env # Configure database, auth, stripe
333
+ npx prisma db push # Set up database
334
+ npm run db:seed # Seed initial data
335
+ npm run dev # Start dev server (Turbopack)
336
+ ```
337
+
338
+ ---
339
+
340
+ ## ⚙️ Configuration
341
+
342
+ Create `.helixmind/config.json` in your project:
343
+
344
+ ```json
345
+ {
346
+ "provider": "anthropic",
347
+ "model": "claude-sonnet-4-20250514",
348
+ "brainEnabled": true,
349
+ "permissions": {
350
+ "writeFiles": true,
351
+ "runCommands": true,
352
+ "gitCommit": true
353
+ }
354
+ }
355
+ ```
356
+
357
+ ### 🔑 Environment Variables
358
+
359
+ ```bash
360
+ ANTHROPIC_API_KEY=sk-ant-... # For Claude
361
+ OPENAI_API_KEY=sk-... # For OpenAI/GPT
362
+ # Ollama: no key needed (local)
363
+ ```
364
+
365
+ ---
366
+
367
+ ## 🛠️ Tech Stack
368
+
369
+ ### CLI
370
+
371
+ | Category | Technology |
372
+ |:---------|:-----------|
373
+ | Language | ![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue) |
374
+ | AI SDKs | ![Anthropic](https://img.shields.io/badge/Anthropic-SDK-orange) ![OpenAI](https://img.shields.io/badge/OpenAI-SDK-green) ![Ollama](https://img.shields.io/badge/Ollama-local-purple) |
375
+ | Database | ![SQLite](https://img.shields.io/badge/SQLite-better--sqlite3-lightgrey) ![sqlite-vec](https://img.shields.io/badge/sqlite--vec-vectors-blue) |
376
+ | Embeddings | ![Transformers](https://img.shields.io/badge/HuggingFace-Transformers-yellow) |
377
+ | Browser | ![Puppeteer](https://img.shields.io/badge/Puppeteer-headless-green) |
378
+ | Testing | ![Vitest](https://img.shields.io/badge/Vitest-70%2B_tests-yellowgreen) |
379
+ | MCP | ![MCP](https://img.shields.io/badge/MCP-SDK-blue) |
380
+
381
+ ### Web
382
+
383
+ | Category | Technology |
384
+ |:---------|:-----------|
385
+ | Framework | ![Next.js](https://img.shields.io/badge/Next.js-15-black) ![React](https://img.shields.io/badge/React-19-blue) |
386
+ | 3D | ![Three.js](https://img.shields.io/badge/Three.js-R3F-green) |
387
+ | Database | ![Prisma](https://img.shields.io/badge/Prisma-6-purple) |
388
+ | Auth | ![NextAuth](https://img.shields.io/badge/NextAuth-v5-orange) |
389
+ | Payments | ![Stripe](https://img.shields.io/badge/Stripe-17-blue) |
390
+ | Styling | ![Tailwind](https://img.shields.io/badge/Tailwind-4-cyan) |
391
+ | i18n | ![next-intl](https://img.shields.io/badge/next--intl-DE%2FEN-yellow) |
392
+ | PWA | ![Serwist](https://img.shields.io/badge/Serwist-PWA-green) |
393
+
394
+ ---
395
+
396
+ ## 🏗️ Development
397
+
398
+ ```bash
399
+ # Clone repo
400
+ git clone https://github.com/DancingTedDanson011/HelixMind.git
401
+ cd HelixMind
402
+
403
+ # Install dependencies (CLI)
404
+ npm install
405
+
406
+ # Build CLI
407
+ npm run build
408
+
409
+ # Run CLI in dev mode
410
+ npm run dev
411
+
412
+ # Run tests
413
+ npm test
414
+
415
+ # Run tests with coverage
416
+ npm run test:coverage
417
+
418
+ # Web dashboard
419
+ cd web
420
+ npm install
421
+ npm run dev
422
+ ```
423
+
424
+ ---
425
+
426
+ ## 📚 Documentation
427
+
428
+ Complete documentation is available in the web dashboard and includes:
429
+
430
+ | Category | Topics |
431
+ |:---------|:-------|
432
+ | **Core Concepts** | Spiral Memory, Validation Matrix, Web Knowledge, Bug Tracking, Browser Automation |
433
+ | **Usage Guides** | Getting Started, Configuration, Authentication, Project Setup |
434
+ | **Advanced** | Autonomous Modes, Agent Tools, MCP Integration, SWE-Bench |
435
+ | **Reference** | CLI Commands, Slash Commands, Permission System, Export/Import |
436
+
437
+ **Web Dashboard Docs**: Start the web dashboard (`cd web && npm run dev`) and navigate to `/docs`.
438
+
439
+ **CLI Help**: Use `helixmind --help` or `helixmind chat --help` for command reference.
440
+
441
+ ---
442
+
443
+ ## 📄 License
444
+
445
+ [AGPL-3.0](LICENSE) — Free for open-source use. Commercial licenses available.
446
+
447
+ ---
448
+
449
+ <div align="center">
450
+
451
+ **Made with ❤️ by [HelixMind](https://github.com/DancingTedDanson011)**
452
+
453
+ [⬆ Back to Top](#-helixmind)
454
+
455
+ </div>