@minniexcode/codex-switch 0.0.5 → 0.0.6

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.
Files changed (62) hide show
  1. package/README.md +35 -97
  2. package/dist/app/add-provider.js +10 -4
  3. package/dist/app/edit-provider.js +9 -9
  4. package/dist/app/export-providers.js +2 -2
  5. package/dist/app/get-current-profile.js +1 -1
  6. package/dist/app/get-status.js +2 -2
  7. package/dist/app/import-providers.js +15 -7
  8. package/dist/app/list-backups.js +1 -1
  9. package/dist/app/list-config-profiles.js +3 -2
  10. package/dist/app/list-providers.js +1 -1
  11. package/dist/app/remove-provider.js +2 -2
  12. package/dist/app/rollback-backup.js +1 -1
  13. package/dist/app/rollback-latest.js +1 -1
  14. package/dist/app/run-doctor.js +23 -6
  15. package/dist/app/run-mutation.js +2 -2
  16. package/dist/app/setup-codex.js +6 -6
  17. package/dist/app/show-config.js +2 -2
  18. package/dist/app/show-provider.js +1 -1
  19. package/dist/app/switch-provider.js +3 -3
  20. package/dist/cli/add-interactive.js +7 -106
  21. package/dist/cli/args.js +5 -137
  22. package/dist/cli/help.js +5 -313
  23. package/dist/cli/interactive.js +16 -227
  24. package/dist/cli/output.js +2 -2
  25. package/dist/cli/prompt.js +3 -108
  26. package/dist/cli.js +10 -404
  27. package/dist/commands/args.js +132 -0
  28. package/dist/commands/dispatch.js +16 -0
  29. package/dist/commands/handlers.js +391 -0
  30. package/dist/commands/help.js +119 -0
  31. package/dist/commands/registry.js +291 -0
  32. package/dist/commands/types.js +2 -0
  33. package/dist/domain/config.js +100 -23
  34. package/dist/infra/backup-repo.js +8 -208
  35. package/dist/infra/codex-cli.js +8 -128
  36. package/dist/infra/codex-paths.js +5 -69
  37. package/dist/infra/config-repo.js +59 -0
  38. package/dist/infra/fs-utils.js +7 -95
  39. package/dist/infra/lock-repo.js +3 -97
  40. package/dist/infra/providers-repo.js +7 -96
  41. package/dist/interaction/add-interactive.js +108 -0
  42. package/dist/interaction/interactive.js +216 -0
  43. package/dist/interaction/prompt.js +110 -0
  44. package/dist/runtime/codex-cli.js +130 -0
  45. package/dist/runtime/codex-probe.js +50 -0
  46. package/dist/runtime/types.js +2 -0
  47. package/dist/storage/backup-repo.js +210 -0
  48. package/dist/storage/codex-paths.js +71 -0
  49. package/dist/storage/config-repo.js +208 -0
  50. package/dist/storage/fs-utils.js +97 -0
  51. package/dist/storage/lock-repo.js +99 -0
  52. package/dist/storage/providers-repo.js +98 -0
  53. package/docs/Design/codex-switch-v0.0.5-design.md +32 -22
  54. package/docs/Design/codex-switch-v0.0.6-design.md +708 -0
  55. package/docs/PRD/codex-switch-prd-v0.0.5-to-v0.1.0.md +125 -93
  56. package/docs/PRD/codex-switch-prd-v0.1.0.md +200 -226
  57. package/docs/PRD/codex-switch-prd.md +1 -1
  58. package/docs/cli-usage.md +2 -1
  59. package/docs/codex-switch-technical-architecture.md +73 -4
  60. package/docs/test-report-0.0.5.md +163 -0
  61. package/docs/testing.md +131 -0
  62. package/package.json +1 -1
@@ -14,15 +14,20 @@
14
14
  - 对应技术架构:[`../codex-switch-technical-architecture.md`](../codex-switch-technical-architecture.md)
