cursor-openai-byok 1.0.2 → 1.1.4
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 +5 -46
- package/TROUBLESHOOTING.md +7 -3
- package/lib/cli.js +358 -135
- package/lib/daemon-entry.js +30 -11
- package/lib/watcher-entry.js +1548 -0
- package/package.json +5 -6
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
## 支持范围
|
|
6
6
|
|
|
7
7
|
- macOS 和 Windows。
|
|
8
|
-
- Cursor 3.8.x。其它版本会由 `doctor` 或 `install` 拒绝,除非显式 `--force`。
|
|
8
|
+
- Cursor 3.8.x 和 3.11.x。其它版本会由 `doctor` 或 `install` 拒绝,除非显式 `--force`。
|
|
9
9
|
- OpenAI Responses API 风格 provider,包括文本和图片输入。
|
|
10
10
|
- OpenAI Chat Completions 风格 provider,包括文本和图片输入。
|
|
11
11
|
- 多 provider、多 model 映射。
|
|
@@ -39,8 +39,8 @@ pnpm dlx cursor-openai-byok@latest doctor
|
|
|
39
39
|
安装会做三件事:
|
|
40
40
|
|
|
41
41
|
- 校验 `~/.cursor-openai-byok/config.json` 或 `%USERPROFILE%\.cursor-openai-byok\config.json`
|
|
42
|
-
- Patch Cursor 3.8.x 的 workbench bundle
|
|
43
|
-
- 安装 Cursor
|
|
42
|
+
- Patch Cursor 3.8.x / 3.11.x 的 workbench bundle
|
|
43
|
+
- 安装 Cursor 扩展;3.8.x 由扩展管理 daemon,3.11.x 由本机 lifecycle watcher 随 Cursor 主进程启停 daemon
|
|
44
44
|
|
|
45
45
|
安装后重启 Cursor。
|
|
46
46
|
|
|
@@ -158,7 +158,7 @@ node bin/cursor-openai-byok.js restart
|
|
|
158
158
|
node bin/cursor-openai-byok.js uninstall
|
|
159
159
|
```
|
|
160
160
|
|
|
161
|
-
`start|stop|restart` 只是手动调试命令。正常使用时不需要单独启动 server;Cursor
|
|
161
|
+
`start|stop|restart` 只是手动调试命令。正常使用时不需要单独启动 server;Cursor 启动后 lifecycle 会自动拉起,Cursor 退出时会自动关闭。3.11.x 的 macOS watcher 位于 `~/Library/LaunchAgents/cursor-openai-byok.lifecycle.plist`。
|
|
162
162
|
|
|
163
163
|
## 配置页面
|
|
164
164
|
|
|
@@ -208,45 +208,4 @@ Windows:
|
|
|
208
208
|
.\scripts\uninstall.ps1
|
|
209
209
|
```
|
|
210
210
|
|
|
211
|
-
卸载会停止 daemon、删除 Cursor 扩展,并从安装时的备份恢复 Cursor bundle。
|
|
212
|
-
|
|
213
|
-
## npm 发布
|
|
214
|
-
|
|
215
|
-
首次发布前需要 npmjs 账号。可以使用 `zhangever@gmail.com` 注册账号,完成邮箱验证并启用 2FA。浏览器已登录 Gmail 只用于接收验证邮件,不代表已经登录 npm。
|
|
216
|
-
|
|
217
|
-
发布前确认本机 npm registry 指向官方源:
|
|
218
|
-
|
|
219
|
-
```bash
|
|
220
|
-
npm config set registry https://registry.npmjs.org/
|
|
221
|
-
npm login --registry=https://registry.npmjs.org/
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
发布前验证:
|
|
225
|
-
|
|
226
|
-
```bash
|
|
227
|
-
npm test
|
|
228
|
-
node bin/cursor-openai-byok.js doctor
|
|
229
|
-
npm run package
|
|
230
|
-
npm pack --dry-run --json
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
确认 tarball 只包含 `lib/` 构建产物、CLI 入口、安装脚本和文档,不包含 `src/`、`extension/`、`dist/*.zip`、`test/`、本地配置或 API key 后发布:
|
|
234
|
-
|
|
235
|
-
```bash
|
|
236
|
-
npm publish --registry=https://registry.npmjs.org/ --access public
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
本地 tarball 可以这样验证 CLI 入口:
|
|
240
|
-
|
|
241
|
-
```bash
|
|
242
|
-
npm pack
|
|
243
|
-
npx --yes --package ./cursor-openai-byok-<version>.tgz cursor-openai-byok help
|
|
244
|
-
pnpm dlx ./cursor-openai-byok-<version>.tgz help
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
发布后验证:
|
|
248
|
-
|
|
249
|
-
```bash
|
|
250
|
-
npx --yes cursor-openai-byok@latest help
|
|
251
|
-
pnpm dlx cursor-openai-byok@latest help
|
|
252
|
-
```
|
|
211
|
+
卸载会停止 daemon、删除 lifecycle watcher 和 Cursor 扩展,并从安装时的备份恢复 Cursor bundle。
|
package/TROUBLESHOOTING.md
CHANGED
|
@@ -23,7 +23,7 @@ node bin/cursor-openai-byok.js models
|
|
|
23
23
|
|
|
24
24
|
- `config.json` 里有 `providers[].models[].displayName`
|
|
25
25
|
- API key 不是 `sk-REPLACE_ME`
|
|
26
|
-
- Cursor 版本是 3.8.x
|
|
26
|
+
- Cursor 版本是 3.8.x 或 3.11.x
|
|
27
27
|
- 安装后已经重启 Cursor
|
|
28
28
|
|
|
29
29
|
## 能看到模型,但发送消息没有响应
|
|
@@ -42,7 +42,11 @@ node bin/cursor-openai-byok.js logs
|
|
|
42
42
|
curl http://127.0.0.1:39832/health
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
正常使用时 server
|
|
45
|
+
正常使用时 server 只应在 Cursor 运行期间存在。3.8.x 由扩展管理;3.11.x 的 Agents Window 不运行普通用户扩展,因此由 lifecycle watcher 观察 Cursor 主进程并启停 daemon。
|
|
46
|
+
|
|
47
|
+
## macOS 安装提示 Operation not permitted
|
|
48
|
+
|
|
49
|
+
Cursor 3.11 的 app bundle 可能受 macOS App Management 保护。请在“系统设置 -> 隐私与安全性 -> App 管理”中允许当前终端或 Codex 修改应用,然后重新执行 `install`。
|
|
46
50
|
|
|
47
51
|
如果 provider 报错,日志会脱敏显示 HTTP 状态和错误片段。
|
|
48
52
|
|
|
@@ -57,7 +61,7 @@ Cursor 选择 `displayName`,daemon 发请求时改成 `apiModel`。
|
|
|
57
61
|
|
|
58
62
|
## 工具调用没有按预期执行
|
|
59
63
|
|
|
60
|
-
|
|
64
|
+
插件会解析 OpenAI Responses / Chat Completions 的 tool call 流,并把 tool call 事件传回 Cursor patch。Cursor 端工具执行依赖 3.8.x / 3.11.x 的内部 interaction bridge,如果 Cursor 版本或 bundle 结构变化,`doctor` 会要求更新 patch template。
|
|
61
65
|
|
|
62
66
|
排查时先用普通文本聊天确认链路,再用只读工具调用 smoke test。
|
|
63
67
|
|