myagentmemory 0.5.2 → 0.5.4

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 CHANGED
@@ -11,6 +11,8 @@ agent-memory setup # one-shot: memory dir, skills, hooks, MCP, local Pro pre
11
11
 
12
12
  Then open your agent and ask *"what do you remember about me?"* — that's the wow.
13
13
 
14
+ Prefer to have an agent drive the whole thing — install, configure, verify, then show you what to do next? Feed [this onboarding doc](https://jayzeng.github.io/agentmemory/onboarding.md) to your coding agent or chat LLM and let it run the setup for you.
15
+
14
16
  [![npm version](https://img.shields.io/npm/v/myagentmemory?color=cb3837&logo=npm)](https://www.npmjs.com/package/myagentmemory)
15
17
  [![npm downloads](https://img.shields.io/npm/dm/myagentmemory?color=cb3837&logo=npm)](https://www.npmjs.com/package/myagentmemory)
16
18
  [![license](https://img.shields.io/npm/l/myagentmemory)](LICENSE)
@@ -22,7 +24,7 @@ Then open your agent and ask *"what do you remember about me?"* — that's the w
22
24
 
23
25
  - AgentMemory injects your decisions, scratchpad, and daily log at session start — no copy-paste, no re-explaining.
24
26
  - Repeated corrections become durable memory you can inspect and undo (Pro).
25
- - Every memory is a plain Markdown file you own. Memory content, session content, queries, and repository paths stay on this machine.
27
+ - Every memory is a plain Markdown file you own. AgentMemory's services do not receive memory content, session content, queries, or repository paths. Context you ask AgentMemory to return to a coding agent is then subject to that agent or model provider's data handling.
26
28
 
27
29
  AgentMemory does not provide a Python SDK, does not provide a vector database, and does not provide a knowledge graph. It is a local Markdown store with a CLI, agent skills, and optional full-text and semantic search via [qmd](https://github.com/tobi/qmd). See [product boundary](docs/product-boundary.md) for full scope.
28
30
 
@@ -34,9 +36,9 @@ AgentMemory does not provide a Python SDK, does not provide a vector database, a
34
36
 
35
37
  **Core remembers what you save. Pro learns from what you do.** Core remains free, MIT-licensed, and useful forever. Pro adds three things:
36
38
 
37
- - **Remember past sessions** — ask *"what did we decide about auth?"* across Claude Code, Codex, and Cursor.
39
+ - **Remember past sessions** — ask *"what did we decide about auth?"* across Claude Code, Codex, and Pi session history. Cursor can use AgentMemory's skills and hooks, but Cursor transcript ingestion is not currently supported.
38
40
  - **Learn from your patterns** — turn repeated corrections into memory you can inspect and undo.
39
- - **Private by default** — memory and session content index locally. Pro installation uses a pseudonymous installation identifier and bounded compatibility metadata, never your memory or session content.
41
+ - **Private by default** — memory and session content index locally. AgentMemory's services receive only a pseudonymous installation identifier and bounded compatibility metadata, never your memory or session content. Recall results provided locally to a coding agent are subject to that agent or model provider's data handling.
40
42
 
41
43
  Preview what Pro would find in your existing sessions *before* installing anything:
42
44
 
@@ -48,7 +50,7 @@ agent-memory learn
48
50
  agent-memory dashboard
49
51
  ```
50
52
 
51
- Pre-install preview: up to 50 local sessions per day. Free installed preview: 20 recalls + 5 learning scans per local day. Memory, session, query, and repository content stay on your machine; installation sends only a pseudonymous identifier and bounded compatibility metadata. Full detail on [privacy, signing, and installation](docs/official-plugin-bootstrap.md).
53
+ Pre-install preview: up to 50 local sessions per day. Free installed preview: 20 recalls + 5 learning scans per local day. AgentMemory's services do not receive memory, session, query, or repository content; installation sends only a pseudonymous identifier and bounded compatibility metadata. Recall results provided locally to a coding agent are subject to that agent or model provider's data handling. Full detail on [privacy, signing, and installation](docs/official-plugin-bootstrap.md).
52
54
 
53
55
  ## Installation
54
56
 
@@ -57,7 +59,7 @@ Pre-install preview: up to 50 local sessions per day. Free installed preview: 20
57
59
  brew tap jayzeng/agentmemory https://github.com/jayzeng/agentmemory
58
60
  brew install jayzeng/agentmemory/agent-memory
59
61
 
60
- # Install the portable CLI globally (Node.js 20+; macOS, Linux, or Windows)
62
+ # Install the portable Core CLI globally (Node.js 20+; Pro session recall requires Node.js 22.13+)
61
63
  npm install -g myagentmemory
62
64
 
63
65
  # If corporate TLS inspection requires a private CA, use your organization's CA file:
@@ -88,9 +90,9 @@ The npm package installs a platform-neutral Node.js executable. The optional Hom
88
90
  - `%USERPROFILE%\.cursor\skills\agent-memory\SKILL.md` — Cursor skill (Windows)
89
91
  - `%USERPROFILE%\.agents\skills\agent-memory\SKILL.md` — Agent CLI skill (Windows)
90
92
 
91
- ### Pi users
93
+ ### Pi
92
94
 
93
- If you're on Pi and prefer a native extension, use `pi-memory` (https://github.com/jayzeng/pi-memory) instead of installing this skill. The CLI + skill workflow here is the cross-platform alternative, and works fine on Pi without any extension.
95
+ Pi doesn't use SKILL.md or a JSON hook config — its extensibility model is a registered native extension. So instead of writing a skill file, `agent-memory setup`/`install-hooks` detects `pi` on your `PATH` and installs [`pi-memory`](https://github.com/jayzeng/pi-memory) for you, via `pi install npm:pi-memory` — same author, same memory-file conventions, native pi tools (`memory_write`, `memory_read`, `scratchpad`, `memory_search`). It's prompted for like any other detected agent and auto-applied under `--yes`; run `agent-memory install-hooks --only pi` to target just pi, or check `agent-memory doctor` for its status.
94
96
 
95
97
  ### Optional: Enable search with qmd
96
98
 
@@ -171,6 +173,7 @@ Run `agent-memory help` for the full generated list, or `agent-memory <command>
171
173
  | `agent-memory completion [bash\|zsh\|fish\|powershell] [--stdout]` | Install or print shell completion |
172
174
  | `agent-memory install-hooks [--yes] [--all] [--only <agents>] [--mode stable\|per-turn]` | Install managed context and memory-write reminder hooks |
173
175
  | `agent-memory uninstall-hooks [--only <agents>]` | Remove only hooks managed by AgentMemory |
176
+ | `agent-memory uninstall [--data] [--yes]` | Remove hooks, skills, MCP registrations, completions, and the Pro plugin; `--data` also deletes MEMORY.md, daily logs, scratchpad, and topics |
174
177
  | `agent-memory init [--yes] [--skip-skills] [--skip-hooks]` | Legacy interactive wizard; `setup` runs this as its first step |
175
178
  | `agent-memory status [--probe]` | Show config, qmd status, file counts, embedding health |
176
179
  | `agent-memory doctor` | One-shot health check across memory, qmd, skills, hooks, and Pro |
@@ -6,7 +6,7 @@ export interface CliOptionSpec {
6
6
  kind: CliValueKind;
7
7
  };
8
8
  }
9
- export declare const COMMANDS: readonly ["context", "save", "note", "write", "read", "scratchpad", "search", "distil", "sync", "setup", "status", "doctor", "tutorial", "install-skills", "uninstall-skills", "install-hooks", "uninstall-hooks", "completion", "pro", "recall", "learn", "dashboard", "plugin", "serve", "upgrade", "version", "help"];
9
+ export declare const COMMANDS: readonly ["context", "save", "note", "write", "read", "scratchpad", "search", "distil", "sync", "setup", "status", "doctor", "tutorial", "install-skills", "uninstall-skills", "install-hooks", "uninstall-hooks", "uninstall", "completion", "pro", "recall", "learn", "dashboard", "plugin", "serve", "upgrade", "version", "help"];
10
10
  export declare const PLUGIN_COMMANDS: readonly ["list", "status", "install", "update", "uninstall", "manage"];
11
11
  export declare const WORKER_ACTIONS: readonly [];
12
12
  export declare const SCRATCHPAD_ACTIONS: readonly ["add", "done", "undo", "clear_done", "list"];
package/dist/cli-spec.js CHANGED
@@ -16,6 +16,7 @@ export const COMMANDS = [
16
16
  "uninstall-skills",
17
17
  "install-hooks",
18
18
  "uninstall-hooks",
19
+ "uninstall",
19
20
  "completion",
20
21
  "pro",
21
22
  "recall",
@@ -48,6 +49,7 @@ export const COMMAND_DESCRIPTIONS = {
48
49
  "uninstall-skills": "remove core instructions from detected agents",
49
50
  "install-hooks": "install managed context and memory-write reminder hooks",
50
51
  "uninstall-hooks": "remove only hooks managed by agent-memory",
52
+ uninstall: "remove hooks, skills, MCP registrations, completions, and the Pro plugin; add --data to also delete memory data",
51
53
  completion: "install or print Bash, Zsh, Fish, or PowerShell completion",
52
54
  pro: "install, inspect, or upgrade AgentMemory Pro",
53
55
  recall: "recall decisions and context from prior coding sessions with Pro",
@@ -55,7 +57,7 @@ export const COMMAND_DESCRIPTIONS = {
55
57
  dashboard: "open the private local Memory Dashboard",
56
58
  plugin: "discover, install, update, or remove optional official plugins",
57
59
  serve: "run as a Model Context Protocol (MCP) server over stdio",
58
- upgrade: "check for and install newer agent-memory CLI and Pro plugin releases",
60
+ upgrade: "check for, and auto-install by default, newer agent-memory CLI and Pro plugin releases",
59
61
  version: "print the installed agent-memory version",
60
62
  help: "show this command overview",
61
63
  };
@@ -65,7 +67,7 @@ export const PLUGIN_COMMAND_DESCRIPTIONS = {
65
67
  install: "authenticate if needed, then install or upgrade the official bundle",
66
68
  update: "upgrade an existing official bundle when a compatible release exists",
67
69
  uninstall: "remove official plugin executables while preserving user data",
68
- manage: "open the AgentMemory account and billing website",
70
+ manage: "open account management when that future service is available",
69
71
  };
70
72
  export const WORKER_ACTION_DESCRIPTIONS = {};
71
73
  export const SCRATCHPAD_ACTION_DESCRIPTIONS = {
@@ -95,6 +97,7 @@ export const COMMAND_OPTIONS = {
95
97
  "uninstall-skills": [],
96
98
  "install-hooks": ["--yes", "--all", "--only", "--mode"],
97
99
  "uninstall-hooks": ["--only"],
100
+ uninstall: ["--data", "--yes"],
98
101
  completion: ["--stdout"],
99
102
  pro: [],
100
103
  recall: [
@@ -111,7 +114,7 @@ export const COMMAND_OPTIONS = {
111
114
  learn: ["--preview"],
112
115
  dashboard: ["--no-browser"],
113
116
  serve: ["--mcp", "--register", "--only"],
114
- upgrade: ["--check", "--refresh", "--yes", "--quiet", "--cli", "--plugin"],
117
+ upgrade: ["--check", "--refresh", "--yes", "--quiet", "--cli", "--plugin", "--background"],
115
118
  version: [],
116
119
  help: [],
117
120
  };
@@ -272,6 +275,7 @@ export const OPTION_SPECS = {
272
275
  "--agent": { description: "internal SessionStart host key", value: { label: "agent", kind: "value" } },
273
276
  "--token": { description: "internal session-worker lease token", value: { label: "token", kind: "value" } },
274
277
  "--uninstall": { description: "use install-skills compatibility uninstall mode" },
278
+ "--data": { description: "uninstall: also permanently delete the memory directory and plugin state" },
275
279
  "--mcp": { description: "serve as an MCP server over stdio (used by Claude Code)" },
276
280
  "--register": { description: "register the MCP server in detected supported agents and exit" },
277
281
  "--check": { description: "upgrade: report available updates without installing" },
@@ -279,6 +283,9 @@ export const OPTION_SPECS = {
279
283
  "--quiet": { description: "upgrade: suppress non-error output (used by the passive session-start refresh)" },
280
284
  "--cli": { description: "upgrade: limit action to the CLI binary" },
281
285
  "--plugin": { description: "upgrade: limit action to the Pro plugin bundle" },
286
+ "--background": {
287
+ description: "upgrade: non-interactive; installs only targets whose policy is 'auto' (see: agent-memory upgrade policy)",
288
+ },
282
289
  };
283
290
  export const SHELL_DESCRIPTIONS = {
284
291
  bash: "generate or install Bash completion",
@@ -312,13 +319,14 @@ const COMMAND_USAGE = {
312
319
  "uninstall-skills": "agent-memory uninstall-skills [--json]",
313
320
  "install-hooks": "agent-memory install-hooks [--yes] [--all] [--only claude,codex,cursor] [--mode stable|per-turn] [--json]",
314
321
  "uninstall-hooks": "agent-memory uninstall-hooks [--only claude,codex,cursor] [--json]",
322
+ uninstall: "agent-memory uninstall [--data] [--yes] [--json]",
315
323
  completion: "agent-memory completion [bash|zsh|fish|powershell] [--stdout]",
316
324
  pro: "agent-memory pro <install|status|upgrade> [--channel stable] [--yes]",
317
325
  recall: 'agent-memory recall "<query>" [--limit N] [--context N] [--scope current|global] [--cwd <path>] [--json]\n Multi-query: agent-memory recall --queries \'["q1","q2","q3"]\' [--sessions N] [--events N]',
318
326
  learn: "agent-memory learn [--preview] [--json]",
319
327
  dashboard: "agent-memory dashboard [--no-browser]",
320
328
  plugin: "agent-memory plugin <list|status|install|update|uninstall|manage> [--channel stable] [--yes] [--no-browser]",
321
- upgrade: "agent-memory upgrade [--check] [--yes] [--cli|--plugin] [--refresh] [--json]",
329
+ upgrade: "agent-memory upgrade [--check] [--yes] [--cli|--plugin] [--refresh] [--json]\n agent-memory upgrade policy [off|notify|auto] [--cli|--plugin] [--json] (default: auto for both)",
322
330
  version: "agent-memory version",
323
331
  help: "agent-memory help [<command>]",
324
332
  };
@@ -356,6 +364,10 @@ const COMMAND_EXAMPLES = {
356
364
  status: ["agent-memory status", "agent-memory status --json"],
357
365
  init: ["agent-memory init", "agent-memory init --yes --skip-hooks"],
358
366
  setup: ["agent-memory setup", "agent-memory setup --json"],
367
+ uninstall: [
368
+ "agent-memory uninstall --yes # removes hooks, skills, MCP registrations, completions, Pro plugin",
369
+ "agent-memory uninstall --data --yes # also deletes MEMORY.md, daily logs, scratchpad, topics",
370
+ ],
359
371
  "install-hooks": [
360
372
  "agent-memory install-hooks",
361
373
  "agent-memory install-hooks --yes",