mor 0.0.2 → 0.2.0

package/LICENSE

@@ -1,21 +1,22 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Sigurd Fosseng <sigurd@fosseng.net>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Sigurd Fosseng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,163 @@
+# mor
+
+A shared memory store for humans and AI. Plain markdown files with SQLite full-text search.
+
+Use it as a **CLI**, an **MCP server** (Claude Code, Claude Desktop, Cursor, etc.), or an **HTTP server** for accessing memories across machines.
+
+## Install
+
+```sh
+npm install -g mor
+```
+
+Requires Node.js 20+.
+
+## Quick start
+
+```sh
+# Add memories
+echo "Always use snake_case for Python variables" | mor add -t "Python naming"
+mor add notes.md -t "Meeting notes" --tags "meeting,project-x"
+mor add https://raw.githubusercontent.com/owner/repo/main/config.ts
+
+# Search (FTS5 — tokenized, stemmed)
+mor find "python naming"
+
+# Grep (literal substring — exact matches)
+mor grep "snake_case"
+mor grep -i "todo"
+
+# Read, edit, copy, remove
+mor cat "python naming"
+mor edit "python naming"
+mor cp "python naming" ./out.md
+mor rm "python naming"
+
+# List
+mor ls
+mor ls -l
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `find <query>` | Full-text search (`-n` limit, `-l` long) |
+| `grep <pattern>` | Literal substring search (`-n` limit, `-i` case-insensitive, `-l` long) |
+| `add [file\|url]` | Add from file, URL, stdin, or `$EDITOR` (`-t` title, `-d` description, `--tags`, `--type`) |
+| `cat <query>` | Print content (`--raw` for frontmatter) |
+| `cp <query> <dest>` | Copy content to file |
+| `edit <query>` | Open in `$EDITOR` (`--raw` to edit frontmatter) |
+| `update <query>` | Update metadata or content (`-t` title, `-d` description, `--tags`, `--type`, stdin for content) |
+| `rm <query>` | Remove a memory |
+| `ls` | List all (`-n` limit, `-l` long) |
+| `push` | Git commit and push the memory folder |
+| `reindex` | Rebuild search index |
+| `import <dir>` | Import `.md` files from a directory |
+| `mcp` | Start MCP server (stdio) |
+| `serve` | Start HTTP server (`-p` port, `-H` host, `--token`, `--mcp`) |
+
+Queries resolve in order: full UUID, UUID prefix (4+ chars), filename, FTS search.
+
+`find`, `grep`, and `ls` support shared filters: `--type`, `--tag`, `--repo`, `--ext` (all support glob patterns).
+
+## MCP server
+
+Add to your Claude Code or Claude Desktop config:
+
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "mor",
+      "args": ["mcp"]
+    }
+  }
+}
+```
+
+Tools: `memory_search`, `memory_read`, `memory_add`, `memory_update`, `memory_remove`, `memory_list`.
+
+To make sure Claude Code checks mor first when you ask it to recall something, add this to `~/.claude/CLAUDE.md`:
+
+```markdown
+## Memory
+
+When the user asks to recall, find, check, or reuse something they previously saved
+or remembered — use the `mor` MCP server tools (`memory_search`, `memory_read`,
+`memory_list`). This is the user's primary memory store containing code snippets,
+files, and reference notes. Always check mor before saying something wasn't found.
+```
+
+## Remote access
+
+Run the server on one machine, access from anywhere:
+
+```sh
+# Server
+mor serve --port 7677
+```
+
+```jsonc
+// Client — ~/.config/mor/config.json
+{
+  "server": {
+    "url": "http://mybox.tail1234.ts.net:7677",
+    "token": "optional-secret"
+  }
+}
+```
+
+All CLI commands and MCP tools transparently proxy over HTTP when `server` is configured.
+
+### HTTP API
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health` | Health check |
+| `GET` | `/memories` | List all |
+| `GET` | `/memories/search?q=...&limit=N` | FTS search |
+| `GET` | `/memories/grep?q=...&limit=N&ignoreCase=1` | Literal substring search |
+| `GET` | `/memories/:query` | Read one |
+| `POST` | `/memories` | Create (`{title, content, tags?, type?}`) |
+| `PUT` | `/memories/:query` | Update (`{title?, content?, tags?, type?}`) |
+| `DELETE` | `/memories/:query` | Remove |
+
+Auth: `Authorization: Bearer <token>` header when token is configured.
+
+## Embeddings (experimental)
+
+Optionally augment FTS search with vector similarity. Configure in `~/.config/mor/config.json`:
+
+```json
+{
+  "embedding": {
+    "provider": "openai",
+    "model": "text-embedding-3-small",
+    "dimensions": 1536
+  }
+}
+```
+
+Providers: `openai` (or compatible API via `baseUrl`), `azure-openai`, `ollama`. Run `mor reindex` after configuring.
+
+Azure OpenAI uses `AZURE_OPENAI_API_KEY` (or `apiKey` in config) and requires a `deployment` name (defaults to model name).
+
+## Storage
+
+Memories are markdown files with YAML frontmatter, stored in `~/.config/mor/memories/` with a SQLite index at `~/.config/mor/index.db`. Override with `MOR_HOME`.
+
+```
+~/.config/mor/
+  config.json
+  index.db
+  memories/
+    python-naming-a1b2.md
+    meeting-notes-c3d4.md
+```
+
+Files are human-readable and git-friendly. Use `mor push` to commit and push if the memory folder is a git repo.
+
+## License
+
+MIT

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};