@tznthou/ccrecall 0.1.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,290 @@
+# ccRecall
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8+-3178C6.svg)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-20--22-339933.svg)](https://nodejs.org/)
+[![SQLite](https://img.shields.io/badge/SQLite-FTS5-003B57.svg)](https://www.sqlite.org/)
+
+[中文版](README_ZH.md)
+
+A local memory service for Claude Code — indexes your conversation history, recalls relevant context on demand, and injects it into future sessions. Zero API cost.
+
+---
+
+## Core Concept
+
+Every time you start a new Claude Code session, the AI forgets everything. The architecture you spent 20 minutes explaining, the bug you debugged together, the decisions you made — all gone. You start over.
+
+CLAUDE.md and RESUME.md help, but they're static files you maintain by hand. ccRecall automates this: it reads your JSONL conversation logs, builds a searchable index, and serves relevant memories back to Claude Code through hooks and MCP tools. The AI remembers what it learned — you don't have to remind it.
+
+ccRecall is the "memory" counterpart to [ccRewind](https://github.com/tznthou/ccRewind) (a conversation replay GUI). ccRewind lets humans look back at what happened; ccRecall lets the AI remember what happened.
+
+> **Note:** This project is unrelated to [spences10/ccrecall](https://github.com/spences10/ccrecall), an analytics-focused tool that happens to share the name. Because the npm package `ccrecall` is already taken, we publish as `@tznthou/ccrecall` and the CLI binary is named `ccmem`.
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Rule-based summarization** | Extracts intent, activity, outcome, and tags from sessions — no LLM calls, zero API cost |
+| **FTS5 full-text search** | Sub-100ms keyword search across all conversation history, fast enough for hook injection |
+| **Incremental indexing** | Only re-indexes sessions that changed (mtime diffing), handles resumed sessions via UUID dedup |
+| **Metacognition** | `knowledge_map` aggregates topic mentions from sessions + memories. Depth derived from mention count (shallow / medium / deep). Exposed via `/metacognition/check` and MCP `recall_context` |
+| **Forgetting curve** | Memories compress over time: raw → summary → one-liner → deleted. Confidence decays on unused memories. Background maintenance tick runs every 5 min |
+| **Watch mode** | chokidar-based JSONL watcher picks up new sessions within 2 s; periodic 10 min full-resync covers missed filesystem events |
+| **Rescue reindex** | `/session/end` retries a reindex on cache miss — no fresh-session race between the hook and the daemon |
+| **Auto-start (macOS)** | `ccmem install-daemon` registers a LaunchAgent so the service stays up across reboots |
+| **Read-only** | Never modifies `~/.claude/` — only reads JSONL logs |
+
+---
+
+## Architecture
+
+```mermaid
+flowchart TB
+    subgraph Input["Data Source (read-only)"]
+        JSONL["~/.claude/projects/*/*.jsonl"]
+    end
+
+    subgraph Core["ccRecall Service (port 7749)"]
+        Scanner["Scanner<br/>find JSONL files"]
+        Parser["Parser<br/>parse conversations"]
+        Summarizer["Summarizer<br/>rule-based extraction"]
+        DB["SQLite + FTS5<br/>index & search"]
+        API["HTTP API<br/>7 endpoints"]
+    end
+
+    subgraph Consumers["Context Injection"]
+        Hook["Claude Code Hooks<br/>SessionStart / SessionEnd"]
+        MCP["MCP Server<br/>recall_query / recall_save"]
+    end
+
+    JSONL --> Scanner --> Parser --> Summarizer --> DB
+    DB --> API
+    API --> Hook
+    API --> MCP
+```
+
+---
+
+## Tech Stack
+
+| Technology | Purpose | Notes |
+|------------|---------|-------|
+| Node.js 20–22 + TypeScript | Runtime | ES modules, strict mode |
+| better-sqlite3 | Database | Synchronous API, zero external deps |
+| FTS5 | Full-text search | Built into SQLite, unicode61 tokenizer |
+| Native `http` | HTTP server | No Express — minimal surface, localhost only |
+| chokidar | Filesystem watcher | Cross-platform JSONL change detection with 2 s debounce + single-flight |
+| vitest | Testing | 396 tests across 26 files, integration-style |
+| `@modelcontextprotocol/sdk` | MCP server | stdio transport, shared SQLite via WAL |
+
+---
+
+## Quick Start
+
+### Prerequisites
+
+- Node.js `>=20.0.0,<23.0.0`
+- pnpm
+
+### Installation
+
+```bash
+git clone https://github.com/tznthou/ccRecall.git
+cd ccRecall
+
+pnpm install
+
+# Start development server (auto-indexes on startup, watches ~/.claude/projects)
+pnpm dev
+```
+
+The service starts at `http://127.0.0.1:7749` and indexes all JSONL files in `~/.claude/projects/`.
+
+### Verify
+
+```bash
+# Health check — should show sessionCount > 0
+curl http://127.0.0.1:7749/health
+
+# Search your conversation history
+curl "http://127.0.0.1:7749/memory/query?q=authentication&limit=5"
+```
+
+---
+
+## API Endpoints
+
+| Endpoint | Method | Description | Status |
+|----------|--------|-------------|--------|
+| `/health` | GET | Service health + DB stats | Live |
+| `/memory/query?q=...&limit=...&project=...` | GET | FTS5 search across memories with optional project filter | Live |
+| `/memory/save` | POST | Save a memory entry (origin-checked) | Live |
+| `/session/end` | POST | Harvest a finished session's summary into a memory (idempotent) | Live |
+| `/memory/context?session_id=...` | GET | Session context lookup | Stub |
+| `/metacognition/check?projectId=...[&topic=...]` | GET | Knowledge map: summary (top/recent/stale topics + counts) or topic detail (memories + related topics) | Live |
+| `/session/checkpoint` | POST | Mid-session snapshot into dedicated `session_checkpoints` table (not harvested as memory) | Live |
+| `/lint/warnings` | GET | Lint report: orphan (session deleted) + stale (low-confidence, long-idle) memory warnings | Live |
+
+## MCP Tools
+
+| Tool | Purpose |
+|------|---------|
+| `recall_query` | Raw FTS5 keyword search across memories |
+| `recall_context` | Topic-clustered retrieval — normalizes keywords, groups memories by matched topic with depth signals, falls back to per-keyword FTS if no topic matches |
+| `recall_save` | Store a new memory (type: decision / discovery / preference / pattern / feedback) |
+
+Expose them to Claude Code. After `pnpm build`, the `ccmem-mcp` bin is on
+the repo's `node_modules/.bin` path — point `claude mcp add` at it or at a
+global install:
+
+```bash
+# Using the built bin (after pnpm build)
+claude mcp add ccrecall --scope user -- /absolute/path/to/ccRecall/dist/mcp/server.js
+
+# Or using tsx for development (no build step)
+claude mcp add ccrecall --scope user -- /absolute/path/to/ccRecall/node_modules/.bin/tsx /absolute/path/to/ccRecall/src/mcp/server.ts
+```
+
+A ready-to-copy example lives at [.mcp.json.example](.mcp.json.example).
+
+See [hooks/README.md](hooks/README.md) for SessionStart / SessionEnd hook installation.
+
+---
+
+## Running as a service (macOS)
+
+ccRecall runs as a local HTTP daemon. To keep it up across reboots, register
+a per-user LaunchAgent:
+
+```bash
+pnpm build
+node dist/index.js install-daemon        # or `ccmem install-daemon` if globally linked
+node dist/index.js install-daemon --dry-run   # preview plist without writing
+
+# verify
+launchctl list | grep ccrecall
+curl http://127.0.0.1:7749/health
+
+# remove
+node dist/index.js uninstall-daemon
+```
+
+The installer:
+- writes `~/Library/LaunchAgents/com.tznthou.ccrecall.plist`
+- routes logs to `~/Library/Logs/ccrecall/ccrecall.{out,err}.log`
+- propagates `CCRECALL_PORT` / `CCRECALL_DB_PATH` from the current shell into
+  the plist, so the LaunchAgent uses the same settings as your interactive run
+- refuses to touch a plist whose `Label` isn't ccRecall's (safety check)
+
+Full manual-install, troubleshooting, and uninstall docs:
+[docs/launchd.md](docs/launchd.md).
+
+Linux/Windows equivalents (systemd unit, Windows service) are planned for
+Phase 5. For now, run under `nohup` or your process manager of choice.
+
+---
+
+## Project Structure
+
+```
+ccRecall/
+├── src/
+│   ├── core/
+│   │   ├── types.ts              # All type definitions
+│   │   ├── parser.ts             # JSONL conversation parser
+│   │   ├── scanner.ts            # File system scanner
+│   │   ├── summarizer.ts         # Rule-based session summarizer
+│   │   ├── topic-extractor.ts    # Rule-based topic extraction
+│   │   ├── database.ts           # SQLite + FTS5 (trimmed from ccRewind)
+│   │   ├── indexer.ts            # Indexing pipeline orchestrator
+│   │   ├── memory-service.ts     # Memory lifecycle (touch / delete / update)
+│   │   ├── compression.ts        # L0→L1→L2→delete state machine
+│   │   ├── lint.ts               # Orphan / stale memory detection
+│   │   ├── maintenance-coordinator.ts  # Background compression tick
+│   │   ├── watcher.ts            # chokidar JSONL watcher (Phase 4e)
+│   │   └── log-safe.ts           # scrubErrorMessage — log-injection defence
+│   ├── api/
+│   │   ├── server.ts             # HTTP server
+│   │   └── routes.ts             # Request routing + rescue reindex
+│   ├── mcp/
+│   │   ├── server.ts             # MCP stdio server entry (shebang bin)
+│   │   └── tools.ts              # recall_query + recall_context + recall_save
+│   ├── cli/
+│   │   └── daemon.ts             # install-daemon / uninstall-daemon (macOS)
+│   └── index.ts                  # HTTP entry point + subcommand dispatch
+├── hooks/
+│   ├── session-start.mjs         # Inject memories on SessionStart (stdout)
+│   ├── session-end.mjs           # POST /session/end on SessionEnd
+│   └── README.md                 # Hook installation guide
+├── docs/
+│   └── launchd.md                # macOS LaunchAgent install/troubleshoot
+├── tests/                        # 396 tests across 26 files (parser / scanner /
+│   │                             # summarizer / database / indexer / e2e /
+│   │                             # memories / mcp / session-end / compression /
+│   │                             # lint / watcher / bin-smoke / cli-daemon /
+│   │                             # migration-v18 / decay / maintenance-coordinator /
+│   │                             # memory-service / memory-project-scope / touch /
+│   │                             # hooks-session-start / hooks-session-end /
+│   │                             # knowledge-map / topic-extractor / metacognition /
+│   │                             # session-checkpoint)
+│   └── fixtures/                 # Sample JSONL + shared test helpers
+├── .mcp.json.example             # MCP client config template
+├── NOTICE / SECURITY.md / CONTRIBUTING.md / CODE_OF_CONDUCT.md
+└── .claude/
+    └── pi-research/              # Architecture research documents
+```
+
+---
+
+## Related Projects
+
+- **[ccRewind](https://github.com/user/ccRewind)** — Session replay GUI for Claude Code. ccRecall's core modules (parser, scanner, summarizer, database, indexer) were extracted from ccRewind.
+
+---
+
+## Reflections
+
+### Why This Exists
+
+Thariq from Anthropic's Claude Code team [wrote about context management](https://x.com/trq212) in April 2026 — 11,908 bookmarks, because everyone saved it to re-read but nobody had the tools to actually do it. He described the problem perfectly: context rot degrades model performance in long sessions, and autocompact fires at the worst possible moment.
+
+But he gave methodology, not tools. ccRecall is the tool.
+
+The real trigger was simpler: I kept re-explaining the same architecture to Claude Code across sessions. Not because the AI is bad at remembering — it literally can't. Every session starts from zero. CLAUDE.md helps, but it's a static file I maintain by hand. The maintenance cost grows faster than the value. Sound familiar? That's exactly why humans abandon wikis too (Karpathy's LLM Wiki insight).
+
+### Design Decisions
+
+**Rule-based summarizer instead of LLM calls.** claude-mem uses the Claude API for summarization — you're paying AI money to help AI remember. ccRecall uses heuristic extraction (regex patterns, tool usage analysis, outcome inference). It's less sophisticated but costs exactly zero. For session summaries, "Edit x8, 5 files, committed" is more useful than a paragraph of prose anyway.
+
+**FTS5 instead of vector database.** Semantic search sounds better on paper, but for conversation logs — where you're searching for specific tools, file paths, error messages — keyword matching wins. FTS5 queries run in <10ms locally. No embedding model, no Chroma, no Docker container. At the scale we're operating (hundreds of sessions, not millions of documents), Karpathy's own analysis confirms: "plain index + keyword search is already sufficient under 500 sources."
+
+**HTTP + MCP dual interface.** Research showed that MCP server tools are the most stable way to inject context into Claude (pull-based, Claude decides when to fetch). But SessionStart hooks (push-based, automatic) are also stable. So ccRecall runs both: HTTP for hooks, MCP for on-demand queries. Same SQLite backend, two access patterns.
+
+**Read-only constraint.** ccRecall never modifies `~/.claude/`. This isn't just politeness — it's a trust boundary. If a background service can write to your Claude Code config, one bug could corrupt your sessions. Read-only means the worst case is "ccRecall gives bad search results," not "ccRecall broke my setup."
+
+### Non-goals
+
+**No Docker, no Electron, no vector database.** These are deliberate exclusions, not missing features. Docker adds deployment friction for what should be a `pnpm dev` experience. Electron is for GUIs — ccRecall has no UI (that's ccRewind's job). Vector databases solve a problem we don't have at this scale.
+
+**No LLM dependency for any operation.** If ccRecall needs an API key to function, it has failed. The whole point is zero-cost memory that runs locally. Summarization is rule-based. Search is FTS5. The day we need LLM calls is the day we've overscoped.
+
+**No "smart" memory injection.** ccRecall doesn't decide what Claude should remember. It provides a search API — the injection layer (hooks, MCP) presents results, and Claude integrates them. Opinionated memory selection is a premature optimization that would be wrong in ways we can't predict.
+
+**No modification of user data.** ccRecall reads `~/.claude/projects/` JSONL files. It never writes to that directory, never modifies session files, never injects itself into Claude Code's config automatically. The user explicitly configures hooks and MCP — ccRecall doesn't install itself.
+
+---
+
+## License
+
+Licensed under the Apache License, Version 2.0 — see [LICENSE](LICENSE).
+
+Copyright 2026 tznthou
+
+---
+
+## Author
+
+tznthou — [tznthou.com](https://tznthou.com) · [tznthou@gmail.com](mailto:tznthou@gmail.com)