om-memory-system 3.0.0 → 3.1.0-next.4

package/README.md

@@ -4,584 +4,160 @@
 [![npm downloads](https://img.shields.io/npm/dm/om-memory-system.svg)](https://www.npmjs.com/package/om-memory-system)
 [![license](https://img.shields.io/npm/l/om-memory-system.svg)](https://www.npmjs.com/package/om-memory-system)
 
-> **Fork notice.** This is [`cmdaltctr/omms`](https://github.com/cmdaltctr/omms), a fork of
-> [`tickernelz/opencode-mem`](https://github.com/tickernelz/opencode-mem), published on npm as **`om-memory-system`**, the Opinionated
-> Modular Memory System for coding agents. The fork adds first-class integration with the
-> [Pi coding agent](https://www.npmjs.com/package/@earendil-works/pi-coding-agent): the memory engine now runs as a
-> shared, host-neutral core behind a native Pi extension, so OpenCode and Pi read and write one memory store per
-> project. Existing OpenCode memory data migrates automatically and safely on first start; see
-> [docs/omms-migration.md](docs/omms-migration.md). All existing OpenCode behaviour, storage compatibility, and
-> configuration are preserved. See [docs/shared-core.md](docs/shared-core.md) for the boundary,
-> [docs/pi-adapter.md](docs/pi-adapter.md) for Pi installation and lifecycle details, and
-> [docs/pi-history-import.md](docs/pi-history-import.md) to import existing Pi session history.
+![OMMS banner](.github/banner.png)
 
-![OpenCode Memory Banner](.github/banner.png)
+OMMS gives your AI coding agent a long-term memory. As you work, it writes
+short notes about what was done and decided in each project: fixes, design
+choices, things that did not work. It brings the relevant notes back in later
+sessions, so the agent does not start from zero every time. It also learns how
+you like to work and keeps that as a user profile.
 
-A persistent memory system for AI coding agents that enables long-term context retention across sessions using local vector database technology.
+It runs inside [OpenCode](https://opencode.ai) and the
+[Pi coding agent](https://www.npmjs.com/package/@earendil-works/pi-coding-agent).
+Both share one memory per project, so a note written in one is available in
+the other. Everything is stored locally on your machine.
 
-## Visual Overview
+## What it does
 
-**Project Memory Timeline:**
+- **Remembers automatically.** After each piece of work, a background model
+  call summarises it into a memory. You do not have to ask.
+- **Recalls when relevant.** Matching memories are added to the agent's
+  context: on every prompt in OpenCode v2 and Pi, at the start of a session in
+  OpenCode v1.
+- **Learns your preferences.** A user profile of your habits builds up over
+  time and follows you across projects.
+- **Imports your past sessions.** One command turns old OpenCode or Pi
+  history into memories and a profile.
+- **Lets you look and edit.** A local web page shows every memory and your
+  profile.
+- **Keeps private things private.** Text inside `<private>` tags is never
+  stored.
 
-![Project Memory Timeline](.github/screenshot-project-memory.png)
+![Project memory timeline](.github/screenshot-project-memory.png)
 
-**User Profile Viewer:**
+![User profile viewer](.github/screenshot-user-profile.png)
 
-![User Profile Viewer](.github/screenshot-user-profile.png)
+## Before you start
 
-## Core Features
+You need one of:
 
-Local Turso/libSQL database with native vector search, persistent project memories, automatic user profile learning, unified memory-prompt timeline, full-featured web UI, intelligent prompt-based memory extraction, multi-provider AI support (OpenAI, Anthropic), 12+ local embedding models, smart deduplication, and built-in privacy protection.
+- **OpenCode** 1.18.29 or later (v1 plugin API) or OpenCode v2
+- **Pi coding agent**
 
-## Prerequisites
+Nothing else is required. OMMS brings its own database. On first use it
+downloads a small embedding model (the part that makes memories searchable),
+so you need internet access once. The terminal import command also needs
+Node.js 22.14 or later.
 
-This plugin uses embedded Turso/libSQL with native vector indexes (`F32_BLOB`, `vector_top_k`). No separate vector database or custom SQLite build is required.
+## Set up
 
-**Recommended runtime:**
+### 1. Install
 
-- Bun
-- Standard OpenCode plugin environment
-- Internet access on first use if you use the default local embedding model, because the model is downloaded by `@huggingface/transformers`.
-- For source/development installs, run `bun install` before building or testing. The published plugin package installs its runtime dependencies automatically through OpenCode.
-
-**CI-tested platforms:** Linux, Windows, macOS 15 and macOS 26 on both Intel (`darwin/x64`) and Apple Silicon (`darwin/arm64`). Older macOS releases are not excluded by that matrix; they are simply outside the current GitHub-hosted runner set.
-
-**Notes:**
-
-- Vector embeddings are stored and searched directly in Turso/libSQL; inserts update the vector index automatically.
-- Vector search uses libSQL's DiskANN index via `vector_top_k` (approximate nearest neighbors).
-- Auto-capture and user profile learning require an AI provider that can return structured/tool-call output. Memory search/add/list still work without auto-capture provider configuration.
-
-### Upgrading from legacy SQLite shards
-
-On first startup after upgrading, omms automatically migrates existing memory shard databases to native Turso/libSQL vector format:
-
-- Each shard is backed up as `<shard>.db.legacy.bak` before rewrite
-- Progress is tracked per shard in `<shard>.db.turso-migrate.json`
-- A global marker `.turso-migrated` is written only after all shards verify successfully
-- Do not run multiple OpenCode instances against the same `storagePath` during migration; a lock file (`.turso-migrate.lock`) prevents concurrent migration
-- Manual dimension migrations use `.turso-operation.lock`; other plugin processes reject new memory writes until the migration finishes
-
-If migration is interrupted, the next startup resumes from the backup automatically.
-
-If a shard becomes incompatible (for example after changing `embeddingDimensions`), writes are blocked and the original database is left untouched. Use the Web UI's re-embed migration to build and verify a replacement before it is swapped into place. The previous shard remains available as `<shard>.db.pre-reembed-<pid>-<timestamp>.bak`.
-
-## Install OMMS
-
-Install OMMS in the coding agent you use. You can install it in both OpenCode
-and Pi. They share one project memory store.
-
-### OpenCode
-
-Add `om-memory-system` (the npm name for omms) to your OpenCode configuration. OpenCode downloads the package
-when you restart it. On OpenCode v2 you can instead run `opencode plugin add om-memory-system`,
-which installs the package and updates your global configuration for you.
-
-#### macOS
-
-Edit `~/.config/opencode/opencode.json`.
-
-For OpenCode v2, use the native `plugins` list:
+**OpenCode.** Add `om-memory-system` to `~/.config/opencode/opencode.json`
+(on Windows, `%USERPROFILE%\.config\opencode\opencode.json`):
 
 ```jsonc
-{
-  "plugins": ["om-memory-system"],
-}
-```
-
-For OpenCode v1 (1.18.29 or later), use the `plugin` list:
+// OpenCode v2
+{ "plugins": ["om-memory-system"] }
 
-```jsonc
-{
-  "plugin": ["om-memory-system"],
-}
-```
-
-Restart OpenCode after you save the file.
-
-#### Windows
-
-Edit `%USERPROFILE%\.config\opencode\opencode.json`, for example
-`C:\Users\<you>\.config\opencode\opencode.json`.
-
-For OpenCode v2, use:
-
-```jsonc
-{
-  "plugins": ["om-memory-system"],
-}
-```
-
-For OpenCode v1 (1.18.29 or later), use:
-
-```jsonc
-{
-  "plugin": ["om-memory-system"],
-}
+// OpenCode v1
+{ "plugin": ["om-memory-system"] }
 ```
 
-Restart OpenCode after you save the file. OMMS does not read `%APPDATA%` or
-`%LOCALAPPDATA%` for this setting.
+On OpenCode v2 you can run `opencode plugin add om-memory-system` instead.
+Restart OpenCode.
 
-### Pi coding agent
-
-Run the following command in Terminal on macOS or PowerShell on Windows:
+**Pi.** Run:
 
 ```bash
 pi install npm:om-memory-system
 ```
 
-Restart Pi after installation. The extension reads the same configuration and
-storage path as OpenCode, so memories remain available in both agents.
-
-See [docs/pi-adapter.md](docs/pi-adapter.md) for Pi lifecycle details and
-[docs/pi-history-import.md](docs/pi-history-import.md) to import existing Pi
-session history.
-
-Once OMMS is running, open the memory explorer web UI at
-`http://127.0.0.1:4747`. It ships with every release.
-
-### Update OMMS
-
-Install OMMS without a version number, as shown above, so your agent can tell
-you when a new release is out. Neither agent installs updates by itself; you
-choose when to update.
-
-| Agent       | How you hear about a new release                              | Update with                                                             |
-| ----------- | ------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| Pi          | Pi shows an update notice while you work                      | `pi update npm:om-memory-system` (or `pi update --extensions` for all)  |
-| OpenCode v2 | Run `opencode plugin check` to list plugins with new versions | `opencode plugin update om-memory-system` (or `opencode plugin update`) |
-
-Restart the agent after updating.
-
-To stay on one version, install it with the version number instead:
-`pi install npm:om-memory-system@3.1.0` in Pi, or `opencode plugin add om-memory-system@3.1.0` in
-OpenCode. A pinned install is never updated or flagged; install without the
-number again to go back to receiving updates.
-
-Release notes for every version are in [CHANGELOG.md](CHANGELOG.md) and on the
-[GitHub Releases](https://github.com/cmdaltctr/omms/releases) page.
-
-Upgrading from an existing `opencode-mem` install? The store migrates to
-`~/.omms/data` automatically on first start, with a verified backup first.
-See [docs/omms-migration.md](docs/omms-migration.md).
-
-## How to use day-to-day
-
-You do **not** need to ask OpenCode to “remember” things for the plugin to work. With the defaults, memory builds up as you work.
-
-### Typical daily flow
-
-1. Enable the plugin (see [Install OMMS](#install-omms)) and restart OpenCode.
-2. Configure an AI provider for auto-capture — recommended: `opencodeProvider` + `opencodeModel` (or `"opencodeModel": "inherit"`). Details under [Auto-Capture AI Provider](#auto-capture-ai-provider).
-3. Work normally in OpenCode. When a session goes idle, auto-capture extracts memorable technical context and stores it.
-4. Relevant memories are injected into context automatically. On OpenCode v2 and Pi, every prompt runs a semantic search of the project memory and adds the matches as an `<omms-retrieval>` system section (never as a chat message). On OpenCode v1, the most recent memories are injected on the first message of a session (`chatMessage.injectOn`). After compaction, the session's own memories are restored. Browse or edit memories in the web UI at `http://127.0.0.1:4747`.
-5. Use the `memory` tool when you want something stored or retrieved immediately (see [Usage Examples](#usage-examples)).
-
-### Automatic vs manual memory
-
-| Approach                                               | When it runs                                        | What you do                                                                                |
-| ------------------------------------------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------ |
-| **Auto-capture** (`autoCaptureEnabled: true`, default) | After conversation turns when the session goes idle | Nothing — extraction is automatic                                                          |
-| **Manual** `memory` tool / commands                    | On demand                                           | `add`, `search`, `list`, `profile`, `forget`, `list-shards`, `migrate`, `export`, `import` |
-
-Manual search/add/list still work even if auto-capture has no provider configured. Auto-capture and user profile learning need a provider that can return structured/tool-call output.
-
-### Memory vs AGENTS.md / project docs
-
-| Store in **memory**                                                  | Store in **AGENTS.md** / static docs                        |
-| -------------------------------------------------------------------- | ----------------------------------------------------------- |
-| Project-specific decisions, bug patterns, “we tried X and it failed” | Stable rules and workflows that rarely change               |
-| User preferences discovered over sessions                            | Always-on coding conventions and process                    |
-| Facts that should follow you across chats                            | Instructions every agent should see regardless of retrieval |
-
-Rule of thumb: if it is a lasting project instruction, put it in AGENTS.md; if it is context that grows from real work, let memory (or auto-capture) hold it.
-
-### Intelligent prompt-based memory extraction
-
-That phrase in the feature list is **auto-capture**: after a conversation, a background AI request summarizes technical work and saves it as memory. No special prompt from you is required. It uses `opencodeProvider` / `opencodeModel` when set, otherwise the manual `memoryProvider` fallback.
-
-### User profile
-
-The **User Profile** is a separate, cross-project summary of how you like to work (preferences, habits). It is updated on an interval (`userProfileAnalysisInterval`, default every 10 analyzed prompts), shown in the web UI’s profile view, and readable via `memory({ mode: "profile" })`. You do not populate it by hand for normal use — profile learning fills it when a provider is ready.
-
-### Web UI
-
-Open `http://127.0.0.1:4747` to browse the memory–prompt timeline, inspect captures, and manage the user profile. If you bind the server beyond loopback, see [Web UI HTTP Basic Auth](#web-ui-http-basic-auth).
-
-## Usage Examples
-
-```typescript
-memory({ mode: "add", content: "Project uses microservices architecture" });
-memory({ mode: "search", query: "architecture decisions" });
-memory({ mode: "search", query: "architecture decisions", scope: "all-projects" });
-memory({ mode: "profile" });
-memory({ mode: "list", limit: 10 });
-memory({ mode: "list-shards" });
-memory({ mode: "migrate", fromPath: "/old/path/to/project" });
-memory({ mode: "export", outputPath: "./memories.json" });
-memory({ mode: "import", inputPath: "./memories.json" });
-```
-
-Access the web interface at `http://127.0.0.1:4747` for visual memory browsing and management.
-
-**Network binding security:** Keep `webServerHost` on `127.0.0.1` unless you intentionally expose the UI. Binding to `0.0.0.0` (or any non-loopback host) requires `webServerApiToken`; all `/api/*` requests must then send `Authorization: Bearer <token>` or `X-Omms-Token` (the legacy `X-Opencode-Mem-Token` header is still accepted). Open the UI with `?apiToken=<token>` so the browser stores and sends it.
-
-Dimension migrations generate every new embedding first, import them into a temporary indexed shard, verify the row count, and only then replace the original file. Failed migrations leave the source shard untouched.
+Restart Pi. You can install OMMS in both agents; they share the same memory.
 
-## Configuration Essentials
+### 2. Choose which model writes memories (optional)
 
-Configure at `~/.config/omms/omms.jsonc`. While that file does not exist, omms still reads the legacy `~/.config/opencode/opencode-mem.jsonc` (it is never written), so existing installs keep working before you migrate settings. Per-project overrides go in `<project>/.opencode/omms.jsonc` (the legacy `.opencode/opencode-mem.jsonc` is still read when no `omms.jsonc` exists):
-
-**Windows:** `%USERPROFILE%\.config\omms\omms.jsonc` (not AppData). Default storage resolves to `%USERPROFILE%\.omms\data` (the `~` form in the example below expands to your user home on Windows as well). A legacy `~/.opencode-mem/data` store migrates to the new path automatically on first start.
-
-The plugin creates a full commented template at this path on first startup (only when no config exists at all). This trimmed example shows the most common settings:
+With no settings, OMMS uses the model of the session you are working in. To
+use a different one, add it to `~/.config/omms/omms.jsonc`. If you have no
+config file yet, OMMS creates this one with comments on first start.
 
 ```jsonc
 {
-  "storagePath": "~/.omms/data",
-  "userEmailOverride": "user@example.com",
-  "userNameOverride": "John Doe",
-  "embeddingModel": "Xenova/nomic-embed-text-v1",
-  // Optional Nomic task prefixes (search_document: / search_query:). After enabling,
-  // re-index existing memories so store and query vectors stay aligned.
-  // "embeddingUseTaskPrefixes": true,
-  // Optional OpenAI-compatible embedding endpoint:
-  // "embeddingApiUrl": "https://api.openai.com/v1",
-  // "embeddingApiKey": "env://OPENAI_API_KEY",
-  // "embeddingModel": "text-embedding-3-small",
-
-  "memory": {
-    "defaultScope": "project",
-  },
-  "webServerEnabled": true,
-  "webServerPort": 4747,
-  // Required when webServerHost is not 127.0.0.1/localhost:
-  // "webServerHost": "0.0.0.0",
-  // "webServerApiToken": "env://OMMS_WEB_TOKEN",
-
-  "autoCaptureEnabled": true,
-  "autoCaptureLanguage": "auto",
-
-  "opencodeProvider": "anthropic",
-  "opencodeModel": "claude-haiku-4-5-20251001",
-
-  // Manual fallback if you do not use opencodeProvider:
-  // "memoryProvider": "openai-chat",
-  // "memoryModel": "gpt-4o-mini",
-  // "memoryApiUrl": "https://api.openai.com/v1",
-  // "memoryApiKey": "env://OPENAI_API_KEY",
-
-  "showAutoCaptureToasts": true,
-  "showUserProfileToasts": true,
-  "showErrorToasts": true,
-
-  "userProfileAnalysisInterval": 10,
-  "userProfileMaxContextBytes": 32768,
-  "maxMemories": 10,
-
-  "compaction": {
-    "enabled": true,
-    "memoryLimit": 10,
-  },
-  "chatMessage": {
-    "enabled": true,
-    "maxMemories": 3,
-    "excludeCurrentSession": true,
-    "maxAgeDays": undefined,
-    "injectOn": "first", // OpenCode v1 only; v2 and Pi search on every prompt
-  },
+  // A model you are already signed in to in OpenCode or Pi.
+  // Use "inherit" to always follow the session's model.
+  "opencodeProvider": "openai",
+  "opencodeModel": "gpt-5.6-luna",
+  "piProvider": "openai-codex",
+  "piModel": "gpt-5.6-luna",
 }
 ```
 
-### Choosing / configuring embeddings
-
-Embeddings power similarity search for memories and the user profile. Configure them in the same file (`~/.config/omms/omms.jsonc`). There is **no MLX backend** — local embeddings use `@huggingface/transformers` with ONNX, not Apple MLX.
-
-**Local (default):** set only `embeddingModel`. On first use the model is downloaded from Hugging Face and cached under `{storagePath}/.cache` (default `~/.omms/data/.cache`).
+You can also use any OpenAI-compatible or Anthropic API with your own key.
+See [Configuration](docs/configuration.md#choosing-the-model).
 
-**Remote (OpenAI-compatible):** set both `embeddingApiUrl` and `embeddingApiKey`. The plugin then calls `{embeddingApiUrl}/embeddings` with a Bearer token. `embeddingApiKey` accepts the same secret formats as `memoryApiKey` (`literal`, `env://…`, `file://…`).
+### 3. Check it works
 
-| Key                   | Role                                                                                      |
-| --------------------- | ----------------------------------------------------------------------------------------- |
-| `embeddingModel`      | Hugging Face id (local) or API model name (remote). Default: `Xenova/nomic-embed-text-v1` |
-| `embeddingDimensions` | Optional override; usually omit — dimensions are looked up from a built-in map            |
-| `embeddingApiUrl`     | Base URL for an OpenAI-compatible embeddings API (no trailing path beyond `/v1`)          |
-| `embeddingApiKey`     | API key for that endpoint (required together with `embeddingApiUrl`)                      |
+Work normally for a few turns, then open `http://127.0.0.1:4747` in your
+browser (OpenCode serves this page). New memories appear on the timeline.
+You can also ask the agent: "search memory for what we changed today".
 
-Recommended local models:
+## Import your past history
 
-| Model                                | Dims | Notes                               |
-| ------------------------------------ | ---- | ----------------------------------- |
-| `Xenova/nomic-embed-text-v1`         | 768  | Default; multilingual, 8192 context |
-| `Xenova/jina-embeddings-v2-base-en`  | 768  | English-only, 8192 context          |
-| `Xenova/jina-embeddings-v2-small-en` | 512  | Faster, 8192 context                |
-| `Xenova/all-MiniLM-L6-v2`            | 384  | Very fast, 512 context              |
-| `Xenova/all-mpnet-base-v2`           | 768  | Good quality, 512 context           |
+To turn earlier sessions into memories, preview first and then run it inside
+the agent:
 
-Example — remote OpenAI embeddings:
-
-```jsonc
-{
-  "embeddingApiUrl": "https://api.openai.com/v1",
-  "embeddingApiKey": "env://OPENAI_API_KEY",
-  "embeddingModel": "text-embedding-3-small",
-}
-```
-
-Changing `embeddingModel` (or dimensions) can trigger re-embedding of stored memories on next startup. Prefer picking a model once and sticking with it for a given data directory.
-
-**Intel Mac (`darwin/x64`):** `onnxruntime-node@1.21.0` through `1.23.2` can crash OpenCode's embedded Bun `1.3.14` during process exit after successful local embeddings (`Ort::Env` teardown / SIGILL). The fix shipped in `1.24.1`, but fixed releases still lack an x64 native binding. `omms` therefore pins `onnxruntime-node@1.20.1` and loads transformers through a CJS resolve shim so OpenCode nested installs keep that binding. Transformers is resolved to an absolute path before that shim is installed so OpenCode's Bun `--compile` host does not fail with `Cannot find module '@huggingface/transformers' from ''`. After upgrading, clear OpenCode's nested plugin cache (`~/.cache/opencode/packages/om-memory-system@*`, or `opencode-mem@*` on pre-migration installs) and reinstall, or use a remote endpoint via `embeddingApiUrl` + `embeddingApiKey` (example above). This pin stays until onnxruntime publishes a post-teardown-fix darwin/x64 build.
-
-### Memory Scope
-
-- `scope: "project"`: query only the current project. This is the default.
-- `scope: "all-projects"`: query `search` / `list` across all project shards.
-- `memory.defaultScope` sets the default query scope when no explicit scope is provided.
-
-### Web UI HTTP Basic Auth
-
-When `webServerHost` is set to anything other than loopback (for example `0.0.0.0`), the web UI is reachable by anyone on the network. To keep your memories off the LAN, gate the web server with HTTP Basic Auth via the same config file used for everything else:
-
-```jsonc
-{
-  "webServerHost": "0.0.0.0", // optional: reach the UI from the LAN
-  "webServerAuthPassword": "pick-a-strong-one",
-  "webServerAuthUsername": "admin", // optional, defaults to the current OS user
-}
-```
-
-| Field                   | Default           | Effect                                                                                                                       |
-| ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `webServerAuthPassword` | _(empty)_         | When set, the server demands HTTP Basic Auth credentials on every request. Leave empty to keep the open-by-default behavior. |
-| `webServerAuthUsername` | OS user (`$USER`) | Username required by the Basic Auth challenge.                                                                               |
-
-`webServerAuthPassword` accepts the same secret formats as `memoryApiKey`:
-
-- a literal string (simple, fine for personal machines),
-- `env://SOME_ENV_VAR` to pull the value from the environment at startup,
-- `file:///path/to/secret` to read it from a file (`chmod 600` recommended — the plugin will warn if the file is world-readable).
-
-The browser will pop its native Basic Auth dialog and remember the credentials for the current session; closing all browser windows discards them, so reopening the browser requires signing in again. Credentials are compared with a constant-time check, and the unauthenticated 401 response carries `Cache-Control: no-store` so no intermediate cache will replay it. CORS is also relaxed once auth is on, so other tools on the same LAN can talk to the API after authenticating.
-
-### Sharing One Project Memory Across Nested Repos
-
-By default a project is identified by its enclosing git repository, so every
-physical git repo gets its own isolated memory store. That is wrong for
-multi-repo workspaces — trees managed by Google [`repo`](https://gerrit.googlesource.com/git-repo/+/HEAD/Docs/manual-repo.md),
-monorepos, or any layout where several nested git repositories belong to one
-logical project — because each sub-repository would be siloed.
-
-Drop an empty **`.omms-project`** marker file at the workspace root (the legacy
-`.opencode-mem-project` marker is still honoured and gives the same project identity):
-
-```
-my-workspace/
-├── .omms-project           ← workspace root
-├── kernel/                 (own git repo)
-├── userspace/              (own git repo)
-└── tools/                  (own git repo)
-```
-
-Every session started anywhere underneath the marker then resolves onto that
-root and shares one memory store, regardless of which sub-repo the working
-directory lives in:
-
-```sh
-touch ~/my-workspace/.omms-project
-```
-
-The marker is looked up by walking up from the working directory that every
-code path already passes in (the plugin's working directory, the web API's
-`process.cwd()`), so identity is **directory-driven and process-independent**.
-It does not rely on environment variables or a global config value, which
-would be unreliable here: omms runs across multiple opencode processes
-that share a single web server, and only some of those processes carry a
-given env var. With the marker, the project root is always derived from where
-the session actually runs.
-
-The marker takes precedence over git detection. When it is present, the
-sub-repo's own git remote is intentionally ignored (it would describe only one
-nested repository). Without a marker, behavior is unchanged (git-based
-identity).
-
-### Moving or Recovering Project Memories
-
-omms keys project shards by a hash of the project identity. Moving a
-repository (OS migration, path reorganization, switching from a Windows mount
-to a native path) can therefore orphan the old shard under
-`~/.omms/data/projects/` while a new empty shard is created for the
-new path.
-
-These are OpenCode `memory` tool calls with JSON arguments, not commands to
-run in a terminal. The issue-style `memory migrate --from ...` notation maps
-to `memory({ mode: "migrate", fromPath: "..." })`.
-
-**1. Local move when you still know the old path**
-
-Open OpenCode in the **new** project directory. The target project must not
-already contain memories (migration aborts unchanged on conflict). Preview the
-detected source, destination, and file actions before changing anything:
-
-```typescript
-memory({ mode: "migrate", fromPath: "/old/path/to/project", dryRun: true });
-memory({ mode: "migrate", fromPath: "/old/path/to/project" });
-```
-
-For safety, migration refuses a source whose stored project directory still
-exists. If you intentionally want to move an active source, inspect the dry-run
-output first and then pass `allowLinkedSource: true`. Original source shard
-files are retained as timestamped `*.pre-path-migrate-*.bak` backups.
-
-**2. Old path is gone — discover the orphaned shard first**
-
-```typescript
-memory({ mode: "list-shards" });
-memory({ mode: "migrate", fromHash: "fa645294d88bbae2" });
-```
-
-`list-shards` reports each project hash, stored `projectPath`, memory count,
-and status (`current`, `linked`, `orphaned`, `missing-file`, `empty`, or
-`ambiguous`). `fromHash` is the 16-character lowercase hexadecimal `scopeHash`
-returned by this call. Prefer it when the old directory no longer exists or
-multiple shards contain the same stored path, because git-based identities
-cannot always be recomputed from a missing path.
-
-**3. Cross-machine backup / restore**
-
-```typescript
-// on the source machine / old checkout
-memory({ mode: "export", outputPath: "./memories.json" });
-
-// on the destination machine / new checkout
-memory({ mode: "import", inputPath: "./memories.json", dryRun: true });
-memory({ mode: "import", inputPath: "./memories.json" });
-```
-
-Export writes a versioned JSON document without vectors. Import remaps the
-memories onto the current project and recomputes embeddings with the currently
-configured model. Import adds memories to an existing project, but duplicate
-memory IDs abort the whole import before writing; this differs from `migrate`,
-which requires an empty target.
-
-Export files are plaintext and can contain memory content, user names/email
-addresses, repository URLs, and absolute project paths. Store them like other
-sensitive backups and delete them when no longer needed. Fully private entries
-are omitted, and user profiles and prompt history are not included. The
-document contains `schemaVersion: 1`; imports reject newer unsupported schema
-versions rather than guessing.
-
-### Auto-Capture AI Provider
-
-Auto-capture runs a background AI request to summarize technical work and save it as memory. It needs one of the provider configurations below.
-
-**Recommended:** Use a provider that is already authenticated in opencode and supports structured output:
-
-```jsonc
-"opencodeProvider": "anthropic",
-"opencodeModel": "claude-haiku-4-5-20251001",
-```
-
-The plugin issues structured-output requests to opencode's session API instead of calling provider endpoints directly, so opencode owns the auth, token refresh, and provider routing. The provider name must match an entry from `opencode providers list`, and the selected model must support structured JSON output through opencode.
-
-Supported providers: any provider listed by `opencode providers list` (e.g. `anthropic`, `openai`, `github-copilot`, ...).
-
-If `opencodeProvider` and `opencodeModel` are set, they take precedence over the manual `memoryProvider` settings below.
-
-**Follow the session model:** set `"opencodeModel": "inherit"` to use a concrete OpenCode model at call time instead of a pinned id. For **auto-capture**, each prompt is recorded via the `chat.params` hook and the capture request reuses that prompt's provider/model. For **profile learning** and other structured-output paths (which are not tied to a single user message), `inherit` falls back to the most recent model in OpenCode's `model.json` recent list (preferring the configured `opencodeProvider`). Sending the literal model id `inherit` is never valid and previously caused `ProviderModelNotFoundError: Model not found: <provider>/inherit` on those paths. `opencodeProvider` is still required as the normal config gate.
-
-**Fallback:** Manual API configuration (if not using opencodeProvider):
-
-```jsonc
-"memoryProvider": "openai-chat",
-"memoryModel": "gpt-4o-mini",
-"memoryApiUrl": "https://api.openai.com/v1",
-"memoryApiKey": "sk-...",
-```
-
-**API Key Formats:**
-
-```jsonc
-"memoryApiKey": "sk-..."
-"memoryApiKey": "file://~/.config/opencode/api-key.txt"
-"memoryApiKey": "env://OPENAI_API_KEY"
+```text
+/memory-import-opencode-history --dry-run
+/memory-import-pi-history --dry-run
 ```
 
-Manual `memoryProvider` modes:
-
-- `openai-chat`: OpenAI Chat Completions compatible API with tool/function calling. This can work with compatible proxies such as LiteLLM only when the selected upstream model and proxy preserve tool calls.
-- `openai-responses`: OpenAI Responses API with function-call output.
-- `anthropic`: Anthropic Messages API with tool use.
-- `minimax`: MiniMax Anthropic Messages-compatible endpoint. Set `memoryApiUrl` to the global endpoint (`https://api.minimax.io`) or the China endpoint (`https://api.minimaxi.com`); the `/anthropic/v1/messages` path and `x-api-key` header are applied automatically. MiniMax text models such as `MiniMax-M3` support the adaptive thinking modes used by this plugin via `memoryExtraParams`.
-- `orcarouter`: OpenAI-compatible model gateway with namespaced model IDs. `memoryApiUrl` and `memoryModel` are optional — they default to `https://api.orcarouter.ai/v1` and `orcarouter/auto` (a routing alias that selects a capable model per request). If you set `memoryModel`, use a namespaced ID such as `openai/gpt-5.5` or `deepseek/deepseek-v4-flash`; OrcaRouter rejects bare model names. Example:
-  ```jsonc
-  "memoryProvider": "orcarouter",
-  "memoryApiKey": "<OrcaRouter API key>",
-  ```
-  [OrcaRouter](https://www.orcarouter.ai) also runs gateway-level, zero-trust security for AI agents on the same endpoint — screening every prompt/response and governing every tool call on a default-deny basis, with no application code changes.
-
-Troubleshooting:
-
-- Auto-capture failures do not block manual `memory` tool usage.
-- If auto-capture reports that a provider is not connected, confirm the provider name with `opencode providers list` and configure that provider in opencode first.
-- If a proxy or custom provider returns plain text instead of structured/tool output, choose another model/provider or use one of the manual provider modes above.
-- For models that reject `temperature`, add `"memoryTemperature": false` when using manual API configuration.
-- **Intel Mac (darwin/x64) local embedding:** if embedding init fails or OpenCode exits with SIGILL after local memory use, clear `~/.cache/opencode/packages/om-memory-system@*` (or `opencode-mem@*` on pre-migration installs) after upgrading so the nested install picks up the pinned `onnxruntime-node@1.20.1`, or switch to a remote embedding endpoint via `embeddingApiUrl` + `embeddingApiKey`. See [Choosing / configuring embeddings](#choosing-configuring-embeddings). MLX is not supported.
-
-## Public Subpath Exports
+The preview shows how many model calls a real import needs. It uses the
+session's model; add `--model provider/id` for a cheaper one. There is also a
+terminal version, `npx om-memory-system`, that uses an API key. See the
+[OpenCode](docs/opencode-history-import.md) and [Pi](docs/pi-history-import.md)
+import guides, and the [CLI reference](docs/cli.md).
 
-In addition to the main plugin entry, `omms` exposes one stable subpath
-that other opencode plugins can import directly. This avoids having to
-reverse-engineer container-tag conventions when writing third-party tools that
-read or write into the same memory store.
+## Keeping OMMS up to date
 
-### `om-memory-system/tags`
+Pi shows a notice when a new version is out; update with
+`pi update npm:om-memory-system`. On OpenCode v2, run `opencode plugin check`
+and `opencode plugin update om-memory-system`. Restart the agent afterwards.
+Coming from `opencode-mem`? Your memories move over automatically, with a
+backup first. See [Updating and upgrading](docs/upgrading.md) and
+[CHANGELOG.md](CHANGELOG.md).
 
-Canonical container-tag helpers. The same functions omms itself uses
-to scope auto-captured memories.
+## Documentation
 
-```ts
-import { getProjectTagInfo, getUserTagInfo, getTags } from "om-memory-system/tags";
+| Read this                                                  | To learn about                                                   |
+| ---------------------------------------------------------- | ---------------------------------------------------------------- |
+| [Using memory day to day](docs/using-memory.md)            | How capture and recall work, the `memory` tool, the user profile |
+| [Configuration](docs/configuration.md)                     | Settings, choosing the model, embeddings, troubleshooting        |
+| [Web UI](docs/web-ui.md)                                   | The memory explorer, opening it on a network safely              |
+| [Moving projects](docs/moving-projects.md)                 | Nested repositories, moved folders, backup and restore           |
+| [Updating and upgrading](docs/upgrading.md)                | Updates, pinning a version, older stores                         |
+| [OpenCode adapter](docs/opencode-adapter.md)               | How the OpenCode plugin hooks in                                 |
+| [Pi adapter](docs/pi-adapter.md)                           | How the Pi extension hooks in                                    |
+| [OpenCode history import](docs/opencode-history-import.md) | Importing past OpenCode sessions                                 |
+| [Pi history import](docs/pi-history-import.md)             | Importing past Pi sessions, moving machines                      |
+| [CLI reference](docs/cli.md)                               | The `om-memory-system` terminal command                          |
+| [Migrating from opencode-mem](docs/omms-migration.md)      | What changes when upgrading from the original plugin             |
+| [For developers](docs/developers.md)                       | Building, testing, the public `tags` export, architecture        |
+| [Contributing](CONTRIBUTING.md)                            | How to set up, test, and send a pull request                     |
 
-// Canonical project tag derived from cwd (git remote URL if present, else
-// the project root path). Format: `omms_project_<sha16>`; rows written by
-// older versions are migrated automatically on first start.
-const projectTag = getProjectTagInfo(process.cwd()).tag;
-
-// Canonical user tag derived from `git config user.email`.
-// Format: `omms_user_<sha16>`.
-const userTag = getUserTagInfo().tag;
-
-// Both at once.
-const { user, project } = getTags(process.cwd());
-```
-
-Tags produced by these helpers match what auto-capture writes, so third-party
-plugins that call `POST /api/memories` will land in the same shards the rest
-of the system already understands. Hand-rolled tags whose substring isn't
-`_project_` or `_user_` end up in shadow shards that `/api/stats` and
-`/api/memories` silently filter out — using these helpers avoids that pitfall.
-
-## Development & Contribution
-
-Build and test locally:
-
-```bash
-bun install
-bun run build
-bun run typecheck
-bun run format
-```
+## About this fork
 
-This project is actively seeking contributions to become the definitive memory plugin for AI coding agents. Whether you are fixing bugs, adding features, improving documentation, or expanding embedding model support, your contributions are critical. The codebase is well-structured and ready for enhancement. If you hit a blocker or have improvement ideas, submit a pull request - we review and merge contributions quickly.
+OMMS is [`cmdaltctr/omms`](https://github.com/cmdaltctr/omms), a fork of
+[`tickernelz/opencode-mem`](https://github.com/tickernelz/opencode-mem),
+published on npm as `om-memory-system`. The fork runs the memory engine as a
+shared core for both OpenCode and Pi (see [shared core](docs/shared-core.md)).
+Existing OpenCode memories and settings keep working.
 
-## License & Links
+## License and links
 
-MIT License - see LICENSE file
+MIT License. See [LICENSE.md](LICENSE.md).
 
-- **Repository**: https://github.com/cmdaltctr/omms (fork)
-- **Upstream**: https://github.com/tickernelz/opencode-mem
-- **Issues**: https://github.com/cmdaltctr/omms/issues
-- **OpenCode Platform**: https://opencode.ai
+- Repository: https://github.com/cmdaltctr/omms
+- Upstream: https://github.com/tickernelz/opencode-mem
+- Issues: https://github.com/cmdaltctr/omms/issues
 
-Inspired by [opencode-supermemory](https://github.com/supermemoryai/opencode-supermemory)
+Inspired by [opencode-supermemory](https://github.com/supermemoryai/opencode-supermemory).