open-memex 0.5.1 → 0.6.0-alpha.10

package/AGENTS.md

@@ -64,13 +64,34 @@ previews keyword capture without writing, `open-memex doctor` runs health checks
 (node version, config, scope resolution, storage writability, VS Code MCP enablement, MCP handshake).
 `open-memex init` with no --client auto-detects and wires every installed editor
 (`--yes` skips, scripts never prompt); `open-memex config set <key> <value>` edits settings after install.
+`npm install -g` prints a pointer to `open-memex init` via a postinstall script
+(print-only — postinstall must never prompt, it runs in CI/Docker; D50).
+Note: npm swallows lifecycle-script stdout (background run unless
+`--foreground-scripts`), so the postinstall pointer is best-effort only —
+every CLI entry point also prints a one-line stderr nudge until init has run
+or been declined (F28; stderr keeps the MCP stdio protocol intact).
+Bare `open-memex` on a machine where init never completed offers to run it on a
+TTY (usage as before when non-interactive); init/uninstall maintain a
+`.init.json` first-run marker at the data root so the offer is asked once (D50);
+init ends with a one-line next-step hint (`open-memex add` + ask the agent to
+recall it) so a first-time user sees what "it works" looks like (D51).
+init also installs the bundled `open-memex` Agent Skill (skills/open-memex/SKILL.md,
+teaches skill-aware agents the CLI: save/search/scope rules/outbox flow) into each
+wired editor's user-level skills dir — ~/.copilot/skills/ (VS Code),
+~/.cursor/skills/ (Cursor), ~/.config/opencode/skills/ (opencode, per-project MCP
+mode only — with the native plugin the skill is skipped and any previously installed
+one is removed, D55); Visual Studio
+has no skills concept and is skipped. Copy, not symlink (Windows needs no
+Developer Mode); existing skill kept unless --force (D54).
 `open-memex uninstall [--client vscode|cursor|opencode|visualstudio] [--global] [--yes]`
 reverses init — removes the MCP server entry / opencode plugin line / Copilot
-instructions section; memory data never touched (D48); no --client → auto-detect
+instructions section / Agent Skill directory; memory data never touched (D48); no --client → auto-detect
 with an interactive confirm, explicit --client never prompts; `--yes` only skips
 that confirm; `--global` limits cleanup to user-level. Empty/whitespace-only
 config files parse as `{}` and are safely populated (D49); non-JSON (JSONC)
-files are left untouched with a printed manual snippet (D47).
+files are left untouched with a printed manual snippet (D47). init/uninstall also sweep
+pre-rename `my-o-memory` plugin entries and MCP server keys wherever they touch a
+config, and `open-memex doctor` reports any remaining pre-rename leftovers (F30).
 The published `open-memex` bin points at `dist/cli.js` (compiled at publish time).
 From a source checkout, `npm run cli` / `npm run mcp` still run `src/` directly
 with type-stripping — no build step needed for development.

package/README.md

@@ -113,6 +113,12 @@ This installs the `0.5.1` stable release.
 npm install -g open-memex@alpha
 ```
 
+```sh
+open-memex init
+```
+
+The install isn't complete until you run `open-memex init` — it wires up your editors (VS Code, Cursor, opencode, and Visual Studio for solution projects).
+
 See what's published:
 
 ```sh
@@ -180,7 +186,10 @@ npx -y open-memex init --yes
 With no `--client`, `init` **detects your installed editors and wires them all**
 — user-level where the editor supports it (VS Code / Cursor MCP config, opencode
 native plugin), so one init covers every project. Visual Studio joins in when the
-project has a solution file. Prefer to pick a single editor? Pass `--client`:
+project has a solution file. It also installs an **Agent Skill** (`open-memex`)
+into each editor's skills folder (not opencode when the native plugin is wired —
+the plugin already provides memory tools), so skill-aware agents can use your memory via
+the CLI with no MCP configuration. Prefer to pick a single editor? Pass `--client`:
 
 > **Two different "globals" — don't mix them up.**
 > - `npm install -g open-memex` installs the *package* globally: it puts the
