codexmate 0.0.3 → 0.0.5

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 (14) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +27 -0
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +17 -0
  3. package/.github/workflows/release.yml +42 -42
  4. package/CHANGELOG.md +7 -0
  5. package/CHANGELOG.zh-CN.md +7 -0
  6. package/README.md +112 -58
  7. package/README.zh-CN.md +115 -57
  8. package/cli.js +1536 -182
  9. package/cmd/publish-npm.cmd +65 -65
  10. package/package.json +33 -25
  11. package/res/screenshot.png +0 -0
  12. package/tests/e2e/recent-health.e2e.js +135 -0
  13. package/tests/e2e/run.js +294 -0
  14. package/web-ui.html +865 -63
package/README.zh-CN.md CHANGED
@@ -1,31 +1,45 @@
1
1
  # Codex Mate
2
2
 
3
- > 轻量级 AI 工具配置助手：CLI + Web，一站式管理 Codex 提供商与 Claude Code 配置
3
+ > 轻量级 AI 工具配置助手：快速切换 Codex 提供商/模型与 Claude Code 配置，并统一管理两者会话
4
4
 
5
- [![Build](https://img.shields.io/github/actions/workflow/status/ymkiux/codexmate/release.yml?label=build)](https://github.com/ymkiux/codexmate/actions/workflows/release.yml) [![Version](https://img.shields.io/npm/v/codexmate?label=version&registry_uri=https%3A%2F%2Fregistry.npmjs.org)](https://www.npmjs.com/package/codexmate) [![Status](https://img.shields.io/badge/status-alpha-orange)](https://github.com/ymkiux/codexmate)
5
+ [![Build](https://img.shields.io/github/actions/workflow/status/ymkiux/codexmate/release.yml?label=build)](https://github.com/ymkiux/codexmate/actions/workflows/release.yml) [![Version](https://img.shields.io/npm/v/codexmate?label=version&registry_uri=https%3A%2F%2Fregistry.npmjs.org)](https://www.npmjs.com/package/codexmate) [![Status](https://img.shields.io/badge/status-alpha-orange)](https://github.com/ymkiux/codexmate)
6
6
  [![Maintain](https://img.shields.io/github/commit-activity/m/ymkiux/codexmate?label=maintain%2Fmonth)](https://github.com/ymkiux/codexmate/commits) [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) [![Node](https://img.shields.io/badge/node-%3E%3D14.0.0-green.svg)](https://nodejs.org)
7
7
 
8
8
  [English](README.md) | 中文
9
9
 
10
+ ## 概览
11
+
12
+ Codex Mate 让 Codex 与 Claude Code 的提供商/模型切换变成“一条命令或一次点击”，并在同一 Web 页面浏览、导出两者的本地会话记录。
13
+
10
14
  ## 你能获得什么
11
15
 
12
16
  - 更快的模型/提供商切换
13
17
  - 更可控的本地配置管理
14
18
  - 可视化 Web 操作，降低命令行负担
15
19
  - 配置变更可回溯、有备份
20
+ - Codex + Claude Code 统一会话浏览（查看/导出/可用时复制恢复命令）
21
+
22
+ ## 更新说明（0.0.4）
23
+
24
+ - 新增 OpenClaw 配置模式（JSON5 多配置管理 + 一键应用）
25
+ - 新增 OpenClaw Workspace 的 AGENTS.md 管理
26
+ - 增加 JSON5 解析依赖
27
+
28
+ 完整更新记录见 [CHANGELOG.zh-CN.md](CHANGELOG.zh-CN.md) 与 [Releases](https://github.com/ymkiux/codexmate/releases)。
16
29
 
17
30
  ## 功能总览
18
31
 
19
32
  | 模块 | 解决的问题 | 关键能力 |
20
33
  | --- | --- | --- |
21
34
  | Codex 配置 | 多提供商/多模型切换麻烦 | 提供商/模型切换、模型管理、CLI + Web 双入口、模板确认写入 |
22
- | Claude Code 配置 | 多方案共存、写入路径不统一 | 多配置方案管理、默认写入 `~/.claude/settings.json`、兼容模式环境变量 |
23
- | 会话浏览 | 本地会话难以追踪 | 会话列表/筛选、Markdown 导出、删除与批量清理 |
35
+ | Claude Code 配置 | 多方案共存、写入路径不统一 | 多配置方案管理、默认写入 `~/.claude/settings.json` |
36
+ | OpenClaw 配置 | OpenClaw 配置分散 | JSON5 多配置管理、应用到 `~/.openclaw/openclaw.json`、Workspace 指令文件管理 |
37
+ | 会话浏览 | 本地会话难以追踪 | 会话列表/筛选、Markdown 导出、可用时复制恢复命令、删除与批量清理 |
24
38
  | 附属工具 | 压缩/解压需额外工具 | 基于 7-Zip 的多线程压缩/解压 |
25
39
 
26
40
  ## 为什么选择 Codex Mate
27
41
 
28
- - 聚焦两件事：Codex 提供商/模型切换 + Claude Code 配置应用
42
+ - 聚焦三件事：Codex 提供商/模型切换 + Claude Code 配置应用 + OpenClaw 配置应用
29
43
  - 本地优先：配置与 API Key 写入本地文件，不走云端
30
44
  - 轻量好用：CLI + Web 双入口，无需安装桌面端
31
45
  - 可回退：首次接管前自动备份旧配置
@@ -34,61 +48,93 @@
34
48
 
35
49
  - 频繁切换提供商/模型，想要一条命令完成
36
50
  - 同时用 Codex 与 Claude Code，需要统一入口
51
+ - 需要浏览/导出本地会话记录，并在可用时复制恢复命令
52
+ - 使用 OpenClaw 多配置，希望快速切换
37
53
  - 多项目/多环境切换，希望快速改写配置
38
54
  - 想可视化改配置但又不想上大体量客户端
39
55
 
40
56
  ## 范围与边界
41
57
 
42
- - 只做 Codex 与 Claude Code 的配置管理，不做全量多工具一体化
58
+ - 只做 Codex、Claude Code 与 OpenClaw 的配置管理，不做全量多工具一体化
43
59
  - 不内置代理/转发/费用面板/云同步（保持轻量）
44
60
  - Web UI 仅在你启动时运行（`codexmate start`）
45
61
 
62
+ ## 30 秒上手（免安装）
63
+
64
+ ```bash
65
+ npx codexmate@latest status
66
+ ```
67
+
68
+ ```bash
69
+ npx codexmate@latest start
70
+ ```
71
+
72
+ 然后在浏览器中打开 `http://localhost:3737`。
73
+
46
74
  ## 快速开始
47
75
 
48
- 1. 安装（全局）：
49
- ```bash
50
- npm install -g codexmate
51
- ```
52
-
53
- 或免安装直接运行：
54
- ```bash
55
- npx codexmate@latest status
56
- ```
57
-
58
- 2. 查看当前状态：
59
- ```bash
60
- codexmate status
61
- ```
62
-
63
- 3. 启动 Web 界面：
76
+ 1. 安装（全局）：
77
+ ```bash
78
+ npm install -g codexmate
79
+ ```
80
+
81
+ 或免安装直接运行：
82
+ ```bash
83
+ npx codexmate@latest status
84
+ ```
85
+
86
+ 2. 运行交互式配置向导：
87
+ ```bash
88
+ codexmate setup
89
+ ```
90
+
91
+ 3. 查看当前状态：
92
+ ```bash
93
+ codexmate status
94
+ ```
95
+
96
+ 4. 启动 Web 界面：
64
97
  ```bash
65
98
  codexmate start
66
99
  ```
67
100
 
68
101
  然后在浏览器中打开 `http://localhost:3737`。
69
102
 
103
+ ## 竞品/替代
104
+
105
+ - cc-switch: https://github.com/farion1231/cc-switch
106
+
70
107
  ## 界面预览
71
108
 
72
109
  ![Codex Mate Web UI](res/screenshot.png)
73
110
 
74
111
  ## 安装
75
112
 
76
- ### 全局安装（推荐）
77
-
78
- ```bash
79
- npm install -g codexmate
80
- ```
81
-
82
- npm 包名：`codexmate`。
83
-
84
- ### 使用 npx（免安装）
85
-
86
- ```bash
87
- npx codexmate@latest status
88
- npx codexmate@latest start
89
- ```
90
-
91
- ### 从源码安装
113
+ ### 全局安装（推荐）
114
+
115
+ ```bash
116
+ npm install -g codexmate
117
+ ```
118
+
119
+ npm 包名：`codexmate`。
120
+
121
+ 若希望每次执行都能更新到最新特效功能，可使用 GitHub 源安装（重复执行即可更新）：
122
+
123
+ ```bash
124
+ npm install -g ymkiux/codexmate
125
+ ```
126
+
127
+ ### 使用 npx（免安装）
128
+
129
+ ```bash
130
+ npx codexmate@latest status
131
+ ```
132
+
133
+ ```bash
134
+ npx codexmate@latest start
135
+ ```
136
+
137
+ ### 从源码安装
92
138
 
93
139
  ```bash
94
140
  git clone https://github.com/ymkiux/codexmate.git
@@ -107,6 +153,7 @@ npm link
107
153
  | 命令 | 说明 |
108
154
  | --- | --- |
109
155
  | `codexmate` | 查看帮助与可用命令 |
156
+ | `codexmate setup` | 交互式配置向导 |
110
157
  | `codexmate status` | 查看当前状态 |
111
158
  | `codexmate list` | 列出所有提供商 |
112
159
  | `codexmate switch <提供商名称>` | 切换提供商 |
@@ -139,8 +186,13 @@ codexmate start
139
186
 
140
187
  - 管理多个 Claude Code 配置方案
141
188
  - 配置 API Key、Base URL 和模型
142
- - 默认写入 `~/.claude/settings.json` 的 `env` 字段：`env.ANTHROPIC_API_KEY` / `env.ANTHROPIC_AUTH_TOKEN` / `env.ANTHROPIC_BASE_URL` / `env.ANTHROPIC_MODEL` / `env.CLAUDE_CODE_USE_KEY`
143
- - 兼容模式：写入系统环境变量（适合旧习惯或特定 Windows 场景）
189
+ - 默认写入 `~/.claude/settings.json` 的 `env` 字段：`env.ANTHROPIC_API_KEY` / `env.ANTHROPIC_BASE_URL` / `env.ANTHROPIC_MODEL`
190
+
191
+ ### OpenClaw 配置模式
192
+
193
+ - 管理多个 OpenClaw JSON5 配置方案
194
+ - 应用到 `~/.openclaw/openclaw.json`
195
+ - 管理 OpenClaw Workspace 下的 `AGENTS.md`（默认 `~/.openclaw/workspace/AGENTS.md`）
144
196
 
145
197
  ### 会话浏览模式
146
198
 
@@ -148,6 +200,7 @@ codexmate start
148
200
  - 支持按来源筛选（Codex / Claude / 全部）
149
201
  - 支持按已有会话路径（cwd）筛选，选择后自动刷新
150
202
  - 支持一键导出指定会话为 Markdown
203
+ - 支持在可用时复制恢复命令
151
204
  - 支持删除指定会话（本地 jsonl 记录）
152
205
  - 支持勾选多条会话并批量删除，部分失败会汇总提示
153
206
  - 支持在会话详情内单条删除记录或多选批量删除记录（写回原始 jsonl）
@@ -174,6 +227,11 @@ Claude Code 配置应用涉及：
174
227
  - `~/.claude/settings.json` - Claude Code 运行时配置（默认写入目标）
175
228
  - `~/.claude/settings.json.codexmate-backup-*.bak` - 首次改写前自动备份（若存在旧文件）
176
229
 
230
+ OpenClaw 配置涉及：
231
+
232
+ - `~/.openclaw/openclaw.json` - OpenClaw 配置（JSON5）
233
+ - `~/.openclaw/workspace/AGENTS.md` - OpenClaw Workspace 指令文件
234
+
177
235
  ## 首次运行初始化说明
178
236
 
179
237
  首次运行 `codexmate` 且检测到已有 `~/.codex/config.toml` 且不是 Codex Mate 管理的配置时，会发生以下行为：
@@ -204,7 +262,7 @@ codexmate use gpt-4-turbo
204
262
  2. 在浏览器中切换到 "Claude Code 配置" 模式
205
263
  3. 添加配置方案（例如智谱 GLM）：配置名称=智谱GLM，API Key=你的 API Key，Base URL=`https://open.bigmodel.cn/api/anthropic`，模型=`glm-4.7`
206
264
  4. 点击配置卡片直接应用，或在编辑弹窗点击“保存并应用到 Claude 配置”
207
- 5. 默认写入 `~/.claude/settings.json`；兼容模式写入系统环境变量
265
+ 5. 默认写入 `~/.claude/settings.json`
208
266
  6. 重启 Claude Code，新的配置即生效
209
267
 
210
268
  ### 启动 Web 界面
@@ -219,7 +277,7 @@ codexmate start
219
277
 
220
278
  ### Q: 支持哪些操作系统？
221
279
 
222
- A: Codex 功能支持 Windows 和 Linux（CLI 与 Web）。Claude Code 配置应用默认支持 Windows / macOS / Linux（写入 `~/.claude/settings.json`），兼容模式环境变量写入仅支持 Windows。
280
+ A: Codex 功能支持 Windows 和 Linux（CLI 与 Web）。Claude Code 配置应用默认支持 Windows / macOS / Linux（写入 `~/.claude/settings.json`）。
223
281
 
224
282
  ### Q: API key 存储在哪里？
225
283
 
@@ -231,7 +289,7 @@ A: Web 界面运行在本地，所有操作都在本地完成。API key 在界
231
289
 
232
290
  ### Q: Claude Code 配置后如何生效？
233
291
 
234
- A: 点击“应用到 Claude 配置”后会写入 `~/.claude/settings.json`，重启 Claude Code 即生效；如果使用兼容模式写系统环境变量，也建议重启 Claude Code。
292
+ A: 点击“应用到 Claude 配置”后会写入 `~/.claude/settings.json`，重启 Claude Code 即生效。
235
293
 
236
294
  ### Q: 如何卸载？
237
295
 
@@ -276,20 +334,20 @@ codexmate unzip ./backup.zip D:/restored
276
334
 
277
335
  注意：需要系统安装 [7-Zip](https://www.7-zip.org/)。
278
336
 
279
- ## 技术栈
280
-
281
- - **Node.js** - 运行环境
282
- - **@iarna/toml** - TOML 配置文件解析
283
- - **Vue.js 3** - Web 界面框架
284
- - **原生 HTTP** - 内建 Web 服务器
285
-
286
- ## 发布（GitHub Actions）
287
-
288
- 创建与 `package.json` 版本一致的标签（例如 `v0.0.1`）。然后在 GitHub Actions 中手动运行 `release` 工作流并输入该标签，系统会创建 GitHub Release，并附带 `npm pack` 生成的 `.tgz` 产物。
289
-
290
- ## 许可证
291
-
292
- Apache-2.0 © [ymkiux](https://github.com/ymkiux)
337
+ ## 技术栈
338
+
339
+ - **Node.js** - 运行环境
340
+ - **@iarna/toml** - TOML 配置文件解析
341
+ - **Vue.js 3** - Web 界面框架
342
+ - **原生 HTTP** - 内建 Web 服务器
343
+
344
+ ## 发布（GitHub Actions）
345
+
346
+ 创建与 `package.json` 版本一致的标签（例如 `v0.0.1`）。然后在 GitHub Actions 中手动运行 `release` 工作流并输入该标签，系统会创建 GitHub Release，并附带 `npm pack` 生成的 `.tgz` 产物。
347
+
348
+ ## 许可证
349
+
350
+ Apache-2.0 © [ymkiux](https://github.com/ymkiux)
293
351
 
294
352
  ## 贡献
295
353