memshell 0.1.0 → 0.1.2
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 +18 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
<p><strong>Persistent memory for AI agents.</strong><br>One line to save. One line to recall.</p>
|
|
6
6
|
|
|
7
|
-
[](https://www.npmjs.com/package/mem.sh)
|
|
7
|
+
[](https://www.npmjs.com/package/memshell)
|
|
8
|
+
[](https://github.com/justedv/mem.sh/blob/main/LICENSE)
|
|
10
9
|
[](https://github.com/justedv/mem.sh)
|
|
11
10
|
|
|
12
11
|
<br>
|
|
@@ -17,13 +16,19 @@
|
|
|
17
16
|
|
|
18
17
|
---
|
|
19
18
|
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm i memshell
|
|
23
|
+
```
|
|
24
|
+
|
|
20
25
|
## Why mem.sh?
|
|
21
26
|
|
|
22
27
|
Agents forget everything between sessions. **mem.sh** gives them a brain.
|
|
23
28
|
|
|
24
29
|
| | mem.sh | LangChain Memory | Roll your own |
|
|
25
30
|
|---|---|---|---|
|
|
26
|
-
| **Setup** | `npx
|
|
31
|
+
| **Setup** | `npx memshell set "..."` | 47 dependencies + config | Hours of boilerplate |
|
|
27
32
|
| **External APIs** | None | OpenAI key required | Depends |
|
|
28
33
|
| **Semantic search** | Built-in TF-IDF | Embedding models | You build it |
|
|
29
34
|
| **Storage** | SQLite (local) | Varies | You choose |
|
|
@@ -42,26 +47,26 @@ Agents forget everything between sessions. **mem.sh** gives them a brain.
|
|
|
42
47
|
|
|
43
48
|
```bash
|
|
44
49
|
# Store a memory
|
|
45
|
-
npx
|
|
50
|
+
npx memshell set "user prefers dark mode"
|
|
46
51
|
|
|
47
52
|
# Recall semantically
|
|
48
|
-
npx
|
|
53
|
+
npx memshell recall "what theme does the user like?"
|
|
49
54
|
# → user prefers dark mode (score: 0.87)
|
|
50
55
|
|
|
51
56
|
# List all memories
|
|
52
|
-
npx
|
|
57
|
+
npx memshell list
|
|
53
58
|
|
|
54
59
|
# Forget a specific memory
|
|
55
|
-
npx
|
|
60
|
+
npx memshell forget <id>
|
|
56
61
|
|
|
57
62
|
# Wipe everything
|
|
58
|
-
npx
|
|
63
|
+
npx memshell clear
|
|
59
64
|
```
|
|
60
65
|
|
|
61
66
|
### SDK
|
|
62
67
|
|
|
63
68
|
```js
|
|
64
|
-
const mem = require('
|
|
69
|
+
const mem = require('memshell');
|
|
65
70
|
|
|
66
71
|
// Store
|
|
67
72
|
await mem.set('user prefers dark mode');
|
|
@@ -94,7 +99,7 @@ Memories are stored in `~/.mem/mem.db` (SQLite). Each memory is tokenized and ve
|
|
|
94
99
|
Run a shared memory server for multiple agents:
|
|
95
100
|
|
|
96
101
|
```bash
|
|
97
|
-
npx
|
|
102
|
+
npx memshell serve --port 3456 --key my-secret-key
|
|
98
103
|
```
|
|
99
104
|
|
|
100
105
|
### Endpoints
|
|
@@ -129,7 +134,7 @@ curl "http://localhost:3456/mem/recall?q=theme+preference" \
|
|
|
129
134
|
### SDK with API Mode
|
|
130
135
|
|
|
131
136
|
```js
|
|
132
|
-
const mem = require('
|
|
137
|
+
const mem = require('memshell');
|
|
133
138
|
|
|
134
139
|
mem.configure({
|
|
135
140
|
api: 'http://localhost:3456',
|
|
@@ -153,5 +158,5 @@ We welcome contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
|
153
158
|
|
|
154
159
|
<div align="center">
|
|
155
160
|
<sub>Built for agents that need to remember.</sub><br>
|
|
156
|
-
<a href="https://www.npmjs.com/package/
|
|
161
|
+
<a href="https://www.npmjs.com/package/memshell">npm</a> · <a href="https://github.com/justedv/mem.sh">GitHub</a> · <a href="https://github.com/justedv/mem.sh/issues">Issues</a>
|
|
157
162
|
</div>
|