@aman_asmuei/amem 0.10.1 → 0.11.1
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.
- package/README.md +40 -31
- 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
|
-
###
|
|
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
|
-
|
|
74
|
+
/plugin marketplace add amanasmuei/amem
|
|
75
|
+
/plugin install amem
|
|
73
76
|
```
|
|
74
77
|
|
|
75
|
-
|
|
78
|
+
That's it. You get:
|
|
79
|
+
- **28 MCP tools** auto-registered
|
|
80
|
+
- **Lifecycle hooks** — PostToolUse (captures observations) + Stop (auto-summarizes sessions)
|
|
81
|
+
- **5 AI skills** — the AI automatically uses `amem:remember`, `amem:recall`, `amem:context`, `amem:sync`, `amem:dashboard` based on your intent
|
|
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
|
-
|
|
79
|
-
amem-cli
|
|
80
|
-
amem-cli
|
|
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
|
|
89
|
-
| `amem-cli rules` | Writes
|
|
90
|
-
| `amem-cli hooks` | Installs Claude Code lifecycle hooks
|
|
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>
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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,18 @@ Start a **new** conversation and ask:
|
|
|
147
144
|
|
|
148
145
|
It should recall the correction instantly.
|
|
149
146
|
|
|
147
|
+
### AI Skills (Plugin only)
|
|
148
|
+
|
|
149
|
+
The plugin includes 5 skills that the AI invokes automatically based on your intent. Just speak naturally:
|
|
150
|
+
|
|
151
|
+
| What you say | Skill triggered | What happens |
|
|
152
|
+
|---|---|---|
|
|
153
|
+
| *"Remember never use any type"* | `amem:remember` | Stores as a correction with confidence 1.0 |
|
|
154
|
+
| *"What do you remember about auth?"* | `amem:recall` | Searches memories with progressive disclosure |
|
|
155
|
+
| *"Load context for this task"* | `amem:context` | Injects corrections, decisions, and core memories |
|
|
156
|
+
| *"Sync my Claude memory"* | `amem:sync` | Imports Claude auto-memory into amem |
|
|
157
|
+
| *"Open the memory dashboard"* | `amem:dashboard` | Launches web dashboard at localhost:3333 |
|
|
158
|
+
|
|
150
159
|
---
|
|
151
160
|
|
|
152
161
|
## How It Works
|