@digitalforgestudios/openclaw-sulcus 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 +37 -48
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,50 +1,46 @@
|
|
|
1
|
-
# Sulcus Memory
|
|
1
|
+
# Sulcus Memory Plugin for OpenClaw
|
|
2
2
|
|
|
3
3
|
Thermodynamic memory backend for [OpenClaw](https://github.com/openclaw/openclaw). Replaces file-based memory with Sulcus's heat-driven decay, cross-agent sync, and programmable triggers.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
|
|
9
|
-
openclaw plugins install @digitalforgestudios/memory-sulcus
|
|
10
|
-
|
|
11
|
-
# Option B: manual
|
|
12
|
-
mkdir -p ~/.openclaw/extensions/memory-sulcus
|
|
13
|
-
cp -r . ~/.openclaw/extensions/memory-sulcus/
|
|
14
|
-
cd ~/.openclaw/extensions/memory-sulcus && npm install
|
|
15
|
-
|
|
16
|
-
# Verify — plugin ID must be "memory-sulcus"
|
|
17
|
-
openclaw plugins list
|
|
8
|
+
openclaw plugin install @digitalforgestudios/openclaw-sulcus
|
|
18
9
|
```
|
|
19
10
|
|
|
20
|
-
> **⚠️ The plugin ID is `memory-sulcus`** — use this exact string in all config keys (`plugins.slots.memory`, `plugins.entries`, `plugins.allow`). Do NOT use `openclaw-sulcus`.
|
|
21
|
-
|
|
22
11
|
## Configure
|
|
23
12
|
|
|
24
|
-
|
|
13
|
+
After install, add your API key to the plugin config in `~/.openclaw/openclaw.json`:
|
|
25
14
|
|
|
26
15
|
```json
|
|
27
|
-
{
|
|
28
|
-
"
|
|
29
|
-
|
|
30
|
-
"
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
"config": {
|
|
34
|
-
"serverUrl": "https://api.sulcus.ca",
|
|
35
|
-
"apiKey": "YOUR_API_KEY",
|
|
36
|
-
"agentId": "my-agent",
|
|
37
|
-
"namespace": "my-agent",
|
|
38
|
-
"autoRecall": true,
|
|
39
|
-
"autoCapture": true
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
|
-
}
|
|
16
|
+
"openclaw-sulcus": {
|
|
17
|
+
"enabled": true,
|
|
18
|
+
"config": {
|
|
19
|
+
"apiKey": "sk-YOUR_KEY_HERE",
|
|
20
|
+
"agentId": "my-agent",
|
|
21
|
+
"namespace": "my-agent"
|
|
43
22
|
}
|
|
44
23
|
}
|
|
45
24
|
```
|
|
46
25
|
|
|
47
|
-
Then restart: `openclaw restart`
|
|
26
|
+
Then restart: `openclaw gateway restart`
|
|
27
|
+
|
|
28
|
+
**No API key?** The plugin starts without one — it logs a warning and disables itself. Add the key when you're ready and restart.
|
|
29
|
+
|
|
30
|
+
**Get an API key:** Sign up at [sulcus.ca](https://sulcus.ca) → Dashboard → Account → API Keys.
|
|
31
|
+
|
|
32
|
+
## Config Options
|
|
33
|
+
|
|
34
|
+
| Option | Default | Description |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `serverUrl` | `https://api.sulcus.ca` | Sulcus server URL |
|
|
37
|
+
| `apiKey` | — | Sulcus API key (`sk-...`) |
|
|
38
|
+
| `agentId` | — | Agent identifier for namespacing |
|
|
39
|
+
| `namespace` | same as `agentId` | Memory namespace |
|
|
40
|
+
| `autoRecall` | `true` | Inject relevant memories into context |
|
|
41
|
+
| `autoCapture` | `true` | Auto-store important info from conversations |
|
|
42
|
+
| `maxRecallResults` | `5` | Max memories injected per turn |
|
|
43
|
+
| `minRecallScore` | `0.3` | Min relevance threshold (0–1) |
|
|
48
44
|
|
|
49
45
|
## Tools Provided
|
|
50
46
|
|
|
@@ -57,25 +53,18 @@ Then restart: `openclaw restart`
|
|
|
57
53
|
|
|
58
54
|
## Features
|
|
59
55
|
|
|
60
|
-
- **Auto-recall
|
|
61
|
-
- **Auto-capture
|
|
62
|
-
- **Heat decay
|
|
63
|
-
- **Cross-agent sync
|
|
64
|
-
- **Triggers
|
|
56
|
+
- **Auto-recall** — relevant memories injected before each agent turn
|
|
57
|
+
- **Auto-capture** — important info from conversations stored automatically
|
|
58
|
+
- **Heat decay** — memories cool over time; frequently accessed ones stay hot
|
|
59
|
+
- **Cross-agent sync** — all agents under a tenant share memories
|
|
60
|
+
- **Triggers** — programmable rules that fire on memory events
|
|
65
61
|
|
|
66
|
-
##
|
|
62
|
+
## Links
|
|
67
63
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
| `apiKey` | (required) | Sulcus API key |
|
|
72
|
-
| `agentId` | — | Agent identifier |
|
|
73
|
-
| `namespace` | `agentId` | Memory namespace |
|
|
74
|
-
| `autoRecall` | `true` | Inject memories into context |
|
|
75
|
-
| `autoCapture` | `true` | Auto-store from conversations |
|
|
76
|
-
| `maxRecallResults` | `5` | Max memories per turn |
|
|
77
|
-
| `minRecallScore` | `0.3` | Min relevance threshold |
|
|
64
|
+
- [Sulcus](https://sulcus.ca) — sign up, dashboard, docs
|
|
65
|
+
- [Node SDK](https://www.npmjs.com/package/@digitalforgestudios/sulcus) — `@digitalforgestudios/sulcus`
|
|
66
|
+
- [GitHub](https://github.com/digitalforgeca/sulcus) — source, issues, discussions
|
|
78
67
|
|
|
79
68
|
## License
|
|
80
69
|
|
|
81
|
-
MIT
|
|
70
|
+
MIT — [Digital Forge Studios](https://dforge.ca)
|
package/package.json
CHANGED