docs: clarify that npm global install is SDK-only, not plugin setup (#1103)

Users may assume `npm install -g claude-mem` sets up the full plugin,
but it only installs the SDK/library. Added a note to both the README
and the installation guide making this distinction explicit.

Co-authored-by: Markus <glucksberg89@gmail.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Glucksberg
2026-02-16 01:25:45 -04:00
committed by GitHub
parent aa6090c04b
commit 8287ad960a
2 changed files with 6 additions and 0 deletions
+2
View File
@@ -118,6 +118,8 @@ Start a new Claude Code session in the terminal and enter the following commands
Restart Claude Code. Context from previous sessions will automatically appear in new sessions.
> **Note:** Claude-Mem is also published on npm, but `npm install -g claude-mem` installs the **SDK/library only** — it does not register the plugin hooks or set up the worker service. To use Claude-Mem as a plugin, always install via the `/plugin` commands above.
### 🦞 OpenClaw Gateway
Install claude-mem as a persistent memory plugin on [OpenClaw](https://openclaw.ai) gateways with a single command:
+4
View File
@@ -22,6 +22,10 @@ That's it! The plugin will automatically:
Start a new Claude Code session and you'll see context from previous sessions automatically loaded.
> **Important:** Claude-Mem is published on npm, but running `npm install -g claude-mem` installs the
> **SDK/library only**. It does **not** register plugin hooks or start the worker service.
> To use Claude-Mem as a persistent memory plugin, always install via the `/plugin` commands above.
## System Requirements
- **Node.js**: 18.0.0 or higher