15
15
  - 对应命令设计:[`../codex-switch-command-design.md`](../codex-switch-command-design.md)
16
16
 
17
+ 说明:
18
+
19
+ - 当前 active PRD 文件名沿用历史命名,但正文语义已更新为 `0.0.6`
20
+ - 本文档以“版本演进路线”而不是“文件名字面值”作为解释基准
21
+
17
22
  ## 一句话定义
18
23
 
19
- `codex-switch` 的 `0.1.0` 目标,是从一个已经具备 provider 管理和基础 config consistency 能力的本地 CLI,演进为一套对人类和 AI 都稳定、可初始化、可诊断、可恢复、可结构化管理配置、可持续扩展的发布级命令体系。
24
+ `codex-switch` 的 `0.1.0` 目标,是从一个已经具备 provider 管理、config consistency 和本地事务能力的 CLI,演进为一套对人类、AI 和后续集成层都稳定的发布级命令体系,并能够承载第三方 auth、本地代理和外部依赖接入这类扩展能力。
20
25
 
21
26
  ## 版本语义
22
27
 
23
- - `0.0.x`:测试 / 验证阶段版本,用于收敛模型、命令面和失败语义
24
- - `0.1.0`:第一条稳定发布规格线,不要求立即全部完成,但要求边界清晰
25
- - 本文档描述的是 `0.0.5` 之后继续走向 `0.1.0` 的长期目标
28
+ - `0.0.x`:测试 / 验证阶段版本,用于收敛命令面、错误契约、事务安全与模块边界
29
+ - `0.0.6`:稳定性修复 + 模块化重构里程碑,为后续 integration-ready 能力打基础
30
+ - `0.1.0`:第一条稳定发布规格线,要求公共契约、恢复能力和扩展边界清晰
26
31
 
27
32
  ## `0.1.0` 总体目标
28
33
 
@@ -30,18 +35,19 @@
30
35
 
31
36
  - 保持 CLI 与 JSON 契约稳定
32
37
  - 保持 `setup`、provider registry、备份恢复主线能力不回退
33
- - 将 `config.toml` 从“可结构化读取与最小受管写入”推进到“稳定受管 provider-linked sections”
34
38
  - 让 provider registry 与 linked config sections 的一致性成为默认能力
35
- - 让备份与回滚继续覆盖所有关键写操作
36
- - 为未来 auth / extension 集成保留明确边界
39
+ - 让备份、回滚和诊断继续覆盖所有关键写操作
40
+ - 让模块边界足以承载未来第三方 auth / proxy / SDK 集成
41
+ - 在不破坏主 CLI 契约的前提下扩展运行时能力边界
37
42
 
38
43
  ## 长期演进守则
39
44
 
40
- 后续新增命令统一遵守:
45
+ 后续新增能力统一遵守:
41
46
 
42
47
  - 不破坏当前 JSON envelope
43
48
  - 不复用语义不匹配的错误码
44
49
  - 所有写命令默认纳入备份与回滚模型
50
+ - 所有交互都只是 TTY 增强层,不改变自动化显式契约
45
51
 
46
52
  ## 稳定公共契约
47
53
 
@@ -95,7 +101,7 @@
95
101
 
96
102
  #### `config.toml`
97
103
 
98
- 到 `0.1.0` 为止,`config.toml` 的定位是“部分受管的 runtime projection”:
104
+ 到 `0.1.0` 为止,`config.toml` 的定位继续是“部分受管的 runtime projection”:
99
105
 
100
106
  - 顶层 active `profile = "..."` 继续受管
101
107
  - 与 provider 关联的 `[profiles.<name>]` section 进入受管范围
@@ -103,73 +109,45 @@
103
109
 
104
110
  #### `ManagedProfileFields`
105
111
 
106
- `0.1.0` 之前第一批稳定受管 profile 持久化字段先锁定为最小集合:
112
+ `0.1.0` 之前第一批稳定受管 profile 持久化字段继续锁定为最小集合:
107
113
 
