open-memex 0.3.0-alpha.3 → 0.3.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/AGENTS.md +1 -1
- package/README.md +18 -13
- package/README.zh-CN.md +17 -12
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -34,7 +34,7 @@ node --experimental-strip-types scripts\smoke-pure.ts # runs pure-logic checks
|
|
|
34
34
|
node --experimental-strip-types scripts\smoke-mcp.ts # MCP handshake + tool round-trip (temp dirs, no real data)
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
After `npm i -g open-memex
|
|
37
|
+
After `npm i -g open-memex` (or `npm link` from source), the `open-memex` bin is on
|
|
38
38
|
PATH: `open-memex mcp` starts the MCP server, `open-memex mcp --print-config <client>`
|
|
39
39
|
prints a client config snippet (client: vscode|cursor|claude|opencode|visualstudio),
|
|
40
40
|
`open-memex init [--client vscode|cursor|opencode|visualstudio] [--instructions personal|project] [--force] [--yes]`
|
package/README.md
CHANGED
|
@@ -21,16 +21,15 @@ plus a generic MCP server (VS Code Copilot, Cursor, Claude Code, Visual Studio,
|
|
|
21
21
|
**npm (recommended):**
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
|
-
npm install -g open-memex
|
|
24
|
+
npm install -g open-memex
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
This installs the `0.3.0
|
|
28
|
-
`0.1.0` stable.)
|
|
27
|
+
This installs the `0.3.0` stable release.
|
|
29
28
|
|
|
30
29
|
**No install — run via npx:**
|
|
31
30
|
|
|
32
31
|
```sh
|
|
33
|
-
npx -y open-memex
|
|
32
|
+
npx -y open-memex <command> # e.g. npx -y open-memex init --client vscode
|
|
34
33
|
```
|
|
35
34
|
|
|
36
35
|
**From source** (bleeding edge, `V2-dev-p2` branch):
|
|
@@ -42,9 +41,6 @@ npm install
|
|
|
42
41
|
node --experimental-strip-types src/cli.ts <command>
|
|
43
42
|
```
|
|
44
43
|
|
|
45
|
-
> The `0.3.0-alpha` npm publish is cut from this branch — if `npx` still resolves an
|
|
46
|
-
> older alpha, install from source until the publish lands.
|
|
47
|
-
|
|
48
44
|
#### "`open-memex` is not recognized" — PATH setup
|
|
49
45
|
|
|
50
46
|
A global `npm install -g` puts the `open-memex` launcher in npm's global bin folder.
|
|
@@ -65,6 +61,15 @@ If your terminal can't find it, that folder isn't on your `PATH`:
|
|
|
65
61
|
3. No admin rights / don't want to touch `PATH`? Use the npx form above — npx
|
|
66
62
|
resolves the package itself and needs no `PATH` changes.
|
|
67
63
|
|
|
64
|
+
#### "`EBUSY` / `EPERM` on `better_sqlite3.node`" — Windows reinstall
|
|
65
|
+
|
|
66
|
+
On Windows a loaded DLL is locked: if the open-memex MCP server is running
|
|
67
|
+
(VS Code MCP panel, Cursor, etc.), `npm install -g open-memex` cannot
|
|
68
|
+
replace `better_sqlite3.node` and fails with `EBUSY` / `EPERM`. Stop the MCP
|
|
69
|
+
server first (or quit the editor), then re-run the install. If it still fails,
|
|
70
|
+
delete `node_modules/open-memex` and any `node_modules/.open-memex-*` temp
|
|
71
|
+
folders under your global npm root and install again.
|
|
72
|
+
|
|
68
73
|
### Step 2 — One-command setup for your editor
|
|
69
74
|
|
|
70
75
|
Run from your **project root** (so the project scope resolves to this repo):
|
|
@@ -74,7 +79,7 @@ Run from your **project root** (so the project scope resolves to this repo):
|
|
|
74
79
|
```sh
|
|
75
80
|
open-memex init --client vscode
|
|
76
81
|
# …or without a global install:
|
|
77
|
-
npx -y open-memex
|
|
82
|
+
npx -y open-memex init --client vscode
|
|
78
83
|
```
|
|
79
84
|
|
|
80
85
|
Writes `.vscode/mcp.json` and user-level Copilot instructions, then reload the
|
|
@@ -136,8 +141,8 @@ above works too.
|
|
|
136
141
|
- Existing config files are **merged, never clobbered** — re-running is safe.
|
|
137
142
|
`--force` overwrites.
|
|
138
143
|
- With no durable `open-memex` on `PATH` (e.g. one-shot npx), `init` writes an
|
|
139
|
-
`npx -y open-memex
|
|
140
|
-
working. `npm i -g open-memex
|
|
144
|
+
`npx -y open-memex mcp` server command into the config so the setup keeps
|
|
145
|
+
working. `npm i -g open-memex` + `open-memex init --force` switches to the
|
|
141
146
|
faster direct command later.
|
|
142
147
|
|
|
143
148
|
### Step 3 — Verify it works
|
|
@@ -280,7 +285,7 @@ no host-specific plugin needed. Any MCP client can use open-memex.
|
|
|
280
285
|
|
|
281
286
|
```sh
|
|
282
287
|
open-memex mcp # after a global install
|
|
283
|
-
npx -y open-memex
|
|
288
|
+
npx -y open-memex mcp # no install needed
|
|
284
289
|
```
|
|
285
290
|
|
|
286
291
|
The project scope is resolved from the process working directory, so configure the
|
|
@@ -293,11 +298,11 @@ server with cwd set to your project root (`init` handles this for you).
|
|
|
293
298
|
|
|
294
299
|
## Roadmap
|
|
295
300
|
|
|
296
|
-
**`0.3.0
|
|
301
|
+
**`0.3.0` (this release):** generic MCP server, `open-memex` bin/CLI, one-command
|
|
297
302
|
`init` setup, Chinese keyword capture with personal/project routing, `config` /
|
|
298
303
|
`capture --dry-run` / `doctor` helpers, Visual Studio support.
|
|
299
304
|
|
|
300
|
-
**Coming — `0.
|
|
305
|
+
**Coming — `0.4.0`:** team sync — shared memory via git (`propose` / `promote` /
|
|
301
306
|
`resolve` workflow, in-repo memory dir), 1–2 colleague pilot.
|
|
302
307
|
|
|
303
308
|
**Coming — `0.3.0` (stable):** org layer — org memory repo, curator convention,
|
package/README.zh-CN.md
CHANGED
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
**npm(推荐):**
|
|
22
22
|
|
|
23
23
|
```sh
|
|
24
|
-
npm install -g open-memex
|
|
24
|
+
npm install -g open-memex
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
安装的是 `0.3.0
|
|
27
|
+
安装的是 `0.3.0` 正式版。
|
|
28
28
|
|
|
29
29
|
**免安装——用 npx 直接跑:**
|
|
30
30
|
|
|
31
31
|
```sh
|
|
32
|
-
npx -y open-memex
|
|
32
|
+
npx -y open-memex <命令> # 例如 npx -y open-memex init --client vscode
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
**从源码安装**(最新开发版,`V2-dev-p2` 分支):
|
|
@@ -41,9 +41,6 @@ npm install
|
|
|
41
41
|
node --experimental-strip-types src/cli.ts <命令>
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
> `0.3.0-alpha` 的 npm 发布从该分支切出——如果 npx 还解析到旧的 alpha 版,
|
|
45
|
-
> 请先用源码安装,等发布落地。
|
|
46
|
-
|
|
47
44
|
#### 提示 "'open-memex' 不是内部命令"?——PATH 设置
|
|
48
45
|
|
|
49
46
|
`npm install -g` 会把 `open-memex` 启动器放到 npm 的全局 bin 目录。
|
|
@@ -63,6 +60,14 @@ node --experimental-strip-types src/cli.ts <命令>
|
|
|
63
60
|
3. 没有管理员权限 / 不想动 `PATH`?用上面的 npx 形式——npx 自己解析包,
|
|
64
61
|
不需要改 `PATH`。
|
|
65
62
|
|
|
63
|
+
#### Windows 重装报 "`EBUSY` / `EPERM`(`better_sqlite3.node`)"
|
|
64
|
+
|
|
65
|
+
Windows 下被进程加载的 DLL 是锁死的:如果 open-memex MCP server 正在运行
|
|
66
|
+
(VS Code MCP 面板、Cursor 等),`npm install -g open-memex` 替换不了
|
|
67
|
+
`better_sqlite3.node`,就会报 `EBUSY` / `EPERM`。先停掉 MCP server
|
|
68
|
+
(或退出编辑器),再重跑安装。还不行的话,手动删掉全局 npm 目录下的
|
|
69
|
+
`node_modules/open-memex` 和 `node_modules/.open-memex-*` 临时目录,再装。
|
|
70
|
+
|
|
66
71
|
### 第二步——给你的编辑器一键配置
|
|
67
72
|
|
|
68
73
|
在**项目根目录**下运行(这样 project scope 会解析到这个仓库):
|
|
@@ -72,7 +77,7 @@ node --experimental-strip-types src/cli.ts <命令>
|
|
|
72
77
|
```sh
|
|
73
78
|
open-memex init --client vscode
|
|
74
79
|
# ……没装全局包的话:
|
|
75
|
-
npx -y open-memex
|
|
80
|
+
npx -y open-memex init --client vscode
|
|
76
81
|
```
|
|
77
82
|
|
|
78
83
|
自动写 `.vscode/mcp.json` 和用户级 Copilot instructions,然后重新加载窗口,
|
|
@@ -132,8 +137,8 @@ Visual Studio 也会自动发现 `.vscode/mcp.json` 和 `.cursor/mcp.json`,
|
|
|
132
137
|
- 已有配置文件会被**合并,不会被覆盖**——重复运行是安全的。
|
|
133
138
|
`--force` 强制覆盖。
|
|
134
139
|
- 如果 `PATH` 上没有可用的 `open-memex`(比如一次性 npx),`init` 会把
|
|
135
|
-
`npx -y open-memex
|
|
136
|
-
以后 `npm i -g open-memex
|
|
140
|
+
`npx -y open-memex mcp` 写进配置,配置照样能用。
|
|
141
|
+
以后 `npm i -g open-memex` + `open-memex init --force` 可切换到更快
|
|
137
142
|
的直接调用。
|
|
138
143
|
|
|
139
144
|
### 第三步——验证
|
|
@@ -280,7 +285,7 @@ CLI 跑在 Node 22 下。从源码 checkout 使用时走内置的实验性 TypeS
|
|
|
280
285
|
|
|
281
286
|
```sh
|
|
282
287
|
open-memex mcp # 全局安装后
|
|
283
|
-
npx -y open-memex
|
|
288
|
+
npx -y open-memex mcp # 免安装
|
|
284
289
|
```
|
|
285
290
|
|
|
286
291
|
project scope 从进程工作目录解析,所以配置 server 时 cwd 要指向项目根目录
|
|
@@ -292,11 +297,11 @@ project scope 从进程工作目录解析,所以配置 server 时 cwd 要指
|
|
|
292
297
|
|
|
293
298
|
## 路线图(Roadmap)
|
|
294
299
|
|
|
295
|
-
**`0.3.0
|
|
300
|
+
**`0.3.0`(本版):** 通用 MCP server、`open-memex` bin/CLI、
|
|
296
301
|
一键 `init` 配置、中文关键词捕获(含 personal/project 路由)、
|
|
297
302
|
`config` / `capture --dry-run` / `doctor` 助手命令、Visual Studio 支持。
|
|
298
303
|
|
|
299
|
-
**Coming —— `0.
|
|
304
|
+
**Coming —— `0.4.0`:** 团队同步——用 git 做共享记忆
|
|
300
305
|
(`propose` / `promote` / `resolve` 工作流、仓库内记忆目录),
|
|
301
306
|
找 1–2 个同事做 pilot。
|
|
302
307
|
|
package/package.json
CHANGED