codexmate 0.0.25 → 0.0.26

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 (135) hide show
  1. package/README.md +416 -413
  2. package/README.zh.md +349 -346
  3. package/cli/agents-files.js +224 -224
  4. package/cli/archive-helpers.js +446 -446
  5. package/cli/auth-profiles.js +375 -375
  6. package/cli/builtin-proxy.js +1079 -1079
  7. package/cli/claude-proxy.js +1022 -1022
  8. package/cli/config-bootstrap.js +384 -384
  9. package/cli/config-health.js +338 -338
  10. package/cli/doctor-core.js +903 -903
  11. package/cli/import-skills-url.js +356 -356
  12. package/cli/openai-bridge.js +997 -997
  13. package/cli/openclaw-config.js +629 -629
  14. package/cli/session-convert-args.js +65 -0
  15. package/cli/session-convert-io.js +82 -0
  16. package/cli/session-convert.js +43 -0
  17. package/cli/session-usage.concurrent.js +28 -28
  18. package/cli/session-usage.js +118 -118
  19. package/cli/session-usage.models.js +176 -176
  20. package/cli/skills.js +1141 -1141
  21. package/cli/zip-commands.js +510 -510
  22. package/cli.js +15218 -14736
  23. package/lib/automation.js +404 -404
  24. package/lib/cli-file-utils.js +151 -151
  25. package/lib/cli-models-utils.js +379 -379
  26. package/lib/cli-network-utils.js +190 -190
  27. package/lib/cli-path-utils.js +85 -85
  28. package/lib/cli-session-utils.js +121 -121
  29. package/lib/cli-sessions.js +417 -417
  30. package/lib/cli-utils.js +155 -155
  31. package/lib/download-artifacts.js +92 -92
  32. package/lib/mcp-stdio.js +453 -453
  33. package/lib/task-orchestrator.js +869 -869
  34. package/lib/text-diff.js +303 -303
  35. package/lib/workflow-engine.js +340 -340
  36. package/package.json +74 -74
  37. package/plugins/README.md +20 -20
  38. package/plugins/README.zh-CN.md +20 -20
  39. package/plugins/prompt-templates/comment-polish/index.mjs +25 -25
  40. package/plugins/prompt-templates/computed.mjs +253 -253
  41. package/plugins/prompt-templates/index.mjs +8 -8
  42. package/plugins/prompt-templates/manifest.mjs +15 -15
  43. package/plugins/prompt-templates/methods.mjs +619 -619
  44. package/plugins/prompt-templates/overview.mjs +90 -90
  45. package/plugins/prompt-templates/ownership.mjs +19 -19
  46. package/plugins/prompt-templates/rule-ack/index.mjs +21 -21
  47. package/plugins/prompt-templates/storage.mjs +64 -64
  48. package/plugins/registry.mjs +16 -16
  49. package/web-ui/app.js +625 -612
  50. package/web-ui/index.html +35 -35
  51. package/web-ui/logic.agents-diff.mjs +386 -386
  52. package/web-ui/logic.claude.mjs +168 -168
  53. package/web-ui/logic.mjs +5 -5
  54. package/web-ui/logic.runtime.mjs +128 -128
  55. package/web-ui/logic.session-convert.mjs +70 -0
  56. package/web-ui/logic.sessions.mjs +709 -614
  57. package/web-ui/modules/api.mjs +90 -90
  58. package/web-ui/modules/app.computed.dashboard.mjs +171 -128
  59. package/web-ui/modules/app.computed.index.mjs +17 -17
  60. package/web-ui/modules/app.computed.main-tabs.mjs +205 -205
  61. package/web-ui/modules/app.computed.session.mjs +946 -670
  62. package/web-ui/modules/app.constants.mjs +15 -15
  63. package/web-ui/modules/app.methods.agents.mjs +632 -632
  64. package/web-ui/modules/app.methods.claude-config.mjs +179 -174
  65. package/web-ui/modules/app.methods.codex-config.mjs +860 -784
  66. package/web-ui/modules/app.methods.index.mjs +92 -92
  67. package/web-ui/modules/app.methods.install.mjs +205 -205
  68. package/web-ui/modules/app.methods.navigation.mjs +743 -695
  69. package/web-ui/modules/app.methods.openclaw-core.mjs +814 -814
  70. package/web-ui/modules/app.methods.openclaw-editing.mjs +372 -372
  71. package/web-ui/modules/app.methods.openclaw-persist.mjs +369 -369
  72. package/web-ui/modules/app.methods.providers.mjs +404 -404
  73. package/web-ui/modules/app.methods.runtime.mjs +345 -345
  74. package/web-ui/modules/app.methods.session-actions.mjs +596 -544
  75. package/web-ui/modules/app.methods.session-browser.mjs +985 -722
  76. package/web-ui/modules/app.methods.session-timeline.mjs +479 -448
  77. package/web-ui/modules/app.methods.session-trash.mjs +424 -424
  78. package/web-ui/modules/app.methods.startup-claude.mjs +522 -417
  79. package/web-ui/modules/app.methods.task-orchestration.mjs +556 -556
  80. package/web-ui/modules/config-mode.computed.mjs +124 -124
  81. package/web-ui/modules/config-template-confirm-pref.mjs +33 -33
  82. package/web-ui/modules/i18n.dict.mjs +2113 -2055
  83. package/web-ui/modules/i18n.mjs +56 -56
  84. package/web-ui/modules/plugins.computed.mjs +3 -3
  85. package/web-ui/modules/plugins.methods.mjs +3 -3
  86. package/web-ui/modules/plugins.storage.mjs +11 -11
  87. package/web-ui/modules/sessions-filters-url.mjs +85 -85
  88. package/web-ui/modules/skills.computed.mjs +107 -107
  89. package/web-ui/modules/skills.methods.mjs +481 -481
  90. package/web-ui/partials/index/layout-footer.html +13 -13
  91. package/web-ui/partials/index/layout-header.html +475 -475
  92. package/web-ui/partials/index/modal-config-template-agents.html +174 -174
  93. package/web-ui/partials/index/modal-confirm-toast.html +32 -32
  94. package/web-ui/partials/index/modal-health-check.html +45 -45
  95. package/web-ui/partials/index/modal-openclaw-config.html +280 -280
  96. package/web-ui/partials/index/modal-skills.html +200 -200
  97. package/web-ui/partials/index/modals-basic.html +165 -165
  98. package/web-ui/partials/index/panel-config-claude.html +184 -179
  99. package/web-ui/partials/index/panel-config-codex.html +283 -283
  100. package/web-ui/partials/index/panel-config-openclaw.html +83 -83
  101. package/web-ui/partials/index/panel-dashboard.html +186 -186
  102. package/web-ui/partials/index/panel-docs.html +147 -147
  103. package/web-ui/partials/index/panel-market.html +177 -177
  104. package/web-ui/partials/index/panel-orchestration.html +391 -391
  105. package/web-ui/partials/index/panel-plugins.html +279 -279
  106. package/web-ui/partials/index/panel-sessions.html +326 -303
  107. package/web-ui/partials/index/panel-settings.html +258 -258
  108. package/web-ui/partials/index/panel-usage.html +342 -361
  109. package/web-ui/res/json5.min.js +1 -1
  110. package/web-ui/res/vue.global.prod.js +13 -13
  111. package/web-ui/session-helpers.mjs +576 -573
  112. package/web-ui/source-bundle.cjs +233 -233
  113. package/web-ui/styles/base-theme.css +268 -264
  114. package/web-ui/styles/controls-forms.css +423 -423
  115. package/web-ui/styles/dashboard.css +274 -274
  116. package/web-ui/styles/docs-panel.css +247 -247
  117. package/web-ui/styles/feedback.css +108 -108
  118. package/web-ui/styles/health-check-dialog.css +144 -144
  119. package/web-ui/styles/layout-shell.css +603 -603
  120. package/web-ui/styles/modals-core.css +464 -464
  121. package/web-ui/styles/navigation-panels.css +390 -390
  122. package/web-ui/styles/openclaw-structured.css +266 -266
  123. package/web-ui/styles/plugins-panel.css +523 -523
  124. package/web-ui/styles/responsive.css +454 -454
  125. package/web-ui/styles/sessions-list.css +415 -398
  126. package/web-ui/styles/sessions-preview.css +411 -411
  127. package/web-ui/styles/sessions-toolbar-trash.css +330 -268
  128. package/web-ui/styles/sessions-usage.css +945 -912
  129. package/web-ui/styles/settings-panel.css +166 -166
  130. package/web-ui/styles/skills-list.css +303 -303
  131. package/web-ui/styles/skills-market.css +406 -406
  132. package/web-ui/styles/task-orchestration.css +822 -822
  133. package/web-ui/styles/titles-cards.css +408 -408
  134. package/web-ui/styles.css +21 -21
  135. package/web-ui.html +17 -17