108
114
  ```json
109
115
  {
110
- "model": "gpt-5"
116
+ "model": "gpt-5",
117
+ "modelProvider": "packycode"
111
118
  }
112
119
  ```
113
120
 
114
121
  约束:
115
122
 
116
- - 第一批正式受管字段只锁 `model`
117
- - `baseUrl` endpoint 类字段继续只保留在 `providers.json`
123
+ - 第一批正式受管字段锁 `model` 与 `model_provider`
124
+ - `baseUrl` 作为读取视图字段,可由 `model_provider -> model_providers.<name>.base_url` 解析
118
125
  - 后续扩展 profile 字段时,只能做加法
119
126
 
120
- #### `ManagedProfileView`
121
-
122
- 面向 CLI、AI 和脚本输出的读取视图,与持久化字段分离:
123
-
124
- ```json
125
- {
126
- "name": "packycode",
127
- "model": "gpt-5",
128
- "linkedProviders": ["packycode"],
129
- "isActive": true,
130
- "managed": true
131
- }
132
- ```
133
-
134
- ### TOML 处理原则
127
+ ## `0.1.0` 模块化目标
135
128
 
136
- 为了支持结构化 config 管理,`0.1.0` 稳定主线要求:
129
+ ### 核心结构方向
137
130
 
138
- - 不再以字符串匹配作为唯一 TOML 修改策略
139
- - 对受管 section 的读取、创建、删除、重命名和字段更新,必须支持可验证的非破坏性结构化读取和修改
140
- - 修改受管部分时,不应破坏非受管 TOML 内容、顺序、空行和注释
131
+ 到 `0.1.0` 为止,`codex-switch` 不应只停留在“`cli / app / domain / infra` 四层可用”这个层次,而应进一步收敛出稳定的能力边界:
141
132
 
142
- ### 错误码演进原则
133
+ - `Command Surface`
134
+ - `Interaction Layer`
135
+ - `Application Use Cases`
136
+ - `Domain Policies`
137
+ - `Storage Repositories`
138
+ - `Runtime Integrations`
143
139
 
144
- 保留现有领域错误码,并把错误码体系从 MVP 复用模式收紧到语义匹配模式。
140
+ 这些边界的意义不是强制锁死具体类名,而是保证未来新增能力不会继续把复杂度堆回单一 CLI 入口。
145
141
 
146
- 现有保留:
142
+ ### Runtime Integrations 的长期定位
147
143
 
148
- - `CONFIG_NOT_FOUND`
149
- - `PROVIDERS_NOT_FOUND`
150
- - `PROVIDERS_PARSE_ERROR`
151
- - `PROVIDER_NOT_FOUND`
152
- - `PROFILE_NOT_FOUND`
153
- - `BACKUP_FAILED`
154
- - `CODEX_LOGIN_FAILED`
155
- - `ROLLBACK_FAILED`
156
- - `LOCK_CONFLICT`
157
- - `LIVE_STATE_DRIFT`
144
+ `Runtime Integrations``0.1.0` 目标线中必须预留清楚的能力域,负责:
158
145
 
159
- 建议新增 / 预留:
160
-
161
- - `INVALID_ARGUMENT`
162
- - `UNKNOWN_COMMAND`
163
- - `PROMPT_CANCELLED`
164
- - `CODEX_NOT_INSTALLED`
165
- - `CODEX_VERSION_UNSUPPORTED`
166
- - `CODEX_DIR_NOT_FOUND`
167
- - `CODEX_DIR_AMBIGUOUS`
168
- - `PROVIDERS_ALREADY_EXISTS`
169
- - `BACKUP_NOT_FOUND`
170
- - `CONFIG_PARSE_ERROR`
171
- - `PROFILE_IN_USE`
172
- - `MANAGED_PROFILE_FIELDS_MISSING`
146
+ - `codex` CLI 调用与可用性检查
147
+ - 第三方 auth adapter
148
+ - 本地 proxy runtime
149
+ - 外部 SDK / 二进制依赖可用性探测
150
+ - integration 级错误语义收敛
173
151
 
