@hyperspell/openclaw-hyperspell 0.3.1 → 0.4.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 +46 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,10 +23,12 @@ The setup wizard will guide you through:
|
|
|
23
23
|
2. Configuring your API key
|
|
24
24
|
3. Setting up your User ID for multi-tenant memory
|
|
25
25
|
4. Connecting your apps (Notion, Slack, Google Drive, etc.)
|
|
26
|
+
5. Enabling memory sync for local markdown files
|
|
27
|
+
6. Syncing existing memory files to Hyperspell
|
|
26
28
|
|
|
27
29
|
## Manual Configuration
|
|
28
30
|
|
|
29
|
-
|
|
31
|
+
Add to your `openclaw.json`:
|
|
30
32
|
|
|
31
33
|
```json
|
|
32
34
|
{
|
|
@@ -37,26 +39,27 @@ Alternatively, add to your `openclaw.json`:
|
|
|
37
39
|
"config": {
|
|
38
40
|
"apiKey": "${HYPERSPELL_API_KEY}",
|
|
39
41
|
"userId": "your-email",
|
|
40
|
-
"autoContext": true
|
|
42
|
+
"autoContext": true,
|
|
43
|
+
"syncMemories": true,
|
|
44
|
+
"sources": "vault,notion,slack"
|
|
41
45
|
}
|
|
42
46
|
}
|
|
43
47
|
}
|
|
44
48
|
}
|
|
45
49
|
}
|
|
46
|
-
|
|
47
50
|
```
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
Set the environment variable in `~/.openclaw/.env`:
|
|
50
53
|
|
|
51
54
|
```bash
|
|
52
|
-
|
|
55
|
+
HYPERSPELL_API_KEY=hs_...
|
|
53
56
|
```
|
|
54
57
|
|
|
55
58
|
## CLI Commands
|
|
56
59
|
|
|
57
60
|
### `openclaw openclaw-hyperspell setup`
|
|
58
61
|
|
|
59
|
-
Interactive setup wizard that walks you through configuration.
|
|
62
|
+
Interactive setup wizard that walks you through configuration, connecting apps, and syncing memory files.
|
|
60
63
|
|
|
61
64
|
### `openclaw openclaw-hyperspell status`
|
|
62
65
|
|
|
@@ -64,16 +67,17 @@ Check your current configuration and connection status.
|
|
|
64
67
|
|
|
65
68
|
### `openclaw openclaw-hyperspell connect`
|
|
66
69
|
|
|
67
|
-
Open the Hyperspell connect page to link your accounts (Notion, Slack, Google Drive, etc.)
|
|
70
|
+
Open the Hyperspell connect page to link your accounts (Notion, Slack, Google Drive, etc.). After connecting, your sources are automatically updated in the config.
|
|
68
71
|
|
|
69
|
-
|
|
72
|
+
## Configuration Options
|
|
70
73
|
|
|
71
74
|
| Option | Type | Default | Description |
|
|
72
75
|
|--------|------|---------|-------------|
|
|
73
76
|
| `apiKey` | string | `${HYPERSPELL_API_KEY}` | Hyperspell API key |
|
|
74
|
-
| `userId` | string | - | User ID (can be your email) |
|
|
77
|
+
| `userId` | string | - | User ID for multi-tenant memory (can be your email) |
|
|
75
78
|
| `autoContext` | boolean | `true` | Auto-inject relevant memories before each AI turn |
|
|
76
|
-
| `
|
|
79
|
+
| `syncMemories` | boolean | `false` | Sync markdown files in `workspace/memory/` to Hyperspell |
|
|
80
|
+
| `sources` | string | - | Comma-separated sources to search (e.g., `vault,notion,slack`) |
|
|
77
81
|
| `maxResults` | number | `10` | Maximum memories per context injection |
|
|
78
82
|
| `debug` | boolean | `false` | Enable verbose logging |
|
|
79
83
|
|
|
@@ -95,6 +99,37 @@ Save something to memory.
|
|
|
95
99
|
/remember Meeting with Alice: discussed Q1 budget, need to follow up on headcount
|
|
96
100
|
```
|
|
97
101
|
|
|
102
|
+
### `/sync`
|
|
103
|
+
|
|
104
|
+
Manually sync all markdown files in `workspace/memory/` to Hyperspell.
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
/sync
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Memory Sync
|
|
111
|
+
|
|
112
|
+
When `syncMemories: true`, the plugin syncs markdown files from your agent's workspace memory directory (e.g., `~/.openclaw/workspace/memory/`) to Hyperspell. This includes all `.md` files in subdirectories.
|
|
113
|
+
|
|
114
|
+
**How it works:**
|
|
115
|
+
|
|
116
|
+
- Each markdown file is uploaded to Hyperspell as a memory in the `openclaw` collection
|
|
117
|
+
- The returned `resource_id` is stored in the file's YAML frontmatter as `hyperspell_id`
|
|
118
|
+
- On subsequent syncs, files with an existing `hyperspell_id` are updated rather than duplicated
|
|
119
|
+
- Files are synced automatically on startup and when they change
|
|
120
|
+
|
|
121
|
+
**Example frontmatter after sync:**
|
|
122
|
+
|
|
123
|
+
```markdown
|
|
124
|
+
---
|
|
125
|
+
title: Meeting Notes
|
|
126
|
+
hyperspell_id: abc123-def456
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
# Meeting Notes
|
|
130
|
+
...
|
|
131
|
+
```
|
|
132
|
+
|
|
98
133
|
## AI Tools
|
|
99
134
|
|
|
100
135
|
The plugin registers tools that the AI can use autonomously:
|
|
@@ -114,7 +149,7 @@ This ensures the AI always has access to relevant information from your connecte
|
|
|
114
149
|
|
|
115
150
|
## Available Sources
|
|
116
151
|
|
|
117
|
-
- `vault` - User-created memories
|
|
152
|
+
- `vault` - User-created or synced memories
|
|
118
153
|
- `notion` - Notion pages and databases
|
|
119
154
|
- `slack` - Slack messages
|
|
120
155
|
- `google_calendar` - Google Calendar events
|