@@ -189,6 +198,14 @@ project has a solution file. Prefer to pick a single editor? Pass `--client`:
 >   project: init once, the wiring works in every project. It works the same
 >   whether the package was installed globally or run via npx.
 
+Installing the package also prints a reminder to run `open-memex init` — the
+wiring is a separate step. And if you run bare `open-memex` on a machine where
+init never completed, it offers to run it for you (only on an interactive
+terminal; scripts and CI just see the usual usage text). When init finishes,
+it prints one concrete next step — save a memory with `open-memex add`, then
+ask your agent to recall it — so a first-time user sees what "it works" looks
+like.
+
 **VS Code** (Copilot):
 
 ```sh
@@ -508,8 +525,9 @@ branches and PRs. Nothing moves without you naming it.
 
 In an AI chat with the MCP server connected, just say **"sync memory"**
 (or "同步记忆") — the agent runs the status check, summarizes the outbox drafts,
-and asks which ones to sync. The agent also proposes this on its own at session
-start and at work checkpoints.
+and asks which ones to sync. The server also tells the agent on its own: at
+session start the handshake reports how many drafts are waiting, and every
+memory-changing tool result carries the current count when it is non-zero.
 
 ```sh
 open-memex sync-status
@@ -563,8 +581,8 @@ open-memex distill-agents [--scope project|personal] [--type t1,t2] [--limit N]
 # (decisions, constraints, lessons, gotchas, howtos). Prints markdown;
 # -o writes it to a file. You review and merge by hand — open-memex
 # never rewrites your AGENTS.md on its own. The snippet ends with a
-# "memory hygiene" section (§3.5 checkpoint guidance) so agents reading
-# AGENTS.md learn to propose distilled captures at checkpoints.
+# "memory hygiene" section (§3.5 distillation guidance) so agents reading
+# AGENTS.md learn to propose distilled captures when a task ends.
 
 open-memex propose <id...> --to project [--local-approve]
 # propose one or several personal memories at once (one branch, one PR);
@@ -619,8 +637,9 @@ server with cwd set to your project root (`init` handles this for you).
 > **Note:** MCP is request/response — it gives the agent tools, not the opencode
 > plugin's automatic keyword capture or first-turn context injection. Proactive
 > memory use depends on the agent's instructions: the server sends session-start
-> guidance (call `memory_status` at session start and at checkpoints) in the MCP
-> handshake `instructions`, and `init` writes the fuller version into the
+> guidance in the MCP handshake `instructions` (including the live outbox draft
+> count at session start, plus the pending count appended to memory-changing
+> tool results when non-zero), and `init` writes the fuller version into the
 > editor's instruction files. Both are advisory — no MCP consumer offers a hard
 > session-start hook.
 
@@ -636,8 +655,8 @@ outbox → `sync-status` → `submit` (local branch+commit, push/PR on your Yes)
 `export` / `import` archive for user portability (Markdown + manifest, no walled
 garden; private excluded by default, `-a` / `--all` for full migration);
 distill-to-AGENTS.md assist (`distill-agents`, propose-only — you merge by hand);
-§3.5 checkpoint distillation in the MCP handshake + init instructions (the agent
-proposes 1–3 captures at checkpoints, the human decides); 1–2 colleague pilot.
+§3.5 distillation in the MCP handshake + init instructions (the agent proposes
+1–3 captures when a task ends, the human decides); 1–2 colleague pilot.
 
 **`0.5.0` (stable):** init UX pass — `init --global` writes the editor wiring
 once at user level (D45); bare `init` auto-detects installed editors and wires

package/README.zh-CN.md