174
152
  ## 已落地能力的 `0.1.0` 稳定化要求
175
153
 
@@ -179,7 +157,7 @@
179
157
 
180
158
  - 继续保持从环境检测到 registry 初始化的主流程
181
159
  - 继续允许 `overwrite`、`merge` 和交互式补问缺失关键字段
182
- - 与新的 config 管理能力保持兼容,不写出未来无法被结构化读取的受管状态
160
+ - config 管理能力和未来 runtime integration 边界保持兼容
183
161
  - 对历史遗留不一致状态给出 adopt / repair 建议,而不是静默忽略
184
162
 
185
163
  ### provider registry 命令
@@ -189,6 +167,7 @@
189
167
  - 保持命令名和基础 JSON 契约稳定
190
168
  - 把错误语义继续收紧
191
169
  - 让与 `config.toml` 关联的行为更完整
170
+ - 不因引入第三方集成而改变现有 provider/config 的领域边界
192
171
 
193
172
  ### `import --merge`
194
173
 
@@ -198,33 +177,75 @@
198
177
  - 不能只更新 `providers.json` 而放任 linked profile sections 漂移
199
178
  - 当导入结果引用了缺失 profile 时,必须进入与 `add` / `edit` 一致的受管规则
200
179
  - 非交互模式下,如果导入内容不能满足受管 profile 创建条件,应明确失败
201
- - 交互模式下可以进入 adopt / repair 辅助流,但最终写入结果仍必须满足一致性约束
180
+ - 交互模式下可以进入 adopt 辅助流,但不会为缺失 `model_providers` runtime section 做隐式 repair
202
181
 
203
- ## `0.1.0` 远期能力域
182
+ ## `0.1.0` 主线能力域
204
183
 
205
- 下面这些方向明确有价值,但不进入 `0.0.5` 当前里程碑,只作为继续走向 `0.1.0` 的能力域。
184
+ 下面这些方向不要求在 `0.0.6` 全部交付,但它们不再只是模糊远期方向,而是 `0.1.0` 主线需要承接的能力域。
206
185
 
207
- ### 第三方 auth / extension 集成
186
+ ### Config Management & Consistency
208
187
 
209
- 示例方向:
188
+ 目标:
210
189
 
211
- - 接入 Copilot auth
212
- - 在本地启动代理服务,使特定上游可在 Codex 中使用
213
- - 安装和管理第三方依赖
190
+ - 巩固结构化 TOML 读写
191
+ - 稳定 `config-show`、`config-list-profiles`
192
+ - 让 provider 管理命令可靠同步 linked profile sections
193
+ - 明确共享 profile、孤儿 section 和 active profile 安全规则
214
194
 
215
- 当前定位:
195
+ ### Backup / Recovery Evolution
216
196
 
217
- - 作为单独能力域保留
218
- - 不在当前主 PRD 中锁定具体命令名和交互细节
219
- - 不进入 `0.1.0` 稳定主线的验收标准
197
+ 目标:
220
198
 
221
- ### 更大范围的 profile schema 管理
199
+ - 保持 `backups` 与指定回滚能力稳定
200
+ - 确保跨 `providers.json`、`config.toml`、`auth.json` 的多文件写入仍可完整恢复
201
+ - 为更复杂的 runtime 变更继续复用同一事务模型
222
202
 
223
- 未来如果需要扩展:
203
+ ### Error Contract Hardening
204
+
205
+ 目标:
206
+
207
+ - 收紧错误码语义
208
+ - 区分环境错误、参数错误、配置解析错误、集成错误和恢复错误
209
+ - 保持 TTY / 非交互模式下的错误结果可预测
224
210
 
