cozo-memory 1.0.0 → 1.0.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 +52 -1
- package/dist/index.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,18 @@ A local, single-user memory system based on CozoDB with MCP (Model Context Proto
|
|
|
6
6
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
9
|
+
### Option 1: Install via npm (Recommended)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# Install globally
|
|
13
|
+
npm install -g cozo-memory
|
|
14
|
+
|
|
15
|
+
# Or run directly with npx (no installation needed)
|
|
16
|
+
npx cozo-memory
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Option 2: Build from Source
|
|
20
|
+
|
|
9
21
|
```bash
|
|
10
22
|
git clone https://github.com/tobs-code/cozo-memory
|
|
11
23
|
cd cozo-memory
|
|
@@ -141,9 +153,21 @@ This tool (`src/benchmark.ts`) performs the following tests:
|
|
|
141
153
|
- Node.js 20+ (recommended)
|
|
142
154
|
- CozoDB native dependency is installed via `cozo-node`.
|
|
143
155
|
|
|
144
|
-
###
|
|
156
|
+
### Via npm (Easiest)
|
|
145
157
|
|
|
146
158
|
```bash
|
|
159
|
+
# Install globally
|
|
160
|
+
npm install -g cozo-memory
|
|
161
|
+
|
|
162
|
+
# Or use npx without installation
|
|
163
|
+
npx cozo-memory
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### From Source
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
git clone https://github.com/tobs-code/cozo-memory
|
|
170
|
+
cd cozo-memory
|
|
147
171
|
npm install
|
|
148
172
|
npm run build
|
|
149
173
|
```
|
|
@@ -174,6 +198,33 @@ Default database path: `memory_db.cozo.db` in project root (created automaticall
|
|
|
174
198
|
|
|
175
199
|
### Claude Desktop Integration
|
|
176
200
|
|
|
201
|
+
#### Using npx (Recommended)
|
|
202
|
+
|
|
203
|
+
```json
|
|
204
|
+
{
|
|
205
|
+
"mcpServers": {
|
|
206
|
+
"cozo-memory": {
|
|
207
|
+
"command": "npx",
|
|
208
|
+
"args": ["cozo-memory"]
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
#### Using global installation
|
|
215
|
+
|
|
216
|
+
```json
|
|
217
|
+
{
|
|
218
|
+
"mcpServers": {
|
|
219
|
+
"cozo-memory": {
|
|
220
|
+
"command": "cozo-memory"
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
#### Using local build
|
|
227
|
+
|
|
177
228
|
```json
|
|
178
229
|
{
|
|
179
230
|
"mcpServers": {
|
package/dist/index.js
CHANGED
package/package.json
CHANGED