memindex 1.3.0 → 1.4.1
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/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/.qoder-plugin/plugin.json +1 -1
- package/README.md +84 -41
- package/dist/bug-report/index.js +55 -55
- package/dist/npx-cli/index.js +392 -323
- package/dist/opencode-plugin/index.js +34 -34
- package/dist/pi-extension/index.js +6 -6
- package/integrations/dsh/lib/index.js +24 -24
- package/integrations/dsh/package.json +1 -1
- package/integrations/hermes/memindex/client.py +11 -6
- package/integrations/omp/hooks/memindex.ts +5 -1
- package/integrations/openclaw/TESTING.md +1 -1
- package/integrations/openclaw/dist/index.js +9 -9
- package/integrations/openclaw/e2e-verify.sh +8 -1
- package/integrations/openclaw/openclaw.plugin.json +1 -1
- package/integrations/openclaw/src/index.test.ts +3 -1
- package/integrations/openclaw/src/index.ts +15 -5
- package/package.json +1 -1
- package/plugin/.claude-plugin/plugin.json +1 -1
- package/plugin/.codex-plugin/plugin.json +1 -1
- package/plugin/.mcp.json +1 -1
- package/plugin/.qoder-plugin/plugin.json +1 -1
- package/plugin/hooks.json +1 -13
- package/plugin/package.json +1 -1
- package/plugin/qoder.mcp.json +1 -1
- package/plugin/scripts/context-generator.cjs +48 -47
- package/plugin/scripts/context-generator.cjs.map +3 -3
- package/plugin/scripts/mcp-server.cjs +74 -74
- package/plugin/scripts/mcp-server.cjs.map +2 -2
- package/plugin/scripts/statusline.cjs +1 -0
- package/plugin/scripts/transcript-watcher.cjs +34 -34
- package/plugin/scripts/transcript-watcher.cjs.map +3 -3
- package/plugin/scripts/worker-service.cjs +561 -550
- package/plugin/scripts/worker-service.cjs.map +3 -3
- package/plugin/skills/cloud-sync/SKILL.md +5 -2
- package/plugin/skills/mode-creator/SKILL.md +1 -1
- package/plugin/skills/timeline-report/SKILL.md +8 -5
- package/plugin/skills/weekly-digests/SKILL.md +5 -2
- package/plugin/sqlite/SessionStore.js +93 -93
- package/plugin/sqlite/SessionStore.js.map +2 -2
- package/plugin/sqlite/observations/files.js +4 -4
- package/plugin/sqlite/observations/files.js.map +2 -2
- package/plugin/ui/tv.html +55 -28
- package/plugin/ui/viewer-bundle.js +22 -15
- package/plugin/ui/viewer.html +72 -0
package/README.md
CHANGED
|
@@ -1,63 +1,105 @@
|
|
|
1
1
|
# MemIndex
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
Your agent forgets everything when a session ends. MemIndex remembers it. It watches what the agent does, writes short notes about the work, and brings the right ones back at the start of the next session. Decisions, fixes and dead ends carry over, so you stop explaining the same project twice.
|
|
6
|
-
|
|
7
|
-
It works with Claude Code, Codex, Grok Build and [Muse Code](docs/public/muse-code/setup.mdx).
|
|
8
|
-
|
|
9
|
-
## Install
|
|
3
|
+
MemIndex gives your coding agent a memory: it writes short notes about your work and brings the right ones back at the start of the next session.
|
|
10
4
|
|
|
11
5
|
```sh
|
|
12
|
-
npx memindex@latest
|
|
6
|
+
npx memindex@latest install
|
|
13
7
|
```
|
|
14
8
|
|
|
15
|
-
The installer
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
9
|
+
The installer asks which agent and note writer you want, then starts everything. Restart your agent when it finishes.
|
|
10
|
+
|
|
11
|
+
## What you get
|
|
12
|
+
|
|
13
|
+
- **Your agent remembers.** Decisions, fixes and dead ends from past sessions show up when the next one starts, so you stop explaining the same project twice.
|
|
14
|
+
- **Memory that knows your branch.** Notes from the branch you are on come first. Pin a note (`npx memindex pin <id>`) and every session on that branch starts with it.
|
|
15
|
+
- **Long sessions that keep going.** With Endless Mode, Claude Code picks up exactly where it was after it compacts a conversation.
|
|
16
|
+
- **Search by meaning.** Ask for "the login timeout fix" and find the note even if it never uses those words. It runs on your machine.
|
|
17
|
+
- **Bring your history in.** Import Jira tickets with `npx memindex import jira --project KEY`, or move memory between machines with `npx memindex export` and `npx memindex import`.
|
|
18
|
+
- **Rules from your own habits.** `npx memindex distill` suggests CLAUDE.md and AGENTS.md rules and skills from what your memory keeps repeating. It changes nothing until you approve each one.
|
|
19
|
+
- **A viewer for everything it knows.** Browse every session and note in your browser, with the link the installer prints.
|
|
20
|
+
- **29 languages.** Have notes written in Korean, Portuguese, Arabic and more. See [Modes](#modes).
|
|
21
|
+
- **Yours to keep.** Memory lives on your computer, and you can export all of it any time.
|
|
22
|
+
|
|
23
|
+
## Works with
|
|
24
|
+
|
|
25
|
+
Claude Code, Codex, Grok Build, Muse Code, Cursor, OpenCode, Windsurf, Hermes Agent, OpenClaw, Antigravity CLI, Kimi Code, DeepSeek Harness and OMP record your sessions and bring context back. Claude Desktop, Copilot CLI, Goose, Roo Code, Warp and Pi can search the memory you already have. Each agent's page on [memindex.ai/docs](https://memindex.ai/docs) says exactly what it can do.
|
|
26
|
+
|
|
27
|
+
To install for one agent, name it: `npx memindex@latest install --ide codex-cli`. Check your setup any time with `npx memindex doctor`.
|
|
28
|
+
|
|
29
|
+
## Modes
|
|
30
|
+
|
|
31
|
+
A mode decides what MemIndex writes down, and in which language. The default is `code`, which writes in English and records the work that matters for software projects.
|
|
32
|
+
|
|
33
|
+
| Mode | What it does |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| `code` | The default. Notes in English. |
|
|
36
|
+
| `code--chill` | Fewer notes. Keeps only what would be painful to rediscover: shipped features, fixed bugs, decisions and their reasons, gotchas. |
|
|
37
|
+
| `personal` | For everyday conversations rather than code: people, rules, preferences, commitments and decisions. |
|
|
38
|
+
| `code--<language>` | The same as `code`, with notes and summaries written in another language. 29 are built in. |
|
|
39
|
+
|
|
40
|
+
| Language | Mode | Language | Mode |
|
|
41
|
+
| --- | --- | --- | --- |
|
|
42
|
+
| Arabic | `code--ar` | Italian | `code--it` |
|
|
43
|
+
| Bengali | `code--bn` | Japanese | `code--ja` |
|
|
44
|
+
| Brazilian Portuguese | `code--pt-br` | Korean | `code--ko` |
|
|
45
|
+
| Chinese | `code--zh` | Norwegian | `code--no` |
|
|
46
|
+
| Czech | `code--cs` | Polish | `code--pl` |
|
|
47
|
+
| Danish | `code--da` | Romanian | `code--ro` |
|
|
48
|
+
| Dutch | `code--nl` | Russian | `code--ru` |
|
|
49
|
+
| Finnish | `code--fi` | Spanish | `code--es` |
|
|
50
|
+
| French | `code--fr` | Swedish | `code--sv` |
|
|
51
|
+
| German | `code--de` | Thai | `code--th` |
|
|
52
|
+
| Greek | `code--el` | Turkish | `code--tr` |
|
|
53
|
+
| Hebrew | `code--he` | Ukrainian | `code--uk` |
|
|
54
|
+
| Hindi | `code--hi` | Urdu | `code--ur` |
|
|
55
|
+
| Hungarian | `code--hu` | Vietnamese | `code--vi` |
|
|
56
|
+
| Indonesian | `code--id` | | |
|
|
57
|
+
|
|
58
|
+
To switch, add the mode to `~/.memindex/settings.json`, then run `npx memindex restart`:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"MEMINDEX_MODE": "code--ko"
|
|
63
|
+
}
|
|
64
|
+
```
|
|
21
65
|
|
|
22
|
-
|
|
23
|
-
See the [Grok Build setup guide](docs/public/grok-build/setup.mdx).
|
|
66
|
+
New notes use the new mode. Notes you already have stay as they were.
|
|
24
67
|
|
|
25
|
-
|
|
26
|
-
existing installation, run `npx memindex repair`, then restart Claude Code.
|
|
68
|
+
## Private and local
|
|
27
69
|
|
|
28
|
-
Memory
|
|
29
|
-
|
|
70
|
+
- Memory is stored in `~/.memindex` on your computer. Nothing is sent to MemIndex unless you choose hosting.
|
|
71
|
+
- Notes are written by the service you pick during install (your Claude or Codex plan, Gemini, OpenRouter, or a model you run). That service sees the activity it is asked to summarize, under its own terms.
|
|
72
|
+
- Wrap anything in `<private>` tags and it stays out of your notes.
|
|
73
|
+
- The worker on your machine needs a private key before it accepts changes. See [local worker security](docs/local-worker-security.md).
|
|
74
|
+
- Usage reporting is off unless you turn it on.
|
|
30
75
|
|
|
31
|
-
##
|
|
76
|
+
## Hosting
|
|
32
77
|
|
|
33
|
-
|
|
34
|
-
- **Brings context back on its own.** A new session starts with the notes that matter for the project you are in.
|
|
35
|
-
- **Keeps long sessions going (Endless Mode).** When Claude Code compacts a long session, MemIndex writes the whole session down and Claude picks up exactly where it was, instead of from a short summary.
|
|
36
|
-
- **Lets the agent search its memory.** Three search tools work in steps: a short index first, then the timeline around a result, then full details only for what is needed. That keeps searches cheap.
|
|
37
|
-
- **Keeps everything on your machine.** Memory lives in a local SQLite database, with a local vector store for searching by meaning.
|
|
38
|
-
- **Shows you what it knows.** A local web viewer lists every session and observation.
|
|
39
|
-
- **Your memory is yours to take.** The Export button in the viewer, or `npx memindex export`, downloads all of it (or one project's) as one file that any MemIndex brings back in with `npx memindex import`.
|
|
40
|
-
- **Brings your memory with you.** `npx memindex import --from <file>` copies a MemIndex export file or a SQLite memory database in, with its original dates and projects. Running it twice adds nothing twice.
|
|
78
|
+
Prefer not to run anything yourself? MemIndex hosting writes your notes on our server and keeps one memory across all your machines. Lite is $30 a month after a 30-day trial, Plus is $70, Power is $100, and Team is $40 a seat. Everything above works without it. See [memindex.ai/pricing](https://memindex.ai/pricing).
|
|
41
79
|
|
|
42
|
-
##
|
|
80
|
+
## Learn more
|
|
43
81
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
5. **The search tools** are what the agent calls to look things up.
|
|
82
|
+
- [Documentation](https://memindex.ai/docs): install, settings, every agent, privacy and troubleshooting
|
|
83
|
+
- [How it works](https://memindex.ai/docs/how-it-works)
|
|
84
|
+
- [Changelog](CHANGELOG.md)
|
|
85
|
+
- [Security](SECURITY.md)
|
|
49
86
|
|
|
50
|
-
|
|
87
|
+
Built by Imogen Labs. Licensed under Apache 2.0.
|
|
51
88
|
|
|
52
|
-
|
|
89
|
+
## How it works
|
|
53
90
|
|
|
54
|
-
|
|
91
|
+
1. **Hooks** run when a session starts, when you send a message, after each tool call, and when a session ends. They hand what happened to the worker.
|
|
92
|
+
2. **The worker** is a small local service. It turns raw activity into notes and summaries and serves search.
|
|
93
|
+
3. **SQLite** stores sessions, notes and summaries, and a local vector store lets search match meaning, not just exact words.
|
|
94
|
+
4. **The search tools** are what your agent calls to look things up: a short index first, then the timeline around a result, then full details only for what it needs.
|
|
55
95
|
|
|
56
96
|
## Requirements
|
|
57
97
|
|
|
58
98
|
- Node.js 20.12 or newer
|
|
59
99
|
- Bun (installed automatically if missing)
|
|
60
|
-
-
|
|
100
|
+
- One of the agents above
|
|
101
|
+
|
|
102
|
+
On Windows, install Git for Windows with Git Bash. If something looks off after an update, run `npx memindex repair` and restart your agent.
|
|
61
103
|
|
|
62
104
|
## Development
|
|
63
105
|
|
|
@@ -85,9 +127,10 @@ The [MemIndex product docs](https://memindex.ai/docs) are maintained separately.
|
|
|
85
127
|
- `.claude/` — Maintainer commands and release skill.
|
|
86
128
|
- `.codex-plugin/` — Codex plugin manifest pointing to shared hooks, skills and search tools.
|
|
87
129
|
- `.cursor-plugin/` — Marketplace entries for the separate Cursor and Grok Bot plugins.
|
|
88
|
-
- `.github/` — CI, npm release and Windows workflows, issue forms, the pull request template, Dependabot and release-note settings.
|
|
130
|
+
- `.github/` — CI, plugin bundle rebuild, npm release and Windows workflows, issue forms, the pull request template, Dependabot and release-note settings.
|
|
89
131
|
- `.grok-plugin/` — Grok Bot plugin manifest pointing to its skills and search configuration.
|
|
90
132
|
- `.qoder-plugin/` — Qoder plugin manifest pointing to shared hooks, skills and search configuration.
|
|
133
|
+
- `changes/` — One small file per unreleased change, assembled into the changelog at release; see its README.
|
|
91
134
|
- `docs/` — MemIndex operating guides, integration notes and implementation decisions.
|
|
92
135
|
- `fixtures/` — OpenCode MCP configuration fixture consumed by installer tests.
|
|
93
136
|
- `integrations/` — Agent integration packages and their manifests, installers, skills, tests and required notices.
|
|
@@ -99,7 +142,7 @@ The [MemIndex product docs](https://memindex.ai/docs) are maintained separately.
|
|
|
99
142
|
- `integrations/omp/` — Oh My Pi lifecycle hook adapter and setup guide.
|
|
100
143
|
- `integrations/openclaw/` — OpenClaw memory integration, installers, skills and tests.
|
|
101
144
|
- `integrations/pi/` — Pi extension license and provenance files required by its bundle and installer.
|
|
102
|
-
- `plugin/` — Distributed hooks, built scripts
|
|
145
|
+
- `plugin/` — Distributed hooks, skills, observation modes and the built scripts and viewer. A workflow commits the built files after each merge; a pull request never does.
|
|
103
146
|
- `scripts/` — Build, release, safety checks and maintenance commands.
|
|
104
147
|
- `src/` — Worker, server, command line, agent integrations and viewer source.
|
|
105
148
|
- `tests/` — Automated regression tests, test helpers and isolated fixtures.
|