225
- - 可以逐步纳入 `model` 之外的 profile 字段
226
- - 必须保持增量式 schema 扩展
227
- - 不能在未定义字段契约前把 `config.toml` 直接提升为 full config manager
211
+ ### Third-Party Auth Adapters
212
+
213
+ 目标:
214
+
215
+ - 支持把第三方认证来源封装为独立 integration 能力
216
+ - 不把第三方 auth 状态直接混入 provider registry 事实源
217
+ - 对 token 获取、刷新、失效和依赖缺失提供稳定诊断语义
218
+
219
+ ### Local Proxy Runtime
220
+
221
+ 目标:
222
+
223
+ - 为需要本地代理的上游保留运行时承载能力
224
+ - 允许启动、检查、停止或探测代理状态的能力进入集成层
225
+ - 不破坏现有 provider/profile 切换和回滚模型
226
+
227
+ ### External Dependency Lifecycle
228
+
229
+ 目标:
230
+
231
+ - 识别和诊断外部 SDK、CLI、二进制依赖是否可用
232
+ - 把依赖缺失、版本不兼容、环境不可执行等问题映射到清晰错误语义
233
+ - 为未来的依赖安装或引导能力留出接口,但不强制 `0.0.x` 提前产品化
234
+
235
+ ## GitHub Copilot 代表性场景
236
+
237
+ GitHub Copilot 在演进 PRD 中的定位是代表性用例,而不是唯一目标:
238
+
239
+ - 可作为第三方 auth adapter 的首个高价值案例
240
+ - 可作为本地 proxy runtime 需求的首个真实驱动
241
+ - 可用来验证 `Runtime Integrations` 分层是否足够清楚
242
+
243
+ 当前不提前锁定:
244
+
245
+ - 具体命令名
246
+ - 具体交互流程
247
+ - `@github/copilot-sdk` 的封装形态
248
+ - 本地代理协议和生命周期细节
228
249
 
229
250
  ## 主题里程碑
230
251
 
@@ -235,32 +256,41 @@
235
256
  目标:
236
257
 
237
258
  - 巩固结构化 TOML 读写
238
- - 稳定 `config show`、`config list-profiles`
259
+ - 稳定 `config-show`、`config-list-profiles`
239
260
  - 让 provider 管理命令可靠同步 linked profile sections
240
261
  - 明确共享 profile、孤儿 section 和 active profile 安全规则
241
262
 
242
- ### 里程碑 B:Backup / Recovery Evolution
263
+ ### 里程碑 B:`0.0.6` / Stability & Modularization
243
264
 
244
265
  目标:
245
266
 
246
- - 保持 `backups list` 与指定回滚能力稳定
247
- - 确保跨 `providers.json` 与 `config.toml` 的双写场景仍可完整恢复
248
- - 为更复杂的 config 变更继续复用同一事务模型
267
+ - 修复 `0.0.5` 已落地命令的稳定性问题
268
+ - 统一 help、交互、错误语义和恢复模型
269
+ - 解决 `cli.ts` 过重问题,明确 command / interaction / application / integration 边界
270
+ - 为第三方 auth / proxy / SDK 集成建立 integration-ready 架构基础
249
271
 
250
- ### 里程碑 C:Error Contract Hardening
272
+ ### 里程碑 C:Backup / Recovery Evolution
273
+
274
+ 目标:
275
+
276
+ - 保持历史备份、显式回滚和多文件恢复稳定
277
+ - 让更复杂的 runtime 变更继续复用同一事务模型
278
+
279
+ ### 里程碑 D:Error Contract Hardening
251
280
 
252
281
  目标:
253
282
 
254
283
  - 收紧错误码语义
255
284
  - 区分环境错误、参数错误、配置解析错误和恢复错误
256
- - 保持 TTY / 非交互模式下的错误结果可预测
285
+ - 对第三方 integration 的失败提供清晰可预测的错误契约
257
286
 
