memorix 0.12.0 → 1.0.0
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 +44 -19
- package/dist/cli/index.js +3059 -224
- package/dist/cli/index.js.map +1 -1
- package/dist/dashboard/static/app.js +222 -2
- package/dist/dashboard/static/index.html +11 -0
- package/dist/dashboard/static/style.css +357 -0
- package/dist/index.js +1430 -426
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,11 +14,11 @@
|
|
|
14
14
|
<a href="https://www.npmjs.com/package/memorix"><img src="https://img.shields.io/npm/dm/memorix.svg?style=flat-square&color=blue" alt="downloads"></a>
|
|
15
15
|
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-green.svg?style=flat-square" alt="license"></a>
|
|
16
16
|
<a href="https://github.com/AVIDS2/memorix"><img src="https://img.shields.io/github/stars/AVIDS2/memorix?style=flat-square&color=yellow" alt="stars"></a>
|
|
17
|
-
<img src="https://img.shields.io/badge/tests-
|
|
17
|
+
<img src="https://img.shields.io/badge/tests-753%20passed-brightgreen?style=flat-square" alt="tests">
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
20
|
<p align="center">
|
|
21
|
-
<strong>
|
|
21
|
+
<strong>v1.0 Stable | 22 MCP tools | Auto-cleanup | Multi-agent collaboration | 10 IDEs supported</strong>
|
|
22
22
|
</p>
|
|
23
23
|
|
|
24
24
|
<p align="center">
|
|
@@ -58,6 +58,8 @@ No re-explaining. No copy-pasting. No vendor lock-in.
|
|
|
58
58
|
### Core Capabilities
|
|
59
59
|
|
|
60
60
|
- **Cross-Agent Memory**: All agents share the same memory store. Store in Cursor, retrieve in Claude Code.
|
|
61
|
+
- **Multi-Agent Collaboration**: Team tools for agent coordination — join/leave, file locks, task boards, and cross-IDE messaging via shared `team-state.json`.
|
|
62
|
+
- **Auto-Cleanup on Startup**: Background retention archiving and intelligent deduplication (LLM or heuristic) run automatically — zero manual maintenance.
|
|
61
63
|
- **Dual-Mode Quality**: Free heuristic engine for basic dedup; optional LLM mode for intelligent compression, reranking, and conflict resolution.
|
|
62
64
|
- **3-Layer Progressive Disclosure**: Search returns compact indices (~50 tokens/result), timeline shows chronological context, detail provides full content. ~10x token savings over full-text retrieval.
|
|
63
65
|
- **Mini-Skills**: Promote high-value observations to permanent skills that auto-inject at every session start. Critical knowledge never decays.
|
|
@@ -168,18 +170,26 @@ Restart your agent. No API keys required. No cloud. No external dependencies.
|
|
|
168
170
|
|
|
169
171
|
## Features
|
|
170
172
|
|
|
171
|
-
###
|
|
173
|
+
### 22 MCP Tools (Default)
|
|
172
174
|
|
|
173
175
|
| Category | Tools |
|
|
174
176
|
|----------|-------|
|
|
175
177
|
| **Memory** | `memorix_store` · `memorix_search` · `memorix_detail` · `memorix_timeline` · `memorix_resolve` · `memorix_deduplicate` · `memorix_suggest_topic_key` |
|
|
176
178
|
| **Sessions** | `memorix_session_start` · `memorix_session_end` · `memorix_session_context` |
|
|
177
|
-
| **Knowledge Graph** | `create_entities` · `create_relations` · `add_observations` · `delete_entities` · `delete_observations` · `delete_relations` · `search_nodes` · `open_nodes` · `read_graph` |
|
|
178
179
|
| **Skills** | `memorix_skills` · `memorix_promote` |
|
|
179
180
|
| **Workspace** | `memorix_workspace_sync` · `memorix_rules_sync` |
|
|
180
|
-
| **Maintenance** | `memorix_retention` · `memorix_consolidate` · `
|
|
181
|
+
| **Maintenance** | `memorix_retention` · `memorix_consolidate` · `memorix_transfer` |
|
|
182
|
+
| **Team** | `team_manage` · `team_file_lock` · `team_task` · `team_message` |
|
|
181
183
|
| **Dashboard** | `memorix_dashboard` |
|
|
182
184
|
|
|
185
|
+
<details>
|
|
186
|
+
<summary><strong>+9 Optional: Knowledge Graph tools</strong> (enable in <code>~/.memorix/settings.json</code>)</summary>
|
|
187
|
+
|
|
188
|
+
`create_entities` · `create_relations` · `add_observations` · `delete_entities` · `delete_observations` · `delete_relations` · `search_nodes` · `open_nodes` · `read_graph`
|
|
189
|
+
|
|
190
|
+
Enable with: `{ "knowledgeGraph": true }` in `~/.memorix/settings.json`
|
|
191
|
+
</details>
|
|
192
|
+
|
|
183
193
|
### Observation Types
|
|
184
194
|
|
|
185
195
|
Nine structured types for classifying stored knowledge:
|
|
@@ -255,6 +265,19 @@ Promote high-value observations to permanent skills using `memorix_promote`. Min
|
|
|
255
265
|
|
|
256
266
|
Use this for critical knowledge that must survive indefinitely: deployment procedures, architectural constraints, recurring gotchas.
|
|
257
267
|
|
|
268
|
+
### Team Collaboration
|
|
269
|
+
|
|
270
|
+
Multiple agents working in the same workspace can coordinate via 4 team tools:
|
|
271
|
+
|
|
272
|
+
| Tool | Actions | Purpose |
|
|
273
|
+
|------|---------|---------|
|
|
274
|
+
| `team_manage` | join, leave, status | Agent registry — see who's active |
|
|
275
|
+
| `team_file_lock` | lock, unlock, status | Advisory file locks to prevent conflicts |
|
|
276
|
+
| `team_task` | create, claim, complete, list | Shared task board with dependencies |
|
|
277
|
+
| `team_message` | send, broadcast, inbox | Direct and broadcast messaging |
|
|
278
|
+
|
|
279
|
+
State is persisted to `team-state.json` and shared across all IDE processes. See [TEAM.md](TEAM.md) for the full protocol.
|
|
280
|
+
|
|
258
281
|
### Auto-Memory Hooks
|
|
259
282
|
|
|
260
283
|
```bash
|
|
@@ -290,19 +313,21 @@ memorix hooks install # Install auto-capture for IDEs
|
|
|
290
313
|
│ MCP Server │
|
|
291
314
|
└──────┬──────┘
|
|
292
315
|
│
|
|
293
|
-
|
|
294
|
-
│
|
|
295
|
-
┌────┴─────┐
|
|
296
|
-
│ Search │
|
|
297
|
-
│ Pipeline │
|
|
298
|
-
│ │
|
|
299
|
-
│ BM25 │
|
|
300
|
-
│ +Vector │
|
|
301
|
-
│ +Rerank │
|
|
302
|
-
└──────────┘
|
|
303
|
-
│
|
|
304
|
-
|
|
305
|
-
|
|
316
|
+
┌──────────┬─────────┼─────────┬──────────┐
|
|
317
|
+
│ │ │ │ │
|
|
318
|
+
┌────┴─────┐ ┌─┴───────┐ │ ┌──────┴──────┐ ┌─┴────────┐
|
|
319
|
+
│ Search │ │ Team │ │ │ Rules & │ │ Auto- │
|
|
320
|
+
│ Pipeline │ │ Collab │ │ │ Workspace │ │ Cleanup │
|
|
321
|
+
│ │ │ │ │ │ Sync │ │ │
|
|
322
|
+
│ BM25 │ │ Agents │ │ └─────────────┘ │ Retention│
|
|
323
|
+
│ +Vector │ │ Tasks │ │ │ +LLM │
|
|
324
|
+
│ +Rerank │ │ Locks │ │ │ Dedup │
|
|
325
|
+
└──────────┘ │ Msgs │ │ └──────────┘
|
|
326
|
+
│ └─────────┘ │
|
|
327
|
+
│ │ │
|
|
328
|
+
~/.memorix/data/ │ Knowledge
|
|
329
|
+
(local, per-project) │ Graph
|
|
330
|
+
team-state.json
|
|
306
331
|
```
|
|
307
332
|
|
|
308
333
|
### Search Pipeline
|
|
@@ -337,7 +362,7 @@ git clone https://github.com/AVIDS2/memorix.git
|
|
|
337
362
|
cd memorix && npm install
|
|
338
363
|
|
|
339
364
|
npm run dev # watch mode
|
|
340
|
-
npm test #
|
|
365
|
+
npm test # 753 tests
|
|
341
366
|
npm run build # production build
|
|
342
367
|
```
|
|
343
368
|
|