package/README.zh.md CHANGED
@@ -1,346 +1,349 @@
1
- <div align="center">
2
-
3
- <img src="site/.vitepress/public/images/logo.png" alt="Codex Mate logo" width="180" />
4
-
5
- # Codex Mate
6
-
7
- **Codex / Claude Code / OpenClaw 的本地控制台:配置、会话与 Usage 统计一体化管理。**
8
-
9
- [![Build](https://img.shields.io/github/actions/workflow/status/SakuraByteCore/codexmate/release.yml?label=build&style=flat)](https://github.com/SakuraByteCore/codexmate/actions/workflows/release.yml)
10
- [![Version](https://img.shields.io/npm/v/codexmate?label=version&style=flat)](https://www.npmjs.com/package/codexmate)
11
- [![Downloads](https://img.shields.io/npm/dt/codexmate?label=downloads&style=flat)](https://www.npmjs.com/package/codexmate)
12
- [![Node](https://img.shields.io/node/v/codexmate?label=Node.js&style=flat&logo=node.js&logoColor=white)](https://nodejs.org/)
13
- [![License](https://img.shields.io/npm/l/codexmate?label=license&style=flat)](LICENSE)
14
- [![Stars](https://img.shields.io/github/stars/SakuraByteCore/codexmate?label=stars&style=flat)](https://github.com/SakuraByteCore/codexmate/stargazers)
15
- [![Issues](https://img.shields.io/github/issues/SakuraByteCore/codexmate?label=issues&style=flat)](https://github.com/SakuraByteCore/codexmate/issues)
16
-
17
- [文档](https://sakurabytecore.github.io/codexmate/) · [快速开始](#快速开始) · [命令速查](#命令速查) · [Web 界面](#web-界面) · [MCP](#mcp) · [English](README.md)
18
-
19
- </div>
20
-
21
- ---
22
-
23
- ## 这是什么?
24
-
25
- Codex Mate 提供一套本地优先的 CLI + Web UI,用于统一管理:
26
-
27
- - Codex 的 provider / model 切换与配置写入
28
- - Claude Code 配置方案(写入 `~/.claude/settings.json`)
29
- - Claude Code `CLAUDE.md` 编辑(写入 `~/.claude/CLAUDE.md`)
30
- - OpenClaw JSON5 配置与 Workspace `AGENTS.md`
31
- - Codex / Claude Code Skills 市场(安装目标切换、本地 skills 管理、跨应用导入、ZIP 分发)
32
- - Codex / Claude / Gemini CLI / CodeBuddy Code 本地会话浏览、筛选、导出、删除与 Usage 统计概览
33
- - 插件(提示词模板):模板复用、变量填写、一键复制
34
- - 任务编排:规划 / 排队 / 执行 / 回看
35
-
36
- 项目不依赖云端托管,配置写入你的本地文件,便于审计和回滚。Skills 市场同样坚持本地优先,只操作本地目录,不依赖远程在线市场。
37
-
38
- ## 功能对比
39
-
40
- | 维度 | Codex Mate | 手动维护配置 |
41
- | --- | --- | --- |
42
- | 多工具管理 | Codex + Claude Code + OpenClaw 统一入口 | 多文件、多目录分散修改 |
43
- | 使用方式 | CLI + 本地 Web UI | 纯手改 TOML / JSON / JSON5 |
44
- | 会话处理 | 支持浏览、筛选、Usage 统计、导出、批量清理 | 需要手动定位和处理文件 |
45
- | Skills 复用 | 本地 Skills 市场 + 跨应用导入 + ZIP 分发 | 目录手动复制,容易遗漏 |
46
- | 使用可见性 | 统一查看配置、会话、Usage 与运行状态 | 依赖手工翻文件和零散命令 |
47
- | 可回滚性 | 首次接管前自动备份 | 易误覆盖、回滚成本高 |
48
- | 自动化接入 | 提供 MCP stdio(默认只读) | 需自行封装脚本 |
49
-
50
- ## 核心特性
51
-
52
- **配置管理**
53
- - provider / model 切换(`switch` / `use`)
54
- - Codex `config.toml` 模板确认后写入
55
- - Claude Code 多配置方案管理与一键应用
56
- - Claude Code `CLAUDE.md` 编辑(写入 `~/.claude/CLAUDE.md`)
57
- - 分享命令前缀切换(`npm start` / `codexmate`),用于复制 provider / Claude 导入命令
58
- - OpenClaw JSON5 配置方案管理
59
-
60
- **会话管理**
61
- - 同页查看 Codex、Claude、Gemini CLI 与 CodeBuddy Code 会话
62
- - 会话来源与默认路径(本地优先,可通过环境变量覆盖):
63
- - Codex:`~/.codex/sessions/*.jsonl`(或 `$CODEX_HOME/sessions`、`$XDG_CONFIG_HOME/codex/sessions`)
64
- - Claude:`~/.claude/projects/**/**/*.jsonl`(或 `$CLAUDE_HOME/projects`、`$XDG_CONFIG_HOME/claude/projects`)
65
- - Gemini:`~/.gemini/tmp/*/chats/*.json`(或 `$GEMINI_HOME/tmp`、`$XDG_CONFIG_HOME/gemini/tmp`)
66
- - CodeBuddy:`~/.codebuddy/projects/**/**/*.jsonl`(或 `$CODEBUDDY_CODE_HOME_DIR/projects`)
67
- - 支持本地会话置顶,置顶状态持久化保存并优先排序显示
68
- - 关键词搜索、来源筛选、cwd/角色/时间筛选,并支持复制筛选链接
69
- - 复制恢复命令(Codex/Gemini/CodeBuddy):`codex resume <sessionId>` / `gemini -r <sessionId>` / `codebuddy -r <sessionId>`
70
- - 搜索体验优化:短周期结果缓存,避免输入时重复扫描
71
- - Usage 子页:近 7 天 / 近 30 天会话趋势、消息趋势、来源占比、高频路径
72
- - 会话导出 Markdown(Web UI + `codexmate export-session`,支持 `--session-id` `--file`)
73
- - 会话与消息级删除(支持批量),并提供本地回收站用于恢复/彻底删除
74
- - 大会话预览优化(快速 tail 预览路径)
75
-
76
- **Skills 市场**
77
- - Codex 与 Claude Code 之间切换 skills 安装目标
78
- - 查看本地已安装 skills、根目录与状态
79
- - 扫描 `Codex` / `Claude Code` / `Agents` 可导入来源
80
- - 支持跨应用导入、ZIP 导入 / 导出、批量删除
81
-
82
- **插件**
83
- - 提示词模板:本地保存/编辑/复用(支持变量)
84
- - 编写 → 填参 → 一键复制的工作流(模板数据保存在浏览器存储)
85
-
86
- **任务编排**
87
- - DAG 节点拆分与波次并发
88
- - 支持计划预览、执行、队列与运行详情
89
-
90
- **工程能力**
91
- - MCP stdio 能力(tools/resources/prompts)
92
- - 自动化钩子(`/hooks/*`)+ 外发 webhook 通知
93
- - Zip 压缩/解压(优先系统工具,失败回退 JS 库)
94
-
95
- ## 自动化(信号 行动)
96
-
97
- 运行 `codexmate run` 后,可接收外部 webhook 并转为任务队列:
98
-
99
- - 入口:`POST /hooks/<source>`(当前支持 `github`、`gitlab`)
100
- - 规则:`~/.codex/codexmate-automation.json`
101
- - 动作:`task.queue.add`(可选 `startQueue: true`)
102
- - 通知:`notifiers[]` 支持 `type: "webhook"`(适配 Slack/飞书等入站 webhook)
103
-
104
- ## 架构总览
105
-
106
- ### 一图看懂(从“做什么”到“产生什么效果”)
107
-
108
- ```mermaid
109
- flowchart LR
110
- subgraph You["你"]
111
- CLI["CLI 命令"]
112
- WEB["Web UI"]
113
- MCP["MCP 调用"]
114
- end
115
-
116
- subgraph Mate["Codex Mate(本地控制台)"]
117
- API["本地 HTTP API"]
118
- CFG["配置管理"]
119
- SESS["会话/Usage 管理"]
120
- SKL["Skills 管理"]
121
- PLG["插件:提示词模板"]
122
- end
123
-
124
- subgraph Files["只操作你的本地文件(可审计/可回滚)"]
125
- CODEX["~/.codex/*"]
126
- CLAUDE["~/.claude/settings.json + CLAUDE.md"]
127
- OPENCLAW["~/.openclaw/*.json5 + ~/.openclaw/openclaw.json + workspace/AGENTS.md"]
128
- SKILLS["~/.{codex,claude,agents}/skills"]
129
- SESSFILES["sessions / usage / trash / runs"]
130
- BROWSER["浏览器存储(模板)"]
131
- end
132
-
133
- CLI --> API
134
- WEB --> API
135
- MCP --> API
136
- WEB --> PLG
137
-
138
- API --> CFG
139
- API --> SESS
140
- API --> SKL
141
- PLG --> BROWSER
142
-
143
- CFG --> CODEX
144
- CFG --> CLAUDE
145
- CFG --> OPENCLAW
146
- SKL --> SKILLS
147
- SESS --> SESSFILES
148
- ```
149
-
150
- ### 能力 → 作用对象 → 用户收益(直观对照)
151
-
152
- | 能力 | 作用对象(本地) | 你能直接得到什么 |
153
- | --- | --- | --- |
154
- | 配置管理(Codex / Claude / OpenClaw) | `~/.codex/*`、`~/.claude/settings.json`、`~/.claude/CLAUDE.md`、`~/.openclaw/*` | 一键切换 provider/model、管理多套配置、写入前后可控与可回滚 |
155
- | 会话与 Usage | sessions / usage 聚合 / trash | 更快定位会话、筛选导出、批量清理、查看趋势与占比 |
156
- | Skills 市场 | `~/.{codex,claude,agents}/skills` | 本地安装/导入/导出/分发(ZIP),跨应用复用更省事 |
157
- | 插件(提示词模板) | 浏览器存储 | 可复用的提示词模板(变量 + 一键复制) |
158
- | MCP(stdio) | 本地 API / 文件能力 | 让外部工具以“可控权限”调用本地能力(默认只读) |
159
-
160
- ## 快速开始
161
-
162
- ### npm 全局安装
163
-
164
- ```bash
165
- npm install -g codexmate
166
- codexmate setup
167
- codexmate status
168
- codexmate run
169
- ```
170
-
171
- 默认监听 `0.0.0.0:3737`,支持局域网访问,并尝试自动打开浏览器。
172
-
173
- > 安全提示:默认监听会在当前局域网暴露未鉴权的管理界面。若包含 API Key、provider 配置或 skills 管理,请仅在可信网络中使用;如需仅本机访问,可设置 `CODEXMATE_HOST=127.0.0.1` 或启动时传入 `--host 127.0.0.1`。
174
-
175
- ### 安装 Codex CLI / Claude Code / Gemini CLI / CodeBuddy Code(可选)
176
-
177
- Codex Mate 支持透传调用官方 CLI(例如 `codexmate codex ...`),建议先安装:
178
-
179
- ```bash
180
- # Codex CLI(默认)
181
- npm install -g @openai/codex
182
-
183
- # Termux(Android)上的 Codex CLI
184
- npm install -g @mmmbuto/codex-cli-termux@latest
185
-
186
- # Claude Code
187
- npm install -g @anthropic-ai/claude-code
188
-
189
- # Gemini CLI
190
- npm install -g @google/gemini-cli
191
-
192
- # CodeBuddy Code
193
- npm install -g @tencent-ai/codebuddy-code
194
- ```
195
-
196
- ### 从源码运行
197
-
198
- ```bash
199
- git clone https://github.com/SakuraByteCore/codexmate.git
200
- cd codexmate
201
- npm install
202
- npm start run
203
- ```
204
-
205
- ### 测试 / CI(只启动服务)
206
-
207
- ```bash
208
- npm start run --no-browser
209
- ```
210
-
211
- > 约定:自动化测试仅验证服务与 API,不依赖打开页面。
212
-
213
- ### 开发辅助脚本
214
-
215
- ```bash
216
- npm run reset
217
- npm run reset 79
218
- ```
219
-
220
- - `npm run reset`:直接重置到默认 `origin/main`
221
- - `npm run reset 79`:直接同步到 PR `#79` 的最新 head 快照
222
- - 脚本会自动完成本地分支切换、工作区清理、未跟踪文件清理与最终状态校验
223
-
224
- ## 命令速查
225
-
226
- | 命令 | 说明 |
227
- | --- | --- |
228
- | `codexmate status` | 查看当前配置状态 |
229
- | `codexmate setup` | 交互式初始化 |
230
- | `codexmate list` / `codexmate models` | 查看提供商 / 模型 |
231
- | `codexmate switch <provider>` / `codexmate use <model>` | 切换 provider / model |
232
- | `codexmate add <name> <URL> [API_KEY]` | 添加提供商 |
233
- | `codexmate delete <name>` | 删除提供商 |
234
- | `codexmate claude <BaseURL> <API_KEY> [model]` | 写入 Claude Code 配置 |
235
- | `codexmate workflow <list\|get\|validate\|run\|runs>` | MCP 工作流管理 |
236
- | `codexmate codex [args...] [--follow-up <文本> 可重复]` | Codex CLI 透传入口(默认补 `--yolo`,可追加 queued follow-up) |
237
- | `codexmate qwen [args...]` | Qwen CLI 透传入口 |
238
- | `codexmate run [--host <HOST>] [--no-browser]` | 启动 Web UI |
239
- | `codexmate mcp serve [--read-only\|--allow-write]` | 启动 MCP stdio 服务 |
240
- | `codexmate export-session --source <codex\|claude\|gemini\|codebuddy> ...` | 导出会话为 Markdown |
241
- | `codexmate zip <path> [--max:0-9]` / `codexmate unzip <zip> [out]` | 压缩 / 解压 |
242
- | `codexmate unzip-ext <zip-dir> [out] [--ext:suffix[,suffix...]] [--no-recursive]` | 批量提取目录下 ZIP 内指定后缀文件(默认 `.json`,默认递归) |
243
-
244
- ### Codex follow-up 追加(可选)
245
-
246
- ```bash
247
- codexmate codex --follow-up "先扫描项目" --follow-up "再修复失败测试"
248
- codexmate codex --model gpt-5.3-codex --follow-up "步骤1" --follow-up "步骤2"
249
- ```
250
-
251
- > 说明:`--follow-up` / `--queued-follow-up` 都可用,支持重复。
252
-
253
- ## Web 界面
254
-
255
- ### Codex 配置模式
256
- - provider / model 切换
257
- - 模型管理
258
- - `~/.codex/AGENTS.md` 编辑
259
-
260
- ### Claude Code 配置模式
261
- - 多配置方案管理
262
- - 默认写入 `~/.claude/settings.json`
263
- - `~/.claude/CLAUDE.md` 编辑
264
- - 支持复制分享导入命令
265
-
266
- ### OpenClaw 配置模式
267
- - JSON5 多方案管理
268
- - 应用到 `~/.openclaw/openclaw.json`
269
- - 管理 `~/.openclaw/workspace/AGENTS.md`
270
-
271
- ### Plugins 模式(提示词模板)
272
- - 入口:顶部切到 **Plugins** → **提示词模板**
273
- - 支持管理自定义模板(导入/导出 JSON)
274
- - 变量管理:在 **管理** 中可“新增变量”(插入 `{{var}}`),并在 Variables 区填写变量值
275
- - 生成与复制:变量填写后可在 **Preview** 里一键复制最终提示词
276
- - 内置模板:仅提供一个“代码注释润色”,只读不可编辑
277
-
278
- ### 会话模式
279
- - Codex + Claude 会话统一列表
280
- - Browser / Usage 双子视图切换
281
- - 支持本地会话置顶、持久化保存与置顶优先排序
282
- - 搜索、筛选、导出、删除、批量清理
283
- - Usage 视图提供近 7 天 / 30 天会话趋势、消息趋势、来源占比与高频路径统计
284
- - 费用估算当前只统计可识别模型单价的非 Claude 会话
285
-
286
- ### Skills 市场标签页
287
- - `Codex` 与 `Claude Code` 之间切换 skills 安装目标
288
- - 展示当前目标的本地 skills 根目录、已安装项和可导入项
289
- - 扫描 `Codex` / `Claude Code` / `Agents` 目录中的可导入来源
290
- - 支持跨应用导入、ZIP 导入 / 导出、批量删除
291
-
292
- ### 设置标签页
293
- - 支持切换分享命令前缀:`npm start` / `codexmate`
294
- - 影响 Web UI 中复制出来的 provider 分享命令与 Claude 导入命令
295
-
296
- ## MCP
297
-
298
- > 传输:`stdio`
299
-
300
- - 传输:仅 `stdio`
301
- - 默认:只读工具集
302
- - 写入开启:`--allow-write` 或 `CODEXMATE_MCP_ALLOW_WRITE=1`
303
- - 包含域:`tools`、`resources`、`prompts`
304
-
305
- 示例:
306
-
307
- ```bash
308
- codexmate mcp serve --read-only
309
- codexmate mcp serve --allow-write
310
- ```
311
-
312
- ## 配置文件
313
-
314
- - `~/.codex/config.toml`
315
- - `~/.codex/auth.json`
316
- - `~/.codex/models.json`
317
- - `~/.codex/provider-current-models.json`
318
- - `~/.claude/settings.json`
319
- - `~/.claude/CLAUDE.md`
320
- - `~/.openclaw/openclaw.json`
321
- - `~/.openclaw/workspace/AGENTS.md`
322
-
323
- ## 环境变量
324
-
325
- | 变量 | 默认值 | 说明 |
326
- | --- | --- | --- |
327
- | `CODEXMATE_PORT` | `3737` | Web 服务端口 |
328
- | `CODEXMATE_HOST` | `0.0.0.0` | Web 服务监听地址(如需仅本机访问,显式设为 `127.0.0.1`) |
329
- | `CODEXMATE_NO_BROWSER` | 未设置 | 设为 `1` 后不自动打开浏览器 |
330
- | `CODEXMATE_MCP_ALLOW_WRITE` | 未设置 | 设为 `1` 后默认允许 MCP 写工具 |
331
- | `CODEXMATE_FORCE_RESET_EXISTING_CONFIG` | `0` | 设为 `1` 时首次可强制重建托管配置 |
332
-
333
- ## 技术栈
334
-
335
- - Node.js
336
- - Vue.js 3(Web UI)
337
- - 原生 HTTP Server
338
- - `@iarna/toml`、`json5`
339
-
340
- ## 参与贡献
341
-
342
- Issue 与 Pull Request 可按需提交。
343
-
344
- ## License
345
-
346
- Apache-2.0
1
+ <div align="center">
2
+
3
+ <img src="site/.vitepress/public/images/logo.png" alt="Codex Mate logo" width="180" />
4
+
5
+ # Codex Mate
6
+
7
+ **本地优先的 CLI + Web UI:直接写入你的本地配置与会话文件,内置 Usage 统计,并提供可审计、可回滚的变更保护。**
8
+
9
+ [![Build](https://img.shields.io/github/actions/workflow/status/SakuraByteCore/codexmate/release.yml?label=build&style=flat)](https://github.com/SakuraByteCore/codexmate/actions/workflows/release.yml)
10
+ [![Version](https://img.shields.io/npm/v/codexmate?label=version&style=flat)](https://www.npmjs.com/package/codexmate)
11
+ [![Downloads](https://img.shields.io/npm/dt/codexmate?label=downloads&style=flat)](https://www.npmjs.com/package/codexmate)
12
+ [![Node](https://img.shields.io/node/v/codexmate?label=Node.js&style=flat&logo=node.js&logoColor=white)](https://nodejs.org/)
13
+ [![License](https://img.shields.io/npm/l/codexmate?label=license&style=flat)](LICENSE)
14
+ [![Stars](https://img.shields.io/github/stars/SakuraByteCore/codexmate?label=stars&style=flat)](https://github.com/SakuraByteCore/codexmate/stargazers)
15
+ [![Issues](https://img.shields.io/github/issues/SakuraByteCore/codexmate?label=issues&style=flat)](https://github.com/SakuraByteCore/codexmate/issues)
16
+
17
+ [文档](https://sakurabytecore.github.io/codexmate/) · [快速开始](#快速开始) · [命令速查](#命令速查) · [Web 界面](#web-界面) · [MCP](#mcp) · [English](README.md)
18
+
19
+ <br />
20
+ <img src="site/.vitepress/public/images/readme-hero.png" alt="Codex Mate 界面预览" width="960" />
21
+
22
+ </div>
23
+
24
+ ---
25
+
26
+ ## 这是什么?
27
+
28
+ Codex Mate 提供一套本地优先的 CLI + Web UI,用于统一管理:
29
+
30
+ - Codex provider / model 切换与配置写入
31
+ - Claude Code 配置方案(写入 `~/.claude/settings.json`)
32
+ - Claude Code `CLAUDE.md` 编辑(写入 `~/.claude/CLAUDE.md`)
33
+ - OpenClaw JSON5 配置与 Workspace `AGENTS.md`
34
+ - Codex / Claude Code Skills 市场(安装目标切换、本地 skills 管理、跨应用导入、ZIP 分发)
35
+ - Codex / Claude / Gemini CLI / CodeBuddy Code 本地会话浏览、筛选、导出、删除与 Usage 统计概览
36
+ - 插件(提示词模板):模板复用、变量填写、一键复制
37
+ - 任务编排:规划 / 排队 / 执行 / 回看
38
+
39
+ 项目不依赖云端托管,配置写入你的本地文件,便于审计和回滚。Skills 市场同样坚持本地优先,只操作本地目录,不依赖远程在线市场。
40
+
41
+ ## 功能对比
42
+
43
+ | 维度 | Codex Mate | 手动维护配置 |
44
+ | --- | --- | --- |
45
+ | 多工具管理 | Codex + Claude Code + OpenClaw 统一入口 | 多文件、多目录分散修改 |
46
+ | 使用方式 | CLI + 本地 Web UI | 纯手改 TOML / JSON / JSON5 |
47
+ | 会话处理 | 支持浏览、筛选、Usage 统计、导出、批量清理 | 需要手动定位和处理文件 |
48
+ | Skills 复用 | 本地 Skills 市场 + 跨应用导入 + ZIP 分发 | 目录手动复制,容易遗漏 |
49
+ | 使用可见性 | 统一查看配置、会话、Usage 与运行状态 | 依赖手工翻文件和零散命令 |
50
+ | 可回滚性 | 首次接管前自动备份 | 易误覆盖、回滚成本高 |
51
+ | 自动化接入 | 提供 MCP stdio(默认只读) | 需自行封装脚本 |
52
+
53
+ ## 核心特性
54
+
55
+ **配置管理**
56
+ - provider / model 切换(`switch` / `use`)
57
+ - Codex `config.toml` 模板确认后写入
58
+ - Claude Code 多配置方案管理与一键应用
59
+ - Claude Code `CLAUDE.md` 编辑(写入 `~/.claude/CLAUDE.md`)
60
+ - 分享命令前缀切换(`npm start` / `codexmate`),用于复制 provider / Claude 导入命令
61
+ - OpenClaw JSON5 配置方案管理
62
+
63
+ **会话管理**
64
+ - 同页查看 Codex、Claude、Gemini CLI 与 CodeBuddy Code 会话
65
+ - 会话来源与默认路径(本地优先,可通过环境变量覆盖):
66
+ - Codex:`~/.codex/sessions/*.jsonl`(或 `$CODEX_HOME/sessions`、`$XDG_CONFIG_HOME/codex/sessions`)
67
+ - Claude:`~/.claude/projects/**/**/*.jsonl`(或 `$CLAUDE_HOME/projects`、`$XDG_CONFIG_HOME/claude/projects`)
68
+ - Gemini:`~/.gemini/tmp/*/chats/*.json`(或 `$GEMINI_HOME/tmp`、`$XDG_CONFIG_HOME/gemini/tmp`)
69
+ - CodeBuddy:`~/.codebuddy/projects/**/**/*.jsonl`(或 `$CODEBUDDY_CODE_HOME_DIR/projects`)
70
+ - 支持本地会话置顶,置顶状态持久化保存并优先排序显示
71
+ - 关键词搜索、来源筛选、cwd/角色/时间筛选,并支持复制筛选链接
72
+ - 复制恢复命令(Codex/Gemini/CodeBuddy):`codex resume <sessionId>` / `gemini -r <sessionId>` / `codebuddy -r <sessionId>`
73
+ - 搜索体验优化:短周期结果缓存,避免输入时重复扫描
74
+ - Usage 子页:近 7 天 / 近 30 天会话趋势、消息趋势、来源占比、高频路径
75
+ - 会话导出 Markdown(Web UI + `codexmate export-session`,支持 `--session-id` 或 `--file`)
76
+ - 会话与消息级删除(支持批量),并提供本地回收站用于恢复/彻底删除
77
+ - 大会话预览优化(快速 tail 预览路径)
78
+
79
+ **Skills 市场**
80
+ - Codex Claude Code 之间切换 skills 安装目标
81
+ - 查看本地已安装 skills、根目录与状态
82
+ - 扫描 `Codex` / `Claude Code` / `Agents` 可导入来源
83
+ - 支持跨应用导入、ZIP 导入 / 导出、批量删除
84
+
85
+ **插件**
86
+ - 提示词模板:本地保存/编辑/复用(支持变量)
87
+ - 编写 → 填参 → 一键复制的工作流(模板数据保存在浏览器存储)
88
+
89
+ **任务编排**
90
+ - DAG 节点拆分与波次并发
91
+ - 支持计划预览、执行、队列与运行详情
92
+
93
+ **工程能力**
94
+ - MCP stdio 能力(tools/resources/prompts)
95
+ - 自动化钩子(`/hooks/*`)+ 外发 webhook 通知
96
+ - Zip 压缩/解压(优先系统工具,失败回退 JS 库)
97
+
98
+ ## 自动化(信号 → 行动)
99
+
100
+ 运行 `codexmate run` 后,可接收外部 webhook 并转为任务队列:
101
+
102
+ - 入口:`POST /hooks/<source>`(当前支持 `github`、`gitlab`)
103
+ - 规则:`~/.codex/codexmate-automation.json`
104
+ - 动作:`task.queue.add`(可选 `startQueue: true`)
105
+ - 通知:`notifiers[]` 支持 `type: "webhook"`(适配 Slack/飞书等入站 webhook)
106
+
107
+ ## 架构总览
108
+
109
+ ### 一图看懂(从“做什么”到“产生什么效果”)
110
+
111
+ ```mermaid
112
+ flowchart LR
113
+ subgraph You[""]
114
+ CLI["CLI 命令"]
115
+ WEB["Web UI"]
116
+ MCP["MCP 调用"]
117
+ end
118
+
119
+ subgraph Mate["Codex Mate(本地控制台)"]
120
+ API["本地 HTTP API"]
121
+ CFG["配置管理"]
122
+ SESS["会话/Usage 管理"]
123
+ SKL["Skills 管理"]
124
+ PLG["插件:提示词模板"]
125
+ end
126
+
127
+ subgraph Files["只操作你的本地文件(可审计/可回滚)"]
128
+ CODEX["~/.codex/*"]
129
+ CLAUDE["~/.claude/settings.json + CLAUDE.md"]
130
+ OPENCLAW["~/.openclaw/*.json5 + ~/.openclaw/openclaw.json + workspace/AGENTS.md"]
131
+ SKILLS["~/.{codex,claude,agents}/skills"]
132
+ SESSFILES["sessions / usage / trash / runs"]
133
+ BROWSER["浏览器存储(模板)"]
134
+ end
135
+
136
+ CLI --> API
137
+ WEB --> API
138
+ MCP --> API
139
+ WEB --> PLG
140
+
141
+ API --> CFG
142
+ API --> SESS
143
+ API --> SKL
144
+ PLG --> BROWSER
145
+
146
+ CFG --> CODEX
147
+ CFG --> CLAUDE
148
+ CFG --> OPENCLAW
149
+ SKL --> SKILLS
150
+ SESS --> SESSFILES
151
+ ```
152
+
153
+ ### 能力 作用对象 用户收益(直观对照)
154
+
155
+ | 能力 | 作用对象(本地) | 你能直接得到什么 |
156
+ | --- | --- | --- |
157
+ | 配置管理(Codex / Claude / OpenClaw) | `~/.codex/*`、`~/.claude/settings.json`、`~/.claude/CLAUDE.md`、`~/.openclaw/*` | 一键切换 provider/model、管理多套配置、写入前后可控与可回滚 |
158
+ | 会话与 Usage | sessions / usage 聚合 / trash | 更快定位会话、筛选导出、批量清理、查看趋势与占比 |
159
+ | Skills 市场 | `~/.{codex,claude,agents}/skills` | 本地安装/导入/导出/分发(ZIP),跨应用复用更省事 |
160
+ | 插件(提示词模板) | 浏览器存储 | 可复用的提示词模板(变量 + 一键复制) |
161
+ | MCP(stdio) | 本地 API / 文件能力 | 让外部工具以“可控权限”调用本地能力(默认只读) |
162
+
163
+ ## 快速开始
164
+
165
+ ### npm 全局安装
166
+
167
+ ```bash
168
+ npm install -g codexmate
169
+ codexmate setup
170
+ codexmate status
171
+ codexmate run
172
+ ```
173
+
174
+ 默认监听 `0.0.0.0:3737`,支持局域网访问,并尝试自动打开浏览器。
175
+
176
+ > 安全提示:默认监听会在当前局域网暴露未鉴权的管理界面。若包含 API Key、provider 配置或 skills 管理,请仅在可信网络中使用;如需仅本机访问,可设置 `CODEXMATE_HOST=127.0.0.1` 或启动时传入 `--host 127.0.0.1`。
177
+
178
+ ### 安装 Codex CLI / Claude Code / Gemini CLI / CodeBuddy Code(可选)
179
+
180
+ Codex Mate 支持透传调用官方 CLI(例如 `codexmate codex ...`),建议先安装:
181
+
182
+ ```bash
183
+ # Codex CLI(默认)
184
+ npm install -g @openai/codex
185
+
186
+ # Termux(Android)上的 Codex CLI
187
+ npm install -g @mmmbuto/codex-cli-termux@latest
188
+
189
+ # Claude Code
190
+ npm install -g @anthropic-ai/claude-code
191
+
192
+ # Gemini CLI
193
+ npm install -g @google/gemini-cli
194
+
195
+ # CodeBuddy Code
196
+ npm install -g @tencent-ai/codebuddy-code
197
+ ```
198
+
199
+ ### 从源码运行
200
+
201
+ ```bash
202
+ git clone https://github.com/SakuraByteCore/codexmate.git
203
+ cd codexmate
204
+ npm install
205
+ npm start run
206
+ ```
207
+
208
+ ### 测试 / CI(只启动服务)
209
+
210
+ ```bash
211
+ npm start run --no-browser
212
+ ```
213
+
214
+ > 约定:自动化测试仅验证服务与 API,不依赖打开页面。
215
+
216
+ ### 开发辅助脚本
217
+
218
+ ```bash
219
+ npm run reset
220
+ npm run reset 79
221
+ ```
222
+
223
+ - `npm run reset`:直接重置到默认 `origin/main`
224
+ - `npm run reset 79`:直接同步到 PR `#79` 的最新 head 快照
225
+ - 脚本会自动完成本地分支切换、工作区清理、未跟踪文件清理与最终状态校验
226
+
227
+ ## 命令速查
228
+
229
+ | 命令 | 说明 |
230
+ | --- | --- |
231
+ | `codexmate status` | 查看当前配置状态 |
232
+ | `codexmate setup` | 交互式初始化 |
233
+ | `codexmate list` / `codexmate models` | 查看提供商 / 模型 |
234
+ | `codexmate switch <provider>` / `codexmate use <model>` | 切换 provider / model |
235
+ | `codexmate add <name> <URL> [API_KEY]` | 添加提供商 |
236
+ | `codexmate delete <name>` | 删除提供商 |
237
+ | `codexmate claude <BaseURL> <API_KEY> [model]` | 写入 Claude Code 配置 |
238
+ | `codexmate workflow <list\|get\|validate\|run\|runs>` | MCP 工作流管理 |
239
+ | `codexmate codex [args...] [--follow-up <文本> 可重复]` | Codex CLI 透传入口(默认补 `--yolo`,可追加 queued follow-up) |
240
+ | `codexmate qwen [args...]` | Qwen CLI 透传入口 |
241
+ | `codexmate run [--host <HOST>] [--no-browser]` | 启动 Web UI |
242
+ | `codexmate mcp serve [--read-only\|--allow-write]` | 启动 MCP stdio 服务 |
243
+ | `codexmate export-session --source <codex\|claude\|gemini\|codebuddy> ...` | 导出会话为 Markdown |
244
+ | `codexmate zip <path> [--max:0-9]` / `codexmate unzip <zip> [out]` | 压缩 / 解压 |
245
+ | `codexmate unzip-ext <zip-dir> [out] [--ext:suffix[,suffix...]] [--no-recursive]` | 批量提取目录下 ZIP 内指定后缀文件(默认 `.json`,默认递归) |
246
+
247
+ ### Codex follow-up 追加(可选)
248
+
249
+ ```bash
250
+ codexmate codex --follow-up "先扫描项目" --follow-up "再修复失败测试"
251
+ codexmate codex --model gpt-5.3-codex --follow-up "步骤1" --follow-up "步骤2"
252
+ ```
253
+
254
+ > 说明:`--follow-up` / `--queued-follow-up` 都可用,支持重复。
255
+
256
+ ## Web 界面
257
+
258
+ ### Codex 配置模式
259
+ - provider / model 切换
260
+ - 模型管理
261
+ - `~/.codex/AGENTS.md` 编辑
262
+
263
+ ### Claude Code 配置模式
264
+ - 多配置方案管理
265
+ - 默认写入 `~/.claude/settings.json`
266
+ - `~/.claude/CLAUDE.md` 编辑
267
+ - 支持复制分享导入命令
268
+
269
+ ### OpenClaw 配置模式
270
+ - JSON5 多方案管理
271
+ - 应用到 `~/.openclaw/openclaw.json`
272
+ - 管理 `~/.openclaw/workspace/AGENTS.md`
273
+
274
+ ### Plugins 模式(提示词模板)
275
+ - 入口:顶部切到 **Plugins** → **提示词模板**
276
+ - 支持管理自定义模板(导入/导出 JSON)
277
+ - 变量管理:在 **管理** 中可“新增变量”(插入 `{{var}}`),并在 Variables 区填写变量值
278
+ - 生成与复制:变量填写后可在 **Preview** 里一键复制最终提示词
279
+ - 内置模板:仅提供一个“代码注释润色”,只读不可编辑
280
+
281
+ ### 会话模式
282
+ - Codex + Claude 会话统一列表
283
+ - Browser / Usage 双子视图切换
284
+ - 支持本地会话置顶、持久化保存与置顶优先排序
285
+ - 搜索、筛选、导出、删除、批量清理
286
+ - Usage 视图提供近 7 天 / 近 30 天会话趋势、消息趋势、来源占比与高频路径统计
287
+ - 费用估算当前只统计可识别模型单价的非 Claude 会话
288
+
289
+ ### Skills 市场标签页
290
+ - `Codex` `Claude Code` 之间切换 skills 安装目标
291
+ - 展示当前目标的本地 skills 根目录、已安装项和可导入项
292
+ - 扫描 `Codex` / `Claude Code` / `Agents` 目录中的可导入来源
293
+ - 支持跨应用导入、ZIP 导入 / 导出、批量删除
294
+
295
+ ### 设置标签页
296
+ - 支持切换分享命令前缀:`npm start` / `codexmate`
297
+ - 影响 Web UI 中复制出来的 provider 分享命令与 Claude 导入命令
298
+
299
+ ## MCP
300
+
301
+ > 传输:`stdio`
302
+
303
+ - 传输:仅 `stdio`
304
+ - 默认:只读工具集
305
+ - 写入开启:`--allow-write` 或 `CODEXMATE_MCP_ALLOW_WRITE=1`
306
+ - 包含域:`tools`、`resources`、`prompts`
307
+
308
+ 示例:
309
+
310
+ ```bash
311
+ codexmate mcp serve --read-only
312
+ codexmate mcp serve --allow-write
313
+ ```
314
+
315
+ ## 配置文件
316
+
317
+ - `~/.codex/config.toml`
318
+ - `~/.codex/auth.json`
319
+ - `~/.codex/models.json`
320
+ - `~/.codex/provider-current-models.json`
321
+ - `~/.claude/settings.json`
322
+ - `~/.claude/CLAUDE.md`
323
+ - `~/.openclaw/openclaw.json`
324
+ - `~/.openclaw/workspace/AGENTS.md`
325
+
326
+ ## 环境变量
327
+
328
+ | 变量 | 默认值 | 说明 |
329
+ | --- | --- | --- |
330
+ | `CODEXMATE_PORT` | `3737` | Web 服务端口 |
331
+ | `CODEXMATE_HOST` | `0.0.0.0` | Web 服务监听地址(如需仅本机访问,显式设为 `127.0.0.1`) |
332
+ | `CODEXMATE_NO_BROWSER` | 未设置 | 设为 `1` 后不自动打开浏览器 |
333
+ | `CODEXMATE_MCP_ALLOW_WRITE` | 未设置 | 设为 `1` 后默认允许 MCP 写工具 |
334
+ | `CODEXMATE_FORCE_RESET_EXISTING_CONFIG` | `0` | 设为 `1` 时首次可强制重建托管配置 |
335
+
336
+ ## 技术栈
337
+
338
+ - Node.js
339
+ - Vue.js 3(Web UI)
340
+ - 原生 HTTP Server
341
+ - `@iarna/toml`、`json5`
342
+
343
+ ## 参与贡献
344
+
345
+ Issue 与 Pull Request 可按需提交。
346
+
347
+ ## License
348
+
349
+ Apache-2.0