258
- ### 里程碑 DExtensions / Auth Integration
287
+ ### 里程碑 EIntegrations & Runtime Expansion
259
288
 
260
289
  目标:
261
290
 
262
- - 评估第三方 auth 与本地代理集成
263
- - 评估交互式依赖安装与 extension 管理
291
+ - 逐步引入第三方 auth adapter
292
+ - 逐步引入本地 proxy runtime
293
+ - 逐步引入外部依赖可用性管理
264
294
  - 在不破坏主 CLI 契约的前提下扩展能力边界
265
295
 
266
296
  ## 对实现的要求
@@ -273,7 +303,8 @@
273
303
  - 所有新增错误码都必须语义清晰
274
304
  - 所有新增 JSON 返回都只能扩展 `data` 和 `warnings`
275
305
  - 结构化 TOML 写回不能破坏非受管部分
276
- - 多候选目录发现必须在交互和非交互模式下给出一致且可预测的行为
306
+ - 第三方 integration 不得直接破坏 provider registry 作为 SSOT 的边界
307
+ - 多候选目录发现和依赖可用性检查必须在交互与非交互模式下给出一致且可预测的行为
277
308
 
278
309
  ## `0.1.0` 目标完成标准
279
310
 
@@ -286,23 +317,24 @@
286
317
  - `add` / `edit` / `remove` 执行后,`providers.json` 与 linked profile sections 不再出现预期内的一致性漂移
287
318
  - 共享 profile 场景不会误删仍被引用的 section
288
319
  - active profile 不会因为 provider 删除或 profile 迁移而变成悬空状态
289
- - 历史 `0.0.4` / `0.0.5` 状态可以被识别,并通过 adopt / repair 路径逐步收敛
320
+ - 历史 `0.0.4` / `0.0.5` / `0.0.6` 状态可以被识别,并通过 adopt / repair 路径逐步收敛
290
321
  - 历史备份可被显式枚举和恢复
291
322
  - CLI 错误码不再存在明显语义复用问题
292
- - CLI 契约对 AI 和脚本调用保持稳定
323
+ - 第三方 auth / proxy / 外部依赖能力可以通过独立 integration 边界接入,而不破坏主 CLI 契约
293
324
 
294
325
  ## 建议测试场景
295
326
 
296
327
  至少需要覆盖:
297
328
 
298
- - `config show` 与 `config list-profiles` 的稳定输出
329
+ - `config-show` 与 `config-list-profiles` 的稳定输出
299
330
  - 共享 profile 场景下的 `add` / `edit` / `remove` 行为
300
331
  - `setup` 在多目录候选下的交互和非交互分支
301
332
  - `import --merge` 在缺失 profile / adopt / repair 下的一致性行为
302
333
  - 结构化 TOML 修改后,非受管内容、顺序和注释保持稳定
303
- - 双写失败时 `providers.json` 与 `config.toml` 能整体回滚
334
+ - 双写失败时 `providers.json`、`config.toml` 与 `auth.json` 能整体回滚
304
335
  - 历史 workspace、共享 profile、孤儿 profile section、缺失 linked section 都能被 `doctor` / `status` 正确识别
336
+ - 外部 CLI / SDK / auth integration 缺失或不可用时,错误语义清晰且不污染核心 provider/config 状态
305
337
 
306
338
  ## 结论
307
339
 
308
- `0.1.0` 不是简单把 `0.0.x` 重命名为稳定版,而是在保持当前本地事务式切换模型不变的前提下,进一步收敛 config 管理、错误契约和恢复能力,并为未来更大范围的 auth / extension 集成留出清晰边界。
340
+ `0.1.0` 不是简单把 `0.0.x` 重命名为稳定版,而是在保持当前本地事务式切换模型不变的前提下,进一步收敛 config 管理、错误契约、恢复能力和模块化扩展边界,并把第三方 auth、本地代理和外部依赖接入正式纳入主线能力域。