@@ -108,6 +108,12 @@ npm install -g open-memex
 npm install -g open-memex@alpha
 ```
 
+```sh
+open-memex init
+```
+
+不跑 `open-memex init` 把编辑器接上，安装就不算完成（支持 VS Code、Cursor、opencode，有 .sln 的项目还支持 Visual Studio）。
+
 查看已发布版本：
 
 ```sh
@@ -173,6 +179,9 @@ npx -y open-memex init --yes
 不带 `--client` 时，`init` 会**自动检测本机装了哪些编辑器，一次全接上**——
 支持用户级的编辑器走用户级（VS Code / Cursor 的 MCP 配置、opencode 原生插件），
 一次 init，所有项目通用；项目里有 solution 文件时 Visual Studio 也会一起配。
+同时会给每个编辑器装一个 **Agent Skill**（`open-memex`，opencode 用原生插件时除外——
+插件已经提供了记忆工具），懂 skill 的 agent
+不用配 MCP 也能通过 CLI 用你的记忆。
 想只配某一个编辑器？加 `--client`：
 
 > **两个"全局"不是一回事，别搞混。**
@@ -181,6 +190,12 @@ npx -y open-memex init --yes
 > - `init --global` 是把*编辑器配置*写到用户级而不是项目里：init 一次，
 >   每个项目都生效。不管包是全局安装的还是用 npx 临时跑的，效果一样。
 
+装完包还会打印一句提醒，让你跑 `open-memex init`——接线是独立的一步。
+如果你在从没跑过 init 的机器上直接敲 `open-memex`，它会问你要不要现在
+init（只在交互终端里问；脚本和 CI 里看到的还是原来的 usage）。
+init 跑完会打印一个具体的下一步——用 `open-memex add` 存一条记忆，再让
+agent 回忆它——让第一次用的用户一眼看到"跑起来了"是什么样子。
+
 **VS Code**（Copilot）：
 
 ```sh
@@ -482,8 +497,8 @@ project 草稿先住在 **appdata outbox**（git 看不见、跟分支无关）
 没经过你点名，什么都不会动。
 
 在接了 MCP 服务器的 AI 对话里，直接说 **"同步记忆"**（或 "sync memory"）——
-agent 会查状态、把 outbox 草稿逐条摘要、问你同步哪几条。agent 也会在新对话
-开始和任务检查点主动提这件事。
+agent 会查状态、把 outbox 草稿逐条摘要、问你同步哪几条。服务器也会主动告诉
+agent：新对话开始时握手里带待审草稿数，每次改记忆的 tool 返回里也带当前数（为零时不带）。
 
 ```sh
 open-memex sync-status
@@ -530,7 +545,7 @@ open-memex distill-agents [--scope project|personal] [--type t1,t2] [--limit N]
 # 把项目记忆（decision/constraint/lesson/gotcha/howto）提炼成
 # AGENTS.md 片段。默认打印到 stdout；-o 写文件。人工审阅后手工合并——
 # open-memex 永不自动改写你的 AGENTS.md。片段末尾带一段"记忆卫生"
-# （§3.5 检查点指引），让读 AGENTS.md 的 agent 学会在检查点提议蒸馏捕获。
+# （§3.5 蒸馏指引），让读 AGENTS.md 的 agent 学会在任务结束时提议蒸馏捕获。
 
 open-memex propose <id...> --to project [--local-approve]
 # 一次 propose 一条或多条（一个分支、一个 PR），每条独立新 id。
@@ -582,9 +597,9 @@ project scope 从进程工作目录解析，所以配置 server 时 cwd 要指
 > **注意：** MCP 是请求/响应式的——它给 agent 提供 tools，但没有 opencode
 > 插件的关键词自动捕获和首轮上下文注入。想让 agent 主动用记忆，
 > 靠的是 agent 的 instructions：服务器在 MCP 握手的 `instructions` 里自带
