myagentmemory 0.4.13 → 0.4.15

package/README.md

@@ -1,29 +1,36 @@
-# agent-memory
+# AgentMemory
 
-**Persistent memory for AI coding agents.** Give [Claude Code](https://claude.ai/code), [OpenAI Codex](https://github.com/openai/codex), [Cursor](https://cursor.com), and Agent (Cursor CLI) a memory that survives across sessions — long-term facts, daily logs, topic notes, and a scratchpad checklist, stored as plain markdown and searchable with [qmd](https://github.com/tobi/qmd)-powered semantic search.
+**Memory that survives the agent.** AgentMemory is a local, user-owned state layer for [Claude Code](https://claude.ai/code), [OpenAI Codex](https://github.com/openai/codex), [Cursor](https://cursor.com), and Agent (Cursor CLI). Keep scratch work, daily evidence, topic notes, and durable decisions as plain Markdown, then retrieve what matters with optional [qmd](https://github.com/tobi/qmd) search.
 
 [![npm version](https://img.shields.io/npm/v/myagentmemory?color=cb3837&logo=npm)](https://www.npmjs.com/package/myagentmemory)
 [![npm downloads](https://img.shields.io/npm/dm/myagentmemory?color=cb3837&logo=npm)](https://www.npmjs.com/package/myagentmemory)
 [![license](https://img.shields.io/npm/l/myagentmemory)](LICENSE)
 [![website](https://img.shields.io/badge/website-jayzeng.github.io%2Fagentmemory-0d9b7a)](https://jayzeng.github.io/agentmemory/)
 
-[Website and quickstart](https://jayzeng.github.io/agentmemory/) · [Install](#installation) · [CLI commands](#cli-commands) · [How it works](#how-it-works)
+[Website and quickstart](https://jayzeng.github.io/agentmemory/) · [Field report: lessons from 1,000+ coding-agent sessions](https://www.jayzeng.com/writing/agentmemory-field-report/) · [Install](#installation) · [CLI commands](#cli-commands) · [How it works](#how-it-works)
 
-## Why agent-memory?
+> **Field report:** “A session records what the agent did. Memory is a judgment about what the next agent should know.” Read [What 1000+ coding agent sessions taught me about LLM memory](https://www.jayzeng.com/writing/agentmemory-field-report/).
 
-Coding agents forget everything between sessions. `agent-memory` gives them a durable, local-first memory so they stop re-learning your stack, your preferences, and past decisions on every run.
+## Why AgentMemory?
 
-- **Persistent project memory** — decisions, preferences, and project context carry across sessions instead of starting cold.
-- **Plain Markdown, local-first** — every memory is a readable, git-friendly file on disk. No database, cloud service, or lock-in.
-- **Optional semantic search** — [qmd](https://github.com/tobi/qmd) adds keyword, semantic, and hybrid search across memory files.
-- **Explicit retrieval** — skills load base context at session start and search for related memories when a task needs them.
-- **Shared across agents** — Claude Code, Codex, Cursor, and Agent can use the same store.
+Coding-agent sessions preserve activity. They do not decide which facts, decisions, and follow-ups should remain useful tomorrow. AgentMemory gives that accumulated state explicit lifetimes, a user-controlled home, and a path back into future work.
+
+- **Different lifetimes and scopes** — route short-lived follow-ups, chronological evidence, continuing topics, and durable decisions to the right destination.
+- **Curated continuity** — retain judgments that should affect future work instead of warehousing every transcript and abandoned path.
+- **Plain Markdown, local-first** — read, edit, diff, back up, or delete every memory. No database, cloud service, or lock-in.
+- **Optional retrieval** — skills load base context at session start and search related memories explicitly when a task needs them; qmd adds keyword, semantic, and hybrid search.
+- **Shared across agents** — Claude Code, Codex, Cursor, and Agent can use the same store even as models and harnesses change.
+- **Correctable state** — provenance, temporal status, secret screening, supersession, and forgetting help keep retained memory aligned with reality.
 
 > **Naming:** `agentmemory` is the GitHub repo (and Homebrew tap), `myagentmemory` is the npm package, and `agent-memory` is the installed CLI binary. Also known as *coding agent memory* or *AI coding memory*.
 
 ### Product boundary
 
-AgentMemory is a local Markdown store with a CLI, optional qmd search, and agent skills. It is not a Python SDK, vector database, or knowledge graph. The Markdown files remain the source of truth.
+AgentMemory is free, open-source software under the MIT License. The core is a local Markdown store with a CLI, optional qmd search, and agent skills, and it remains fully usable without an account or commercial plugin. It does not automatically import every vendor transcript or silently decide what becomes durable. It is not a Python SDK, vector database, or knowledge graph. The Markdown files remain the source of truth.
+
+### Optional official plugins
+
+The MIT-licensed core can discover and host separately distributed, signed first-party plugins while remaining fully useful on its own. Optional plugins may use their own license and distribution terms; their implementation and browser assets are not part of the `myagentmemory` package. `agent-memory plugin list` and `plugin status` report local state. In an interactive terminal, `agent-memory plugin install` opens a nonce-bound loopback page for an email address, resumes the waiting command, verifies signed release metadata and the downloaded bundle, and installs atomically. The free plan uses a configurable daily agent-session allowance keyed by normalized email. D1 stores bounded activation metadata, a credential hash, and opaque SessionStart usage operations; it never receives memory, session content, queries, repository paths, raw agent session identifiers, IP addresses, or user-agent strings. Authentication and payment can extend this free activation flow later. See the [official plugin bootstrap and host contract](docs/official-plugin-bootstrap.md).
 
 ## Installation
 
@@ -35,8 +42,8 @@ brew install jayzeng/agentmemory/agent-memory
 # Install the portable CLI globally (Node.js 20+; macOS, Linux, or Windows)
 npm install -g myagentmemory
 
-# If you hit SSL errors due to corporate MITM/inspection, try:
-# npm config set strict-ssl false
+# If corporate TLS inspection requires a private CA, use your organization's CA file:
+# npm config set cafile /path/to/corporate-ca.pem
 
 # Or build from source
 bun run build:cli
@@ -83,7 +90,28 @@ qmd embed
 
 Without qmd, all core tools (write/read/scratchpad) work normally. Only `memory_search` and selective injection require qmd.
 
-## Architecture
+## Memory lifecycle
+
+AgentMemory implements a state lifecycle rather than a transcript archive. Scratch, daily, topic, and durable memory are destinations for different needs—not mandatory steps through which every entry must pass.
+
+```
+Session / external evidence
+             │
+             ▼
+   Extract, qualify, or discard
+             │
+             ├── Scratch  — short-lived follow-ups
+             ├── Daily    — chronological evidence
+             ├── Topic    — continuing threads
+             └── Durable  — curated facts and decisions
+                                      │
+                                      ▼
+                    Retrieve · supersede · invalidate · forget
+```
+
+The files are the current implementation of this lifecycle. The durable state remains useful even if the agent, model, harness, or optional retriever changes. The [field report](https://www.jayzeng.com/writing/agentmemory-field-report/) explains the evidence and design lessons behind it.
+
+## Repository architecture
 
 ```
   ┌───────────────┐
@@ -116,8 +144,12 @@ The memory directory defaults to `~/.agent-memory/`. Override with `AGENT_MEMORY
 | `agent-memory search --query <text> [--mode keyword\|semantic\|deep] [--limit N]` | Search via qmd |
 | `agent-memory install-skills` | Install bundled SKILL.md files into local agent directories |
 | `agent-memory uninstall-skills` | Uninstall bundled SKILL.md files from local agent directories |
+| `agent-memory completion [bash\|zsh\|fish\|powershell] [--stdout]` | Install or print shell completion |
+| `agent-memory install-hooks [--yes] [--only <agents>]` | Install managed session-start memory hooks |
+| `agent-memory uninstall-hooks [--only <agents>]` | Remove only hooks managed by AgentMemory |
 | `agent-memory init` | Create dirs, detect qmd, setup collection |
 | `agent-memory status` | Show config, qmd status, file counts |
+| `agent-memory plugin <list\|status\|install\|update\|uninstall\|manage>` | Discover and manage optional signed first-party plugins |
 
 Global flags: `--dir <path>` (override directory), `--json` (machine output)
 
@@ -211,6 +243,7 @@ These are content conventions, not enforced metadata. qmd's full-text indexing m
 |----------|--------|---------|-------------|
 | `AGENT_MEMORY_DIR` | path | `~/.agent-memory` | Memory directory |
 | `AGENT_MEMORY_QMD_UPDATE` | `background`, `manual`, `off` | `background` | Controls automatic `qmd update` after writes |
+| `AGENT_MEMORY_PLUGIN_DIR` | path | `~/.agent-memory/system/plugins` | Machine-local official plugin installation root; independent of `AGENT_MEMORY_DIR` |
 
 ## Running tests
 
@@ -251,16 +284,7 @@ agent-memory install-skills
 
 ## Publishing (maintainers)
 
-```bash
-# Confirm package name is available
-npm view myagentmemory
-
-# Bump version (choose patch/minor/major)
-npm version patch
-
-# Publish to npm (public)
-npm publish --access public
-```
+Publication is tag-driven through `.github/workflows/publish-npm.yml`. Configure `jayzeng/agentmemory` and `publish-npm.yml` as the npm trusted publisher for `myagentmemory`, merge a versioned changelog/package update, and push the matching `v<version>` tag. The workflow uses short-lived OIDC credentials, runs the complete release gate, and publishes the public package with provenance. Do not publish this package from the private plugin workspace.
 
 ### Repository assets (maintainers)
 

package/dist/cli-spec.d.ts

@@ -0,0 +1,25 @@
+export type CliValueKind = "directory" | "file" | "number" | "value";
+export interface CliOptionSpec {
+    description: string;
+    value?: {
+        label: string;
+        kind: CliValueKind;
+    };
+}
+export declare const COMMANDS: readonly ["context", "write", "read", "scratchpad", "search", "distil", "sync", "init", "status", "install-skills", "uninstall-skills", "install-hooks", "uninstall-hooks", "completion", "plugin", "version", "help"];
+export declare const PLUGIN_COMMANDS: readonly ["list", "status", "install", "update", "uninstall", "manage"];
+export declare const WORKER_ACTIONS: readonly [];
+export declare const SCRATCHPAD_ACTIONS: readonly ["add", "done", "undo", "clear_done", "list"];
+export declare const COMMAND_DESCRIPTIONS: Record<(typeof COMMANDS)[number], string>;
+export declare const PLUGIN_COMMAND_DESCRIPTIONS: Record<(typeof PLUGIN_COMMANDS)[number], string>;
+export declare const WORKER_ACTION_DESCRIPTIONS: Record<(typeof WORKER_ACTIONS)[number], string>;
+export declare const SCRATCHPAD_ACTION_DESCRIPTIONS: Record<(typeof SCRATCHPAD_ACTIONS)[number], string>;
+export declare const GLOBAL_OPTIONS: readonly ["--dir", "--json", "--help", "--version", "-h", "-V"];
+export declare const COMMAND_OPTIONS: Record<string, readonly string[]>;
+export declare const PLUGIN_COMMAND_OPTIONS: Record<string, readonly string[]>;
+export declare const WORKER_ACTION_OPTIONS: Record<string, readonly string[]>;
+export declare const SCRATCHPAD_ACTION_OPTIONS: Record<string, readonly string[]>;
+export declare const OPTION_SPECS: Record<string, CliOptionSpec>;
+export declare const SHELL_DESCRIPTIONS: Record<string, string>;
+export declare function optionDescription(option: string): string;
+export declare function optionTakesValue(option: string): boolean;

package/dist/cli-spec.js

@@ -0,0 +1,211 @@
+export const COMMANDS = [
+    "context",
+    "write",
+    "read",
+    "scratchpad",
+    "search",
+    "distil",
+    "sync",
+    "init",
+    "status",
+    "install-skills",
+    "uninstall-skills",
+    "install-hooks",
+    "uninstall-hooks",
+    "completion",
+    "plugin",
+    "version",
+    "help",
+];
+export const PLUGIN_COMMANDS = ["list", "status", "install", "update", "uninstall", "manage"];
+export const WORKER_ACTIONS = [];
+export const SCRATCHPAD_ACTIONS = ["add", "done", "undo", "clear_done", "list"];
+export const COMMAND_DESCRIPTIONS = {
+    context: "build context from scratchpad, logs, topics, and long-term memory",
+    write: "append or overwrite a daily, topic, or long-term memory entry",
+    read: "read daily, topic, scratchpad, or long-term memory",
+    scratchpad: "add, complete, reopen, list, or clear persistent checklist items",
+    search: "search indexed memory with keyword, semantic, or deep qmd modes",
+    distil: "rebuild a compact MEMORY.md index from logs and topics",
+    sync: "update the qmd index and semantic embeddings",
+    init: "create memory storage and configure qmd when available",
+    status: "show memory paths, file counts, qmd, and embedding health",
+    "install-skills": "install core instructions for detected agents",
+    "uninstall-skills": "remove core instructions from detected agents",
+    "install-hooks": "install automatic SessionStart indexing and context hooks",
+    "uninstall-hooks": "remove only SessionStart hooks managed by agent-memory",
+    completion: "install or print Bash, Zsh, Fish, or PowerShell completion",
+    plugin: "index, recall, learn from, and evaluate prior agent sessions",
+    version: "print the installed agent-memory version",
+    help: "show top-level, command, or nested plugin help",
+};
+export const PLUGIN_COMMAND_DESCRIPTIONS = {
+    list: "list optional official plugins and local availability",
+    status: "show the installed bundle and entitlement state",
+    install: "authenticate if needed, then install or upgrade the official bundle",
+    update: "upgrade an existing official bundle when a compatible release exists",
+    uninstall: "remove official plugin executables while preserving user data",
+    manage: "open the AgentMemory account and billing website",
+};
+export const WORKER_ACTION_DESCRIPTIONS = {};
+export const SCRATCHPAD_ACTION_DESCRIPTIONS = {
+    add: "add a new open checklist item; requires --text",
+    done: "complete the first open substring match; requires --text",
+    undo: "reopen the first completed substring match; requires --text",
+    clear_done: "remove every completed checklist item",
+    list: "show checklist items and completion counts",
+};
+export const GLOBAL_OPTIONS = ["--dir", "--json", "--help", "--version", "-h", "-V"];
+export const COMMAND_OPTIONS = {
+    context: ["--query", "--no-search"],
+    write: ["--content", "--target", "--mode", "--topic", "--date", "--source-uri"],
+    read: ["--target", "--date", "--topic"],
+    scratchpad: ["--text"],
+    search: ["--query", "--mode", "--limit"],
+    distil: ["--dry-run"],
+    sync: [],
+    init: [],
+    status: ["--probe"],
+    "install-skills": [],
+    "uninstall-skills": [],
+    "install-hooks": ["--yes", "--all", "--only"],
+    "uninstall-hooks": ["--only"],
+    completion: ["--stdout"],
+    version: [],
+    help: [],
+};
+export const PLUGIN_COMMAND_OPTIONS = {
+    list: [],
+    status: ["--channel"],
+    install: ["--channel", "--no-browser", "--yes"],
+    update: ["--channel"],
+    uninstall: ["--yes"],
+    manage: ["--no-browser"],
+};
+export const WORKER_ACTION_OPTIONS = {};
+export const SCRATCHPAD_ACTION_OPTIONS = {
+    add: ["--text"],
+    done: ["--text"],
+    undo: ["--text"],
+    clear_done: [],
+    list: [],
+};
+export const OPTION_SPECS = {
+    "--dir": { description: "override the active memory directory", value: { label: "directory", kind: "directory" } },
+    "--json": { description: "emit command-specific structured JSON" },
+    "--help": { description: "show help for the selected command" },
+    "--version": { description: "print the installed version and exit" },
+    "-h": { description: "show help for the selected command" },
+    "-V": { description: "print the installed version and exit" },
+    "--query": { description: "memory search or context-retrieval query", value: { label: "text", kind: "value" } },
+    "--no-search": { description: "build context without invoking qmd" },
+    "--content": { description: "memory entry content to persist", value: { label: "text", kind: "value" } },
+    "--target": { description: "memory destination or collection to read", value: { label: "target", kind: "value" } },
+    "--mode": { description: "write behavior or qmd search strategy", value: { label: "mode", kind: "value" } },
+    "--topic": { description: "topic name used to resolve a topic file", value: { label: "name", kind: "value" } },
+    "--date": { description: "daily-log date in YYYY-MM-DD form", value: { label: "date", kind: "value" } },
+    "--source-uri": {
+        description: "optional provenance URI stored with an entry",
+        value: { label: "uri", kind: "value" },
+    },
+    "--text": { description: "checklist item text or substring to match", value: { label: "text", kind: "value" } },
+    "--limit": { description: "maximum number of search or recall results", value: { label: "number", kind: "number" } },
+    "--dry-run": { description: "preview generated memory without writing MEMORY.md" },
+    "--probe": { description: "run a live semantic query to verify embeddings" },
+    "--since": { description: "metrics reporting window in days", value: { label: "days", kind: "number" } },
+    "--port": {
+        description: "web-console port; use 0 to select an available port",
+        value: { label: "number", kind: "number" },
+    },
+    "--state": { description: "override the plugin state root", value: { label: "directory", kind: "directory" } },
+    "--with-plugin": { description: "include both the core and optional plugin skills" },
+    "--plugin-only": { description: "operate only on the optional plugin skill" },
+    "--yes": { description: "apply eligible hook changes without confirmation" },
+    "--all": { description: "apply eligible hook changes without confirmation" },
+    "--only": {
+        description: "restrict hook changes to comma-separated agent keys",
+        value: { label: "agents", kind: "value" },
+    },
+    "--stdout": { description: "print the completion script without installing it" },
+    "--channel": {
+        description: "select the official release channel",
+        value: { label: "channel", kind: "value" },
+    },
+    "--no-browser": { description: "print account URLs instead of opening a browser" },
+    "--scope": {
+        description: "search globally or only in the current workspace",
+        value: { label: "scope", kind: "value" },
+    },
+    "--cwd": {
+        description: "restrict session operations to a working directory",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--context": {
+        description: "surrounding events included with each recall hit",
+        value: { label: "number", kind: "number" },
+    },
+    "--pi": { description: "override the Pi session root", value: { label: "directory", kind: "directory" } },
+    "--codex": { description: "override the Codex session root", value: { label: "directory", kind: "directory" } },
+    "--claude": {
+        description: "override the Claude Code session root",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--host": {
+        description: "session host (pi/codex/claude) or web loopback bind address",
+        value: { label: "host", kind: "value" },
+    },
+    "--max-per-host": {
+        description: "maximum session files read from each host",
+        value: { label: "number", kind: "number" },
+    },
+    "--recent": {
+        description: "most recently modified session files refreshed per host",
+        value: { label: "number", kind: "number" },
+    },
+    "--interval": {
+        description: "watch polling interval in milliseconds",
+        value: { label: "milliseconds", kind: "number" },
+    },
+    "--once": { description: "run one watch iteration and exit" },
+    "--lines": {
+        description: "number of recent worker log entries to return",
+        value: { label: "number", kind: "number" },
+    },
+    "--threshold": {
+        description: "minimum repeated evidence required for a candidate",
+        value: { label: "number", kind: "number" },
+    },
+    "--output": { description: "also write the report to this file", value: { label: "file", kind: "file" } },
+    "--replay": { description: "back up and rebuild derived learning layers" },
+    "--journal": {
+        description: "override the experience journal directory",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--candidates-dir": {
+        description: "override the candidate ledger directory",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--decisions-dir": {
+        description: "override the decision ledger directory",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--auto-dir": {
+        description: "override the materialized auto-memory directory",
+        value: { label: "directory", kind: "directory" },
+    },
+    "--agent": { description: "internal SessionStart host key", value: { label: "agent", kind: "value" } },
+    "--token": { description: "internal session-worker lease token", value: { label: "token", kind: "value" } },
+    "--uninstall": { description: "use install-skills compatibility uninstall mode" },
+};
+export const SHELL_DESCRIPTIONS = {
+    bash: "generate or install Bash completion",
+    zsh: "generate or install Zsh completion",
+    fish: "generate or install Fish completion",
+    powershell: "generate or install PowerShell completion",
+};
+export function optionDescription(option) {
+    return OPTION_SPECS[option]?.description ?? option;
+}
+export function optionTakesValue(option) {
+    return OPTION_SPECS[option]?.value !== undefined;
+}

package/dist/cli.d.ts

@@ -12,6 +12,10 @@
  *   search     — Search via qmd
  *   init       — Create dirs, detect qmd, setup collection
  *   status     — Show config, qmd status, file counts
+ *   completion — Install or print shell completion
+ *   install-hooks — Install managed session-start hooks
+ *   uninstall-hooks — Remove managed session-start hooks
+ *   plugin     — Discover and bootstrap optional official plugins
  *
  * Global flags:
  *   --dir <path>   Override memory directory