You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-7Lines changed: 43 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ This installs to the same `skills/` directory the plugin reads from, so updated
137
137
}
138
138
```
139
139
140
-
This uses sensible defaults: auto-generated project name, maps Basic Memory to your workspace `memory/` directory, and captures conversations.
140
+
This uses sensible defaults: auto-generated project name, maps Basic Memory to your workspace root, sets it as the default BM project, and captures conversations.
141
141
142
142
### Full configuration
143
143
```json5
@@ -147,7 +147,7 @@ This uses sensible defaults: auto-generated project name, maps Basic Memory to y
147
147
config: {
148
148
project:"my-agent", // BM project name (default: "openclaw-{hostname}")
149
149
bmPath:"bm", // Path to BM CLI binary
150
-
projectPath:"~/.openclaw/workspace/memory/", //Optional override; supports absolute, ~/..., or workspace-relative paths
150
+
projectPath:".", //Defaults to workspace root; supports absolute, ~/..., or workspace-relative paths
151
151
memoryDir:"memory/", // Relative memory dir for task scanning
152
152
memoryFile:"MEMORY.md", // Working memory file for grep search
153
153
autoCapture:true, // Index conversations automatically
@@ -166,7 +166,7 @@ This uses sensible defaults: auto-generated project name, maps Basic Memory to y
166
166
|--------|------|---------|-------------|
167
167
|`project`| string |`"openclaw-{hostname}"`| Basic Memory project name |
168
168
|`bmPath`| string |`"bm"`| Path to Basic Memory CLI binary |
169
-
|`projectPath`| string |`"memory/"`| Directory for BM project data (resolved from workspace unless absolute) |
169
+
|`projectPath`| string |`"."`| Directory for BM project data (defaults to workspace root; resolved from workspace unless absolute) |
170
170
|`memoryDir`| string |`"memory/"`| Relative path for task scanning |
171
171
|`memoryFile`| string |`"MEMORY.md"`| Working memory file (grep-searched) |
Cloud sync is optional — see [BASIC_MEMORY.md](./BASIC_MEMORY.md) for cloud configuration.
181
181
182
-
On startup, the plugin ensures the configured BM project exists at `projectPath` via MCP `create_memory_project` in idempotent mode.
182
+
On startup, the plugin ensures the configured BM project exists at `projectPath` via MCP `create_memory_project` in idempotent mode, and sets it as the default Basic Memory project.
If you want to run without vector/embedding dependencies (faster startup, less memory), set the environment variable before launching:
458
+
```bash
459
+
BASIC_MEMORY_SEMANTIC_SEARCH_ENABLED=false
460
+
```
461
+
Or in `~/.basic-memory/config.json`:
462
+
```json
463
+
{ "semantic_search_enabled": false }
464
+
```
465
+
Search will fall back to full-text search only.
466
+
456
467
### Search returns no results
457
468
1. Check that the MCP session is connected (look for `connected to BM MCP stdio` in logs)
458
469
2. Verify files exist in the project directory
@@ -531,9 +542,7 @@ just release patch # or: minor, major, 0.2.0, etc.
531
542
4. publish to npm
532
543
5. create a GitHub release
533
544
534
-
Repository secret required:
535
-
536
-
-`NPM_TOKEN` (npm publish token with package publish permissions)
545
+
Publishing uses npm OIDC trusted publishing — no secrets required. The trusted publisher is configured on npmjs.com to accept provenance from this repo's `release.yml` workflow.
This plugin collects anonymous, minimal usage events to understand plugin adoption and tool usage patterns. This helps us prioritize features and improve the product.
579
+
580
+
**What we collect:**
581
+
- Plugin registration and startup events
582
+
- First use of each tool per session (deduplicated — not every call)
583
+
- Plugin version with each event
584
+
585
+
**What we do NOT collect:**
586
+
- No file contents, note titles, search queries, or conversation text
587
+
- No personally identifiable information (PII)
588
+
- No IP address tracking or fingerprinting
589
+
- No per-command tracking beyond first-use-per-session
590
+
591
+
Events are sent to our [Umami Cloud](https://umami.is) instance, an open-source, privacy-focused analytics platform. Events are fire-and-forget with a 3-second timeout — analytics never blocks or slows the plugin.
592
+
593
+
**Opt out** by setting either environment variable:
594
+
595
+
```bash
596
+
# Plugin-specific opt-out
597
+
export OPENCLAW_BASIC_MEMORY_TELEMETRY=0
598
+
599
+
# Or use the shared Basic Memory opt-out (also disables BM CLI telemetry)
0 commit comments