-> session-start 指引（开场调 `memory_status`、检查点再调），`init` 则把更完整
-> 的版本写进编辑器的 instruction 文件。两者都是建议性的——MCP 客户端没有
-> 强制的 session-start hook。
+> session-start 指引（含开场时的 outbox 待审草稿数；改记忆的 tool 返回里也会
+> 带当前数，为零时不带），`init` 则把更完整的版本写进编辑器的 instruction
+> 文件。两者都是建议性的——MCP 客户端没有强制的 session-start hook。
 
 ## 路线图（Roadmap）
 
@@ -598,8 +613,8 @@ project scope 从进程工作目录解析，所以配置 server 时 cwd 要指
 `export` / `import` 归档做用户可携带（Markdown + manifest，不造围墙花园；
 private 默认不导出，`-a` / `--all` 全量迁移）；
 distill-to-AGENTS.md 辅助（`distill-agents`，只提议不改写——人工合并）；
-§3.5 检查点蒸馏写进 MCP 握手指令和 init 指令文件
-（agent 在检查点提议 1–3 条捕获，人来定）；找 1–2 个同事做 pilot。
+§3.5 蒸馏写进 MCP 握手指令和 init 指令文件
+（agent 在任务结束时提议 1–3 条捕获，人来定）；找 1–2 个同事做 pilot。
 
 **`0.5.0`（稳定版）：** init 体验整修——`init --global` 一次写好用户级编辑器接线（D45）；裸 `init` 自动检测已装编辑器并一次全接上（D46）；非标准 JSON 配置不再报错，而是原样保留并打印手贴片段（D47）；`uninstall` 逆转 `init` 且永不碰记忆数据（D48）；空配置文件按空白处理、不再误判为损坏（D49）。"一份记忆，所有 Agent 通用"：同一台机器上的每个编辑器，经由同一个 MCP 接口读写同一份记忆。
 

package/dist/cli.js

