@aman_asmuei/amem 0.10.1 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -31
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -66,18 +66,31 @@ No cloud. No API keys. Everything stays on your machine.
66
66
 
67
67
  ## Getting Started
68
68
 
69
- ### Step 1: Install
69
+ ### Option A: Claude Code Plugin (recommended for Claude Code users)
70
+
71
+ One command — gives you MCP tools + lifecycle hooks + slash commands + auto-config:
70
72
 
71
73
  ```bash
72
- npm install -g @aman_asmuei/amem
74
+ /plugin marketplace add amanasmuei/amem
75
+ /plugin install amem
73
76
  ```
74
77
 
75
- ### Step 2: Auto-Configure
78
+ That's it. You get:
79
+ - **28 MCP tools** auto-registered
80
+ - **Lifecycle hooks** — PostToolUse (captures observations) + Stop (auto-summarizes sessions)
81
+ - **5 slash commands** — `/amem:remember`, `/amem:recall`, `/amem:sync`, `/amem:dashboard`, `/amem:context`
82
+ - **CLAUDE.md** context injected every session
83
+
84
+ ### Option B: MCP Server (works with any MCP client)
85
+
86
+ For Claude Code, Cursor, Windsurf, GitHub Copilot, or any MCP-compatible tool:
76
87
 
77
88
  ```bash
78
- amem-cli init # Detects & configures Claude Code, Cursor, Windsurf, GitHub Copilot
79
- amem-cli rules # Generates extraction rules so your AI uses amem proactively
80
- amem-cli hooks # Installs automatic memory capture (PostToolUse + SessionEnd)
89
+ npm install -g @aman_asmuei/amem
90
+ amem-cli init # Detects & configures all installed AI tools
91
+ amem-cli rules # Generates extraction rules for proactive memory use
92
+ amem-cli hooks # Installs automatic capture hooks (Claude Code only)
93
+ amem-cli sync # Imports Claude auto-memory into amem
81
94
  ```
82
95
 
83
96
  <details>
@@ -85,21 +98,22 @@ amem-cli hooks # Installs automatic memory capture (PostToolUse + SessionEnd
85
98
 
86
99
  | Command | What it does |
87
100
  |---|---|
88
- | `amem-cli init` | Finds your installed AI tools and adds amem to their MCP server config. Works with Claude Code (`~/.claude/settings.json`), Cursor (`~/.cursor/mcp.json`), Windsurf (`~/.windsurf/mcp.json`), and GitHub Copilot. |
89
- | `amem-cli rules` | Writes a set of memory extraction guidelines to your tool's rules file (e.g., `CLAUDE.md`, `.cursorrules`). This teaches the AI *when* and *how* to store memories. |
90
- | `amem-cli hooks` | Installs Claude Code lifecycle hooks that passively capture tool observations (PostToolUse) and auto-summarize sessions on exit (Stop). Memories accumulate without you asking. |
101
+ | `amem-cli init` | Finds your installed AI tools and adds amem to their MCP server config. Works with Claude Code, Cursor, Windsurf, and GitHub Copilot. |
102
+ | `amem-cli rules` | Writes extraction guidelines to your tool's rules file (`CLAUDE.md`, `.cursorrules`, etc.). Teaches the AI *when* and *how* to store memories. |
103
+ | `amem-cli hooks` | Installs Claude Code lifecycle hooks for passive capture (PostToolUse + Stop). |
104
+ | `amem-cli sync` | Imports Claude Code auto-memory files into amem for unified structured access. |
91
105
 
92
106
  </details>
93
107
 
94
108
  <details>
95
- <summary><strong>Or configure manually (Claude Code)</strong></summary>
109
+ <summary><strong>Manual MCP configuration</strong></summary>
96
110
 
111
+ **Claude Code:**
97
112
  ```bash
98
113
  claude mcp add amem -- npx -y @aman_asmuei/amem
99
114
  ```
100
115
 
101
- Or add to `~/.claude/settings.json`:
102
-
116
+ **Cursor / Windsurf / Other MCP Clients:**
103
117
  ```json
104
118
  {
105
119
  "mcpServers": {
@@ -113,31 +127,14 @@ Or add to `~/.claude/settings.json`:
113
127
 
114
128
  </details>
115
129
 
116
- <details>
117
- <summary><strong>Or configure manually (Cursor / Windsurf / Other MCP Clients)</strong></summary>
118
-
119
- ```json
120
- {
121
- "mcpServers": {
122
- "amem": { "command": "amem" }
123
- }
124
- }
125
- ```
126
-
127
- </details>
128
-
129
- ### Step 3: Restart Your AI Tool
130
-
131
- You'll see **28 tools**, **6 resources**, and **2 prompts** ready to go.
132
-
133
- ### Step 4: Verify
130
+ ### Verify Installation
134
131
 
135
132
  ```bash
136
133
  amem-cli stats # Should show "0 memories" initially
137
134
  amem-cli dashboard # Opens web dashboard at localhost:3333
138
135
  ```
139
136
 
140
- Then start a conversation and tell your AI:
137
+ Start a conversation and tell your AI:
141
138
 
142
139
  > *"Remember: always use strict TypeScript, never use any type"*
143
140
 
@@ -147,6 +144,16 @@ Start a **new** conversation and ask:
147
144
 
148
145
  It should recall the correction instantly.
149
146
 
147
+ ### Slash Commands (Plugin only)
148
+
149
+ | Command | What it does |
150
+ |---|---|
151
+ | `/amem:remember "never use any"` | Quick-store a memory with auto type detection |
152
+ | `/amem:recall "auth architecture"` | Quick search with progressive disclosure |
153
+ | `/amem:context` | Load full context for the current task |
154
+ | `/amem:sync` | Import Claude auto-memory into amem |
155
+ | `/amem:dashboard` | Open the web dashboard |
156
+
150
157
  ---
151
158
 
152
159
  ## How It Works
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aman_asmuei/amem",
3
- "version": "0.10.1",
3
+ "version": "0.11.0",
4
4
  "description": "The memory layer for AI coding tools. Local-first, developer-specific, works everywhere.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",