feat: 配置统一到 ~/.x/xtype/config.json,去掉 env/xop 注入
**影响**
- 配置从三处散落(~/.xtype-engine ~/ssw.ini + 运行时 env 注入)收成一个
~/.x/xtype/config.json:engine + llm{key,base-url,model} +
xunfei{appid,api-secret,api-key}。手改这一个文件即可切引擎 / 换凭据。
- 凭据从「运行时经 xop run --secret 注入 env」改为「明文存 config.json」
(目录 0700 / 文件 0600)。启动方式不再影响行为:open / 双击 / 命令行
读同一份配置,不再依赖 xop→open→LaunchServices 这条会被截断的 env 链。
- 旧路径 ~/.xtype-engine ~/ssw.ini 一律忽略,不迁移。
**改动**
- src/xtype.swift: 删 loadINI/normINIKey 与两处 ProcessInfo.environment 读取;
新增 XTypeConfig/parseConfig/ensureConfig(JSON 解析 + 首启写模板);
LLMConfig.load() 与 XunfeiEngine 凭据改读 config.json。
- src/build.sh: 删全部 xop run --secret 块,改普通 open;python3 只改
engine 字段(OrderedDict 保序,不动凭据);首启建目录 0700 / 配置 0600;
模式名非法直接报错退出。
- src/migrate-vault-to-config.sh: 一次性把 xop vault 凭据搬进 config.json,
用户手跑(明文不进 agent 上下文),幂等只补空缺。
- AGENTS.md 红线 5/6 重写(凭据只存 config.json、不再走 env 注入);
docs/xtype/README.md 引擎选择章节重写;docs/xtype/GOTCHAS.md §11 改写成
「凭据别走 env 注入,读文件」的教训。
Co-Authored-By: Claude <[email protected]>
This commit is contained in:
1 parent
d6861f34fd
commit
d2263b16c7
6 files changed
+280
-189
No files matched your search
@@ -57,11 +57,11 @@ v1 在激活(350ms)后才启动录音引擎,用户按下即开口,前几百毫
|
||||
- 输出 `AVAudioPCMBuffer.int16ChannelData[0]` → `UnsafeRawBufferPointer(start:count:)` → `Data.append(contentsOf:)`
|
||||
- 注意 `Int16` 指针不能直接喂 `Data.append(_:count:)`,必须先按字节重解释
|
||||
|
||||
## 11. xop 注入 env 经 `open` 传递到 .app
|
||||
## 11. 凭据别走 env 注入,读文件
|
||||
|
||||
`xop run --secret X=xf_xt_X -- open /Applications/XType.app` 时,env 经 `xop → open → LaunchServices → app` 这条链路一直传到底,`ProcessInfo.processInfo.environment["XUNFEI_X"]` 在 app 内能拿到。但有几种场景会丢:
|
||||
- macOS 14+ 的 `open --new` 在某些沙盒场景下被 launchd 接管,env 被截断 → 备用 `xop run --secret ... -- /Applications/XType.app/Contents/MacOS/XType`(直接执行二进制,TCC 仍生效,因为同一 .app bundle)
|
||||
- 用户从 Finder 双击 .app:不走 xop,env 没有,引擎立刻报错退出
|
||||
早期用 `xop run --secret X=xf_xt_X -- open /Applications/XType.app` 把凭据塞进 env,靠 `xop → open → LaunchServices → app` 这条链路传到底。问题是一串的:env 会在这条链路上被截断(某些 launchd 场景),用户从 Finder 双击 .app 更是完全绕过注入 —— 引擎拿不到凭据就报错退出,行为随启动方式漂移。
|
||||
|
||||
**教训**:凭据走**固定路径的文件**,别走启动方式相关的 env。`open` / 双击 / 命令行 三种启动方式读同一个文件,行为一致,不依赖调用链。现在全部配置在 `~/.x/xtype/config.json`(目录 0700 / 文件 0600),app 启动时自己读。
|
||||
|
||||
## 复现/验证工具
|
||||
|
||||
|
||||
+42
-30
@@ -10,58 +10,70 @@
|
||||
|
||||
日志:`/tmp/xtype.log`(每次判定都记录走了哪条路径、看到什么角色、识别文本、粘贴结果)。
|
||||
|
||||
## 引擎选择
|
||||
## 配置(全在 `~/.x/xtype/config.json`)
|
||||
|
||||
`~/.xtype-engine` 文件内容决定用哪个 ASR 引擎(空文件 = `apple-llm`):
|
||||
引擎选择 + 全部凭据装在一个 JSON 文件里(目录 `~/.x/xtype` 0700、文件 0600):
|
||||
|
||||
```json
|
||||
{
|
||||
"engine": "apple-llm",
|
||||
"llm": { "key": "sk_xxxxxxxxxxxx", "base-url": "https://your-llm-proxy/v1", "model": "GLM-5.3-Flash" },
|
||||
"xunfei": { "appid": "xxxxxxxx", "api-secret": "xxxxxxxx", "api-key": "xxxxxxxx" }
|
||||
}
|
||||
```
|
||||
|
||||
文件不存在时 `src/build.sh` 或 app 首次启动会自动写模板(`engine: apple` + 空凭据)。
|
||||
|
||||
`engine` 字段决定用哪个 ASR 引擎:
|
||||
|
||||
| 值 | 引擎 | 备注 |
|
||||
|---|---|---|
|
||||
| `apple-llm` (默认) | Apple 端侧 + LLM 异步精修 | 无凭据;LLM 走 `~/ssw.ini`;无 INI 则回退 Apple 原文 |
|
||||
| `apple` | SFSpeechRecognizer 端侧 zh-CN | 离线,无凭据,响应快,无 LLM 清洗 |
|
||||
| `xunfei` | 讯飞 IAT v2 WebSocket 流式 | **需凭据**;首次须 `xop set` 三个 vault 条目,启动走 `src/build.sh xunfei` |
|
||||
| `apple-llm` (`build.sh` 默认) | Apple 端侧 + LLM 异步精修 | 需 `llm.*` 三项齐全;缺任一 → 回退 Apple 原文 |
|
||||
| `apple` (模板默认) | SFSpeechRecognizer 端侧 zh-CN | 离线,无凭据,响应快,无 LLM 清洗 |
|
||||
| `xunfei` | 讯飞 IAT v2 WebSocket 流式 | **需 `xunfei.*` 三项齐全**;缺任一 → 明确报错,丢弃本次录音 |
|
||||
| `dual` | apple + xunfei 并行 + LLM 精修 | 苹果先贴,讯飞覆盖,LLM 再精修 |
|
||||
|
||||
### apple-llm / dual 的 LLM 配置(`~/ssw.ini`)
|
||||
### apple-llm / dual 的 LLM 配置
|
||||
|
||||
LLM 走 OpenAI Chat Completions 兼容协议(任何 zhipu/openai/anthropic-compatible 代理都行)。
|
||||
|
||||
```ini
|
||||
[llm-api]
|
||||
key=sk_xxxxxxxxxxxx
|
||||
base-url=https://your-llm-proxy/v1
|
||||
model=GLM-5.3-Flash
|
||||
```
|
||||
|
||||
容忍全角破折号 `—` 与半角 `-` 等价(`[llm—api]` / `base—url` 都能识别)。
|
||||
LLM 走 OpenAI Chat Completions 兼容协议(任何 zhipu/openai/anthropic-compatible 代理都行)——填 `llm.key` / `llm.base-url` / `llm.model` 三项即可。
|
||||
|
||||
引擎会自动在请求里带 `thinking: {type: "disabled"`,绕开 GLM 系列推理模式(7s+ → 1s,实测 `thinking=disabled` 后稳定 ~0.9s)。
|
||||
|
||||
**失败兜底**: 无 INI / key 错 / 网络断 / 超时 → 保留 Apple 原文,绝不静默丢内容。
|
||||
**失败兜底**: 缺 `llm.*` / key 错 / 网络断 / 超时 → 保留 Apple 原文,绝不静默丢内容。
|
||||
|
||||
### 一次性:把讯飞凭据放进 xop vault(仅 xunfei/dual 需要)
|
||||
### 讯飞凭据
|
||||
|
||||
凭据**只**从 TTY 读取,不会出现在源码/git/日志/argv/历史里。`xop set <name>` 然后回车输入值。
|
||||
填 `xunfei.appid` / `xunfei.api-secret` / `xunfei.api-key` 三项。**任一缺失则引擎报错并丢弃本次录音**(不静默回退 apple,避免你以为用了讯飞但实际是 apple 给你识别差)。
|
||||
|
||||
凭据只存这一个文件 —— 源码/git/日志/argv/历史里都不出现明文。
|
||||
|
||||
### 从 xop vault 一次性迁入凭据
|
||||
|
||||
以前凭据放在 xop vault(运行时经 `xop run --secret` 注入 env),现在改成直接读文件。一次性搬过去:
|
||||
|
||||
```bash
|
||||
xop set xf_xt_APPID # APPID
|
||||
xop set xf_xt_APISecret # APISecret
|
||||
xop set xf_xt_APIKey # APIKey
|
||||
src/migrate-vault-to-config.sh
|
||||
```
|
||||
|
||||
明文经 `xop → 子进程 env → 文件`,不进任何命令行参数或日志;脚本只打印字段名(如 `filled: llm.key, xunfei.appid, ...`),不打印值。幂等 —— 已填的字段不会被覆盖,只补空缺。
|
||||
|
||||
跑完后 `config.json` 里就有 `llm.*` 和 `xunfei.*` 的真实值,`xunfei` / `dual` 模式即可用。
|
||||
|
||||
### 启动对应引擎
|
||||
|
||||
```bash
|
||||
src/build.sh # 默认 = apple-llm
|
||||
src/build.sh apple # 纯端侧(无 LLM 精修)
|
||||
src/build.sh apple-llm # 端侧 + LLM(默认)
|
||||
src/build.sh xunfei # 讯飞(需 xop 注入)
|
||||
src/build.sh dual # 双引擎(需 xop 注入)
|
||||
src/build.sh xunfei # 讯飞
|
||||
src/build.sh dual # 双引擎
|
||||
```
|
||||
|
||||
这一步做三件事:
|
||||
1. 把 `~/.xtype-engine` 写成对应模式(持久切换)
|
||||
2. `xunfei` / `dual` 模式会 `xop run --secret XUNFEI_APPID=xf_xt_APPID --secret ... -- open /Applications/XType.app` —— 凭据仅在子进程 env 里存在
|
||||
3. 引擎读 `ProcessInfo.processInfo.environment["XUNFEI_*"]`,**任一缺失则报错并丢弃本次录音**(不静默回退 apple,避免你以为用了讯飞但实际是 apple 给你识别差)。
|
||||
这一步做两件事:
|
||||
1. 用 python3 只改 `config.json` 的 `engine` 字段(保序,不动 `llm`/`xunfei` 凭据)
|
||||
2. `open /Applications/XType.app` 启动(不再注入任何环境变量)
|
||||
|
||||
手改 `config.json` 的 `engine` 同样生效 —— `open /Applications/XType.app` 直接启动也读同一份配置。
|
||||
|
||||
## 判定流程(按住 350ms 时触发一次)
|
||||
|
||||
@@ -79,13 +91,13 @@ src/build.sh dual # 双引擎(需 xop 注入)
|
||||
| 组件 | 职责 | 权限 |
|
||||
|---|---|---|
|
||||
| 轮询线程(~125Hz) | `CGEventSource.buttonState` 检测左键,状态机 idle→press→recording/dead | 无 |
|
||||
| 预卷录音 | **鼠标按下瞬间**就开始收音(`AVAudioEngine` tap),激活时才挂识别任务——短句不丢头 | 麦克风 |
|
||||
| 预连接 | **鼠标按下瞬间**就建 WS / 建识别请求(不碰 mic 路由),激活判定通过后才 `armRecording()` 装 tap + 启 engine | 麦克风(仅录音期) |
|
||||
| `AppleEngine` | `SFSpeechRecognizer(zh-CN)` 流式,`requiresOnDeviceRecognition = true`,松开 ~70ms 出结果 | 语音识别 |
|
||||
| `AppleLLMEngine` | 包 AppleEngine + LLMCleaner;Apple 出文立刻贴,LLM 异步 ~1s 后回来若非空且不同则退格再贴 | 语音识别 + LLM |
|
||||
| `XunfeiEngine` | `URLSessionWebSocketTask` → `wss://iat-api.xfyun.cn/v2/iat`,HMAC-SHA256 鉴权 URL,系统原生 PCM → 16k/16bit/mono 后 1280 字节/帧推送,逐条收 `data_status` 拼结果 | 麦克风(无语音识别权限要求) |
|
||||
| `DualEngine` | apple + xunfei 并行,apple 先贴 → xunfei 覆盖 → LLM 异步精修再覆盖(可关) | 语音识别 + 麦克风 + LLM |
|
||||
| `LLMCleaner` | OpenAI Chat Completions 兼容;强制带 `thinking: disabled`;`refine()` 异步回调,`clean()` 同步 1.5s 兜底 | — |
|
||||
| `pickEngine()` | 读 `~/.xtype-engine`,默认 `apple-llm` | — |
|
||||
| `pickEngine()` | 读 `~/.x/xtype/config.json` 的 `engine`,默认 `apple` | — |
|
||||
| 注入 | 写剪贴板 → 合成 ⌘V → 1.5s 后恢复原剪贴板 | 辅助功能 |
|
||||
| 拖选抑制 tap | 录音期间吞掉 leftMouseDragged,防拖选文字 | 辅助功能 |
|
||||
| 聚焦查询 | AX 系统级/per-app `kAXFocusedUIElementAttribute` + 角色 | 辅助功能 |
|
||||
|
||||
Reference in new issue
Block a user