@@ -496,7 +496,42 @@ function printMcpConfig(client) {
 }
 async function main() {
     const [cmd, ...rest] = process.argv.slice(2);
-    if (!cmd || cmd === "--help" || cmd === "-h" || cmd === "help")
+    if (!cmd) {
+        // D50: fresh machine + interactive terminal → offer init instead of bare usage.
+        // Non-interactive (CI/scripts/pipes) prints usage exactly as before.
+        const { offerFirstRunInit } = await import("./first-run.js");
+        const outcome = await offerFirstRunInit(async () => {
+            // Re-exec `open-memex init` as a child with inherited stdio instead of
+            // calling initProject() in-process: the offer's readline already
+            // consumed stdin's buffer, and a second readline on the same stream
+            // would see EOF on burst input instead of the user's next answers.
+            const { spawnSync } = await import("node:child_process");
+            const r = spawnSync(process.execPath, [...process.execArgv, fileURLToPath(import.meta.url), "init"], { stdio: "inherit" });
+            if (r.error)
+                throw r.error;
+            if ((r.status ?? 1) !== 0)
+                process.exit(r.status ?? 1);
+        });
+        if (outcome !== "initialized")
+            usage(0);
+        return;
+    }
+    // F28: npm runs lifecycle scripts in the background and swallows their
+    // stdout (unless --foreground-scripts), so the D50 postinstall pointer
+    // never reaches the user. Every CLI entry point therefore carries a
+    // one-line nudge on stderr until init has run or been declined — stderr
+    // keeps the MCP stdio protocol (stdout) intact, and the .init.json marker
+    // makes it once-ever. `init`/`uninstall` are excluded (already there /
+    // nothing to wire). Placed before the --help/--version early returns:
+    // `-v` is the first thing people run after installing.
+    if (cmd !== "init" && cmd !== "uninstall") {
+        const { isFirstRun } = await import("./first-run.js");
+        if (isFirstRun()) {
+            console.error("open-memex: first run? `open-memex init` wires it into your editors " +
+                "(auto-detects VS Code, Cursor, opencode — and Visual Studio for solution projects).");
+        }
+    }
+    if (cmd === "--help" || cmd === "-h" || cmd === "help")
         usage(0);
     if (cmd === "--version" || cmd === "-v") {
         // package.json sits two levels above this file in both layouts

package/dist/distill-agents.js

@@ -53,10 +53,11 @@ export function distillAgentsMarkdown(opts) {
     }
     // D43 — §3.5 memory-hygiene footer (double insurance for opencode users,
     // who never see the MCP handshake / init instructions): teach the agent
-    // reading this AGENTS.md to propose distilled captures at checkpoints.
+    // reading this AGENTS.md to propose distilled captures when a task ends
+    // (D53: the checkpoint mechanism is gone).
     lines.push(`### Memory hygiene (open-memex)`);
     lines.push(``);
-    lines.push(`- At checkpoints (session start, end of a work chunk, after the user commits),`, `  distill the session: propose 1–3 short memories capturing the useful`, `  conclusion — what was learned or decided, how an issue was resolved, what`, `  to avoid, where the authoritative doc lives — not the raw transcript.`, `  Save nothing without user approval.`, `- If the knowledge already lives in project docs, save a \`reference\` memory`, `  pointing at the doc instead of copying it.`);
+    lines.push(`- When you finish a task the user would describe in one sentence, distill`, `  the session: propose 1–3 short memories capturing the useful`, `  conclusion — what was learned or decided, how an issue was resolved, what`, `  to avoid, where the authoritative doc lives — not the raw transcript.`, `  Save nothing without user approval.`, `- If the knowledge already lives in project docs, save a \`reference\` memory`, `  pointing at the doc instead of copying it.`);
     lines.push(``);
     return lines.join("\n");
 }

package/dist/doctor.js

@@ -10,6 +10,7 @@ import { fileURLToPath } from "node:url";
 import { loadConfig, configSource, DEFAULT_CONFIG } from "./config.js";
 import { paths } from "./paths.js";
 import { resolveCwdScope } from "./scope.js";
+import { LEGACY_PACKAGE_NAME, opencodeGlobalConfigPath, userMcpConfigPath } from "./init.js";
 const EXPECTED_TOOLS = [
     "memory_add",
     "memory_search",
@@ -278,6 +279,7 @@ export async function runDoctor() {
     console.log("open-memex doctor");
     const checks = [nodeCheck(), configCheck(), scopeCheck(), storageCheck(), vscodeMcpCheck()];
     checks.push(await mcpCheck());
+    checks.push(legacyCheck());
     let allOk = true;
     for (const c of checks) {
         console.log(`  ${c.ok ? "ok  " : "FAIL"} ${c.name}: ${c.detail}`);
@@ -287,3 +289,31 @@ export async function runDoctor() {
     console.log(allOk ? "All checks passed." : "Some checks failed — see above.");
     return allOk;
 }
+/**
+ * F30: the my-o-memory → open-memex rename left configs and data behind that
+ * silently split memories across two data dirs (the exact trap: the old
+ * opencode plugin kept loading and writing to the OLD dir). Read-only.
+ */
+function legacyCheck() {
+    const name = "legacy my-o-memory";
+    const found = [];
+    const envHome = process.env.MY_O_MEMORY_HOME;
+    if (envHome && envHome.includes(LEGACY_PACKAGE_NAME))
+        found.push(`MY_O_MEMORY_HOME points at a pre-rename dir (${envHome}) — unset it, then merge old data with \`open-memex migrate --to-v2\``);
+    const root = paths().root;
+    const legacyDir = path.join(path.dirname(root), LEGACY_PACKAGE_NAME);
+    if (fs.existsSync(legacyDir) && fs.statSync(legacyDir).isDirectory())
+        found.push(`legacy data dir ${legacyDir} — merge it with \`open-memex migrate --to-v2\``);
+    for (const f of [opencodeGlobalConfigPath(), userMcpConfigPath("vscode"), userMcpConfigPath("cursor")]) {
+        try {
+            if (fs.existsSync(f) && fs.readFileSync(f, "utf8").includes(LEGACY_PACKAGE_NAME))
+                found.push(`stale "${LEGACY_PACKAGE_NAME}" reference in ${f} — re-run \`open-memex init --force --yes\``);
+        }
+        catch {
+            /* unreadable — not this check's problem */
+        }
+    }
+    return found.length === 0
+        ? { name, ok: true, detail: "no pre-rename leftovers found" }
+        : { name, ok: false, detail: found.join("; ") };
+}

package/dist/first-run.js

@@ -0,0 +1,75 @@
+/**
+ * D50: first-run init offer. `npm install -g open-memex` only puts the CLI on
+ * PATH — the editor wiring is `init`'s job, and a clean reinstall wipes it.
+ * When bare `open-memex` runs on a machine where init never completed, offer
+ * to run it instead of just printing usage.
+ *
+ * The "asked" state is a marker file at the data root (`init` writes it on
+ * success, a declined offer writes it too), so the question is asked exactly
+ * once. `uninstall` removes it — unwiring is the reverse of init, so the next
+ * bare run offers to wire again. The marker is a dotfile: export builds from
+ * DB rows, never by walking the data root, so it can't leak into bundles.
+ */
+import fs from "node:fs";
+import path from "node:path";
+import readline from "node:readline";
+import { dataRootPath } from "./paths.js";
+const MARKER = ".init.json";
+export function firstRunMarkerPath(root = dataRootPath()) {
+    return path.join(root, MARKER);
+}
+/** True when init has neither run nor been declined on this machine. */
+export function isFirstRun(root) {
+    return !fs.existsSync(firstRunMarkerPath(root ?? dataRootPath()));
+}
+/** Record the outcome — best effort; a missing marker just asks again next time. */
+export function markFirstRunDone(state) {
+    const file = firstRunMarkerPath();
+    try {
+        fs.mkdirSync(path.dirname(file), { recursive: true });
+        fs.writeFileSync(file, JSON.stringify({ v: 1, state, at: new Date().toISOString() }) + "\n");
+    }
+    catch {
+        /* ignore */
+    }
+}
+export function clearFirstRunMarker() {
+    try {
+        fs.rmSync(firstRunMarkerPath(), { force: true });
+    }
+    catch {
+        /* ignore */
+    }
+}
+/** Pure decision, kept separate for tests: prompt only on an interactive
+ *  terminal — scripts, CI and piped runs never get the question. */
+export function shouldOfferFirstRun(tty = { stdinTTY: process.stdin.isTTY, stdoutTTY: process.stdout.isTTY }, firstRun = isFirstRun()) {
+    return firstRun && !!tty.stdinTTY && !!tty.stdoutTTY;
+}
+function askYesNo(question) {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    return new Promise((resolve) => {
+        rl.question(question, (ans) => {
+            rl.close();
+            resolve(!/^\s*(n|no)\s*$/i.test(ans));
+        });
+    });
+}
+/**
+ * Bare-`open-memex` first-run flow. `runInit` is injected so tests don't need
+ * the real init. Returns "skipped" when there's nothing to ask (already set
+ * up, or non-interactive) — the caller then prints usage as before.
+ */
+export async function offerFirstRunInit(runInit) {
+    if (!shouldOfferFirstRun())
+        return "skipped";
+    console.log(`It looks like open-memex hasn't been set up on this machine yet.\n` +
+        "`open-memex init` wires it into your editors (auto-detects VS Code, Cursor and opencode — and Visual Studio for solution projects).\n");
+    if (await askYesNo("Run it now? [Y/n] ")) {
+        await runInit();
+        return "initialized";
+    }
+    markFirstRunDone("declined");
+    console.log("No problem — run `open-memex init` any time.");
+    return "declined";
+}