@memclaw/memclaw 0.9.9 → 0.9.11
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/dist/index.js +23 -23
- package/dist/index.js.map +1 -1
- package/dist/plugin-impl.d.ts +7 -33
- package/dist/plugin-impl.d.ts.map +1 -1
- package/dist/plugin-impl.js +168 -170
- package/dist/plugin-impl.js.map +1 -1
- package/dist/src/binaries.d.ts.map +1 -1
- package/dist/src/binaries.js +89 -15
- package/dist/src/binaries.js.map +1 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/config.js +70 -66
- package/dist/src/config.js.map +1 -1
- package/openclaw.plugin.json +1 -1
- package/package.json +1 -1
- package/skill/SKILL.md +21 -3
- package/skill/references/maintenance.md +64 -29
- package/skill/references/setup.md +29 -1
package/openclaw.plugin.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@memclaw/memclaw",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.11",
|
|
4
4
|
"description": "MemClaw - The Cortex Memory plugin for OpenClaw. Layered semantic memory for OpenClaw with easy setup and migration",
|
|
5
5
|
"homepage": "https://github.com/sopaco/cortex-mem",
|
|
6
6
|
"repository": {
|
package/skill/SKILL.md
CHANGED
|
@@ -28,8 +28,10 @@ The search engine queries all three layers internally and returns unified result
|
|
|
28
28
|
### Step 1: Check if Plugin is Installed
|
|
29
29
|
|
|
30
30
|
Check if `@memclaw/memclaw` is in the OpenClaw plugins list:
|
|
31
|
-
- Look for `memclaw` in
|
|
32
|
-
- Or check `plugins.installs` in
|
|
31
|
+
- Look for `memclaw` in `{claw-data-dir}/extensions/`
|
|
32
|
+
- Or check `plugins.installs` in your Claw config file
|
|
33
|
+
|
|
34
|
+
> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. Use your actual Claw data directory for custom versions.
|
|
33
35
|
|
|
34
36
|
### Step 2: Install if Missing
|
|
35
37
|
|
|
@@ -64,7 +66,23 @@ Enable MemClaw in your `openclaw.json`:
|
|
|
64
66
|
|
|
65
67
|
Restart OpenClaw to activate the plugin and start services.
|
|
66
68
|
|
|
67
|
-
|
|
69
|
+
## Binary File Locations
|
|
70
|
+
|
|
71
|
+
The platform-specific binaries (Qdrant, cortex-mem-service, cortex-mem-cli) are installed in:
|
|
72
|
+
|
|
73
|
+
| Platform | Binary Path |
|
|
74
|
+
|----------|-------------|
|
|
75
|
+
| macOS | `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/` |
|
|
76
|
+
| Windows | `{claw-data-dir}\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\` |
|
|
77
|
+
|
|
78
|
+
> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. For custom or modified versions, check your Claw's actual data directory name.
|
|
79
|
+
|
|
80
|
+
**Binaries included:**
|
|
81
|
+
- `qdrant` / `qdrant.exe` — Vector database
|
|
82
|
+
- `cortex-mem-service` / `cortex-mem-service.exe` — Memory service
|
|
83
|
+
- `cortex-mem-cli` / `cortex-mem-cli.exe` — CLI tool
|
|
84
|
+
|
|
85
|
+
> **Note**: The plugin auto-starts these services. You don't need to run them manually.
|
|
68
86
|
|
|
69
87
|
## Pre-Use Requirements
|
|
70
88
|
|
|
@@ -1,42 +1,81 @@
|
|
|
1
1
|
# Maintenance Guide
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Periodic maintenance commands for MemClaw data health.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## CLI Tool Location
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The `cortex-mem-cli` tool is installed with the platform-specific binary package:
|
|
8
8
|
|
|
9
|
-
|
|
|
10
|
-
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
| `layers ensure-all` | Generate missing L0/L1 layer files |
|
|
9
|
+
| Platform | CLI Path |
|
|
10
|
+
|----------|----------|
|
|
11
|
+
| macOS | `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/cortex-mem-cli` |
|
|
12
|
+
| Windows | `{claw-data-dir}\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\cortex-mem-cli.exe` |
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. Use your actual Claw data directory for custom versions.
|
|
16
15
|
|
|
17
|
-
##
|
|
16
|
+
## Maintenance Commands
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
All commands require `--config` and `--tenant` parameters:
|
|
20
19
|
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
```bash
|
|
21
|
+
cortex-mem-cli --config <config-path> --tenant tenant_claw <command>
|
|
22
|
+
```
|
|
24
23
|
|
|
25
|
-
|
|
26
|
-
|
|
24
|
+
Config file location:
|
|
25
|
+
- macOS: `~/Library/Application Support/memclaw/config.toml`
|
|
26
|
+
- Windows: `%LOCALAPPDATA%\memclaw\config.toml`
|
|
27
|
+
|
|
28
|
+
### Vector Maintenance
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# Remove dangling vectors (source files no longer exist)
|
|
32
|
+
cortex-mem-cli --config config.toml --tenant tenant_claw vector prune
|
|
33
|
+
|
|
34
|
+
# Preview without making changes
|
|
35
|
+
cortex-mem-cli --config config.toml --tenant tenant_claw vector prune --dry-run
|
|
36
|
+
|
|
37
|
+
# Rebuild vector index
|
|
38
|
+
cortex-mem-cli --config config.toml --tenant tenant_claw vector reindex
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Layer Maintenance
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Generate missing L0/L1 layer files
|
|
45
|
+
cortex-mem-cli --config config.toml --tenant tenant_claw layers ensure-all
|
|
27
46
|
|
|
28
|
-
|
|
29
|
-
|
|
47
|
+
# Regenerate oversized abstracts
|
|
48
|
+
cortex-mem-cli --config config.toml --tenant tenant_claw layers regenerate-oversized
|
|
30
49
|
```
|
|
31
50
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
51
|
+
## Scheduled Maintenance
|
|
52
|
+
|
|
53
|
+
**You can set up a scheduled task in OpenClaw to run maintenance automatically:**
|
|
54
|
+
|
|
55
|
+
### Option 1: OpenClaw Cron Job
|
|
56
|
+
|
|
57
|
+
Create a Cron Job in OpenClaw that runs every 3 hours:
|
|
58
|
+
|
|
59
|
+
1. **Schedule**: `0 */3 * * *`
|
|
60
|
+
2. **Task**: Execute maintenance commands using the CLI tool
|
|
61
|
+
3. **Commands**:
|
|
62
|
+
```
|
|
63
|
+
cortex-mem-cli --config <config-path> --tenant tenant_claw vector prune
|
|
64
|
+
cortex-mem-cli --config <config-path> --tenant tenant_claw vector reindex
|
|
65
|
+
cortex-mem-cli --config <config-path> --tenant tenant_claw layers ensure-all
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Option 2: Manual Tool Invocation
|
|
69
|
+
|
|
70
|
+
Use the `cortex_maintenance` tool for on-demand maintenance:
|
|
71
|
+
|
|
72
|
+
```json
|
|
73
|
+
{ "dryRun": false }
|
|
74
|
+
```
|
|
36
75
|
|
|
37
76
|
## Diagnostic Commands
|
|
38
77
|
|
|
39
|
-
### Check System
|
|
78
|
+
### Check System Status
|
|
40
79
|
|
|
41
80
|
```bash
|
|
42
81
|
cortex-mem-cli --config config.toml --tenant tenant_claw stats
|
|
@@ -48,16 +87,12 @@ cortex-mem-cli --config config.toml --tenant tenant_claw stats
|
|
|
48
87
|
cortex-mem-cli --config config.toml --tenant tenant_claw layers status
|
|
49
88
|
```
|
|
50
89
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### Check Vector Index Status
|
|
90
|
+
### Check Vector Status
|
|
54
91
|
|
|
55
92
|
```bash
|
|
56
93
|
cortex-mem-cli --config config.toml --tenant tenant_claw vector status
|
|
57
94
|
```
|
|
58
95
|
|
|
59
|
-
Shows total vectors and stale entries.
|
|
60
|
-
|
|
61
96
|
## Quick Fix Flow
|
|
62
97
|
|
|
63
98
|
1. **Search not working well?** → Check `layers status` and `vector status`
|
|
@@ -69,7 +104,7 @@ Shows total vectors and stale entries.
|
|
|
69
104
|
|
|
70
105
|
| Issue | Solution |
|
|
71
106
|
|-------|----------|
|
|
72
|
-
| CLI not found |
|
|
107
|
+
| CLI not found | Check the binary path in `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-{platform}/bin/` |
|
|
73
108
|
| Connection refused | Check cortex-mem-service at `localhost:8085` |
|
|
74
109
|
| Qdrant issues | Verify Qdrant at `localhost:6333` |
|
|
75
110
|
| Layer generation fails | Check LLM API key in config.toml |
|
|
@@ -29,6 +29,34 @@ MemClaw binaries (Qdrant, cortex-mem-service, cortex-mem-cli) are distributed vi
|
|
|
29
29
|
|
|
30
30
|
These packages are installed automatically as optional dependencies when installing `@memclaw/memclaw`.
|
|
31
31
|
|
|
32
|
+
### Binary Locations After Installation
|
|
33
|
+
|
|
34
|
+
When installed via OpenClaw (`openclaw plugins install @memclaw/memclaw`), binaries are located at:
|
|
35
|
+
|
|
36
|
+
| Platform | Path |
|
|
37
|
+
|----------|------|
|
|
38
|
+
| macOS | `{claw-data-dir}/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/` |
|
|
39
|
+
| Windows | `{claw-data-dir}\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\` |
|
|
40
|
+
|
|
41
|
+
> **Note**: `{claw-data-dir}` is typically `~/.openclaw` for standard OpenClaw. For custom or modified Claw versions, replace with your actual Claw data directory (e.g., `~/.claw`, `~/.myclaw`, etc.).
|
|
42
|
+
|
|
43
|
+
**Binaries included:**
|
|
44
|
+
- `qdrant` (or `qdrant.exe`) — Vector database server
|
|
45
|
+
- `cortex-mem-service` (or `cortex-mem-service.exe`) — Memory extraction service
|
|
46
|
+
- `cortex-mem-cli` (or `cortex-mem-cli.exe`) — Command-line maintenance tool
|
|
47
|
+
|
|
48
|
+
### Verify Binary Installation
|
|
49
|
+
|
|
50
|
+
Check if binaries exist:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# macOS (adjust claw-data-dir as needed)
|
|
54
|
+
ls ~/.openclaw/extensions/memclaw/node_modules/@memclaw/bin-darwin-arm64/bin/
|
|
55
|
+
|
|
56
|
+
# Windows (adjust claw-data-dir as needed)
|
|
57
|
+
dir %USERPROFILE%\.openclaw\extensions\memclaw\node_modules\@memclaw\bin-win-x64\bin\
|
|
58
|
+
```
|
|
59
|
+
|
|
32
60
|
### Manual Binary Installation
|
|
33
61
|
|
|
34
62
|
If binaries are not installed, run:
|
|
@@ -103,7 +131,7 @@ api_base_url = "https://your-llm-provider.com/v1"
|
|
|
103
131
|
api_key = "your-api-key-here"
|
|
104
132
|
model_efficient = "gpt-5-mini"
|
|
105
133
|
temperature = 0.1
|
|
106
|
-
max_tokens =
|
|
134
|
+
max_tokens = 65536
|
|
107
135
|
|
|
108
136
|
# Embedding Configuration [REQUIRED]
|
|
109
137
|
[embedding]
|