@minniexcode/codex-switch 0.0.12 → 0.1.0
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.AI.md +110 -110
- package/README.CN.md +179 -179
- package/README.md +183 -183
- package/dist/app/add-provider.js +9 -3
- package/dist/app/edit-provider.js +17 -3
- package/dist/app/run-doctor.js +4 -0
- package/dist/cli/output.js +8 -0
- package/dist/commands/registry.js +9 -4
- package/dist/domain/config.js +26 -1
- package/dist/domain/providers.js +16 -0
- package/docs/Design/codex-switch-v0.1.0-design.md +152 -0
- package/docs/PRD/codex-switch-prd-v0.1.0.md +217 -205
- package/docs/Tests/testing.md +31 -78
- package/docs/cli-usage.md +223 -223
- package/docs/codex-switch-command-design.md +649 -649
- package/docs/codex-switch-product-overview.md +86 -86
- package/docs/codex-switch-technical-architecture.md +1115 -1115
- package/package.json +51 -51
|
@@ -1,86 +1,86 @@
|
|
|
1
|
-
# codex-switch 产品文档
|
|
2
|
-
|
|
3
|
-
## 文档定位
|
|
4
|
-
|
|
5
|
-
这份文档介绍当前活跃产品事实源下的 `codex-switch` 产品定位。
|
|
6
|
-
|
|
7
|
-
当前 release contract 以这些文档为准：
|
|
8
|
-
|
|
9
|
-
- [`cli-usage.md`](./cli-usage.md)
|
|
10
|
-
- [`PRD/codex-switch-prd-v0.0.
|
|
11
|
-
- [`Design/codex-switch-v0.0
|
|
12
|
-
|
|
13
|
-
## 产品概述
|
|
14
|
-
|
|
15
|
-
`codex-switch` 是一个本地 provider 管理 CLI，用于管理和切换目标 Codex runtime 的 provider/profile 配置，同时把工具自己的管理态保存在独立 tool home 下。
|
|
16
|
-
|
|
17
|
-
它不是旧 `setup` 小工具，也不是围绕单目录 `~/.codex` 组织全部状态的脚本集合。
|
|
18
|
-
|
|
19
|
-
## 产品工作方式
|
|
20
|
-
|
|
21
|
-
`codex-switch` 使用 dual-path model。
|
|
22
|
-
|
|
23
|
-
tool home：
|
|
24
|
-
|
|
25
|
-
```text
|
|
26
|
-
~/.config/codex-switch/
|
|
27
|
-
codex-switch.json
|
|
28
|
-
providers.json
|
|
29
|
-
backups/
|
|
30
|
-
runtime/
|
|
31
|
-
runtimes/
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
target Codex runtime：
|
|
35
|
-
|
|
36
|
-
```text
|
|
37
|
-
~/.codex/
|
|
38
|
-
config.toml
|
|
39
|
-
auth.json
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
说明：
|
|
43
|
-
|
|
44
|
-
- `providers.json` 不位于 `~/.codex`
|
|
45
|
-
- `backups/` 不位于 `~/.codex`
|
|
46
|
-
- tool home 承担管理态 SSOT
|
|
47
|
-
- target runtime 承担受管运行态投影
|
|
48
|
-
|
|
49
|
-
## 核心使用流程
|
|
50
|
-
|
|
51
|
-
Direct 主路径：
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
codexs init
|
|
55
|
-
codexs add <provider> --profile <name> --api-key <key>
|
|
56
|
-
codexs switch <provider>
|
|
57
|
-
codexs status
|
|
58
|
-
codexs doctor
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Copilot 主路径：
|
|
62
|
-
|
|
63
|
-
```bash
|
|
64
|
-
codexs init
|
|
65
|
-
codexs login copilot
|
|
66
|
-
codexs add <provider> --copilot --profile <name>
|
|
67
|
-
codexs switch <provider>
|
|
68
|
-
codexs status
|
|
69
|
-
codexs doctor
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Advanced adopt helper：
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
codexs init
|
|
76
|
-
codexs migrate
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## 当前产品判断
|
|
80
|
-
|
|
81
|
-
`0.0
|
|
82
|
-
|
|
83
|
-
- fresh install 应先走什么
|
|
84
|
-
- Copilot 路径和 direct 路径有什么区别
|
|
85
|
-
- `migrate` 何时才该使用
|
|
86
|
-
- `status` / `doctor` 如何帮助定位下一步
|
|
1
|
+
# codex-switch 产品文档
|
|
2
|
+
|
|
3
|
+
## 文档定位
|
|
4
|
+
|
|
5
|
+
这份文档介绍当前活跃产品事实源下的 `codex-switch` 产品定位。
|
|
6
|
+
|
|
7
|
+
当前 release contract 以这些文档为准：
|
|
8
|
+
|
|
9
|
+
- [`cli-usage.md`](./cli-usage.md)
|
|
10
|
+
- [`PRD/codex-switch-prd-v0.1.0.md`](./PRD/codex-switch-prd-v0.1.0.md)
|
|
11
|
+
- [`Design/codex-switch-v0.1.0-design.md`](./Design/codex-switch-v0.1.0-design.md)
|
|
12
|
+
|
|
13
|
+
## 产品概述
|
|
14
|
+
|
|
15
|
+
`codex-switch` 是一个本地 provider 管理 CLI，用于管理和切换目标 Codex runtime 的 provider/profile 配置，同时把工具自己的管理态保存在独立 tool home 下。
|
|
16
|
+
|
|
17
|
+
它不是旧 `setup` 小工具，也不是围绕单目录 `~/.codex` 组织全部状态的脚本集合。
|
|
18
|
+
|
|
19
|
+
## 产品工作方式
|
|
20
|
+
|
|
21
|
+
`codex-switch` 使用 dual-path model。
|
|
22
|
+
|
|
23
|
+
tool home：
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
~/.config/codex-switch/
|
|
27
|
+
codex-switch.json
|
|
28
|
+
providers.json
|
|
29
|
+
backups/
|
|
30
|
+
runtime/
|
|
31
|
+
runtimes/
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
target Codex runtime：
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
~/.codex/
|
|
38
|
+
config.toml
|
|
39
|
+
auth.json
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
说明：
|
|
43
|
+
|
|
44
|
+
- `providers.json` 不位于 `~/.codex`
|
|
45
|
+
- `backups/` 不位于 `~/.codex`
|
|
46
|
+
- tool home 承担管理态 SSOT
|
|
47
|
+
- target runtime 承担受管运行态投影
|
|
48
|
+
|
|
49
|
+
## 核心使用流程
|
|
50
|
+
|
|
51
|
+
Direct 主路径：
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
codexs init
|
|
55
|
+
codexs add <provider> --profile <name> --api-key <key>
|
|
56
|
+
codexs switch <provider>
|
|
57
|
+
codexs status
|
|
58
|
+
codexs doctor
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Copilot 主路径：
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
codexs init
|
|
65
|
+
codexs login copilot
|
|
66
|
+
codexs add <provider> --copilot --profile <name>
|
|
67
|
+
codexs switch <provider>
|
|
68
|
+
codexs status
|
|
69
|
+
codexs doctor
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Advanced adopt helper：
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
codexs init
|
|
76
|
+
codexs migrate
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## 当前产品判断
|
|
80
|
+
|
|
81
|
+
`0.1.0` 的重点不是再加新命令，而是让用户在 README、help 和输出第一屏就能理解：
|
|
82
|
+
|
|
83
|
+
- fresh install 应先走什么
|
|
84
|
+
- Copilot 路径和 direct 路径有什么区别
|
|
85
|
+
- `migrate` 何时才该使用
|
|
86
|
+
- `status` / `doctor` 如何帮助定位下一步
|