Skip to content

Commit e9915ec

Browse files
authored
fix(claude-code-memory-plugin): improve Windows compatibility (#1249)
* fix(claude-code-memory-plugin): improve Windows compatibility * docs(claude-code-memory-plugin): split marketplace link into a new paragraph
1 parent fc230cf commit e9915ec

5 files changed

Lines changed: 15 additions & 8 deletions

File tree

examples/claude-code-memory-plugin/.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "openviking-memory",
3-
"version": "0.1.0",
3+
"version": "0.1.2",
44
"description": "Long-term semantic memory for Claude Code, powered by OpenViking. Auto-recall relevant memories at session start and capture important information during conversations.",
55
"author": {
66
"name": "OpenViking",

examples/claude-code-memory-plugin/.mcp.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"command": "node",
44
"args": ["${CLAUDE_PLUGIN_ROOT}/scripts/start-memory-server.mjs"],
55
"env": {
6-
"OPENVIKING_CONFIG_FILE": "${OPENVIKING_CONFIG_FILE:-}"
6+
"OPENVIKING_CONFIG_FILE": "${OPENVIKING_CONFIG_FILE}"
77
}
88
}
99
}

examples/claude-code-memory-plugin/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Long-term semantic memory for Claude Code, powered by [OpenViking](https://github.com/volcengine/OpenViking).
44

5-
> Ported from the [OpenClaw context-engine plugin](../openclaw-plugin/) and adapted for Claude Code's plugin architecture (MCP + hooks).
5+
Provide a plugin marketplace repository for one-click installation: [openviking-plugins](https://github.com/Castor6/openviking-plugins)
6+
7+
> Ported from the [OpenClaw context-engine plugin](https://github.com/volcengine/OpenViking/tree/main/examples/openclaw-plugin) and adapted for Claude Code's plugin architecture (MCP + hooks).
68
79
## Architecture
810

@@ -117,7 +119,7 @@ pipx install openviking
117119

118120
### 2. Create Config
119121

120-
If you don't already have `~/.openviking/ov.conf`, create it:
122+
If you don't already have `~/.openviking/ov.conf`(Can override the default path via the environment variable `OPENVIKING_CONFIG_FILE`), create it:
121123

122124
```bash
123125
mkdir -p ~/.openviking
@@ -154,7 +156,8 @@ vim ~/.openviking/ov.conf
154156
}
155157
```
156158

157-
> `root_api_key`: Once set, all HTTP requests must carry the `X-API-Key` header. Defaults to `null` in local mode (authentication disabled).
159+
> `root_api_key`: Once set, all HTTP requests must carry the `X-API-Key` header. Defaults to `null` in local mode (authentication disabled).
160+
> For Windows system paths in the workspace, use / instead of \, for example: `D:/.openviking/data`
158161
159162
Optionally add a `claude_code` section for plugin-specific overrides:
160163

examples/claude-code-memory-plugin/README_CN.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
为 Claude Code 提供长期语义记忆功能,基于 [OpenViking](https://github.com/volcengine/OpenViking) 构建。
44

5-
> 移植自 [OpenClaw context-engine plugin](../openclaw-plugin/),并适配 Claude Code 的插件架构(MCP + hooks)。
5+
提供一键安装的插件市场仓库:[openviking-plugins](https://github.com/Castor6/openviking-plugins)
6+
7+
> 移植自 [OpenClaw context-engine plugin](https://github.com/volcengine/OpenViking/tree/main/examples/openclaw-plugin),并适配 Claude Code 的插件架构(MCP + hooks)。
68
79
## 架构
810

@@ -114,7 +116,7 @@ pipx install openviking
114116

115117
### 2. 创建配置
116118

117-
如果还没有 `~/.openviking/ov.conf`,请创建:
119+
如果还没有 `~/.openviking/ov.conf`(可通过环境变量 `OPENVIKING_CONFIG_FILE` 覆盖默认路径),请创建:
118120

119121
```bash
120122
mkdir -p ~/.openviking
@@ -151,7 +153,8 @@ vim ~/.openviking/ov.conf
151153
}
152154
```
153155

154-
> `root_api_key`:设置后,所有 HTTP 请求必须携带 `X-API-Key` 头。本地模式默认为 `null`(禁用认证)。
156+
> `root_api_key`:设置后,所有 HTTP 请求必须携带 `X-API-Key` 头。本地模式默认为 `null`(禁用认证)。
157+
> windows 系统的 workspace 路径分隔请用 / ,不要用 \ ,如 `D:/.openviking/data`
155158
156159
可选添加 `claude_code` 部分用于插件特定覆盖:
157160

examples/claude-code-memory-plugin/scripts/runtime-common.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ export async function ensureRuntimeInstalled(paths, expectedState) {
190190
cwd: paths.runtimeRoot,
191191
encoding: "utf8",
192192
stdio: "pipe",
193+
shell: process.platform === "win32",
193194
});
194195

195196
if (result.error) throw result.error;

0 commit comments

Comments
 (0)