zcode-pro 1.3.1__tar.gz → 1.4.0__tar.gz

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 (60) hide show
  1. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/PKG-INFO +58 -31
  2. zcode_pro-1.4.0/README.en.md +202 -0
  3. zcode_pro-1.4.0/README.md +204 -0
  4. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/dist/inject.js +1131 -63
  5. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/package.json +1 -1
  6. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/helper.mjs +485 -57
  7. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/webdav.mjs +19 -11
  8. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/core.js +122 -20
  9. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/settings-dialog.js +380 -44
  10. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/status-bar.js +17 -4
  11. zcode_pro-1.4.0/src/inject/features/theme.js +488 -0
  12. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/index.js +2 -0
  13. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/ui.js +26 -0
  14. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/zcode_pro/__init__.py +1 -1
  15. zcode_pro-1.3.1/README.en.md +0 -175
  16. zcode_pro-1.3.1/README.md +0 -177
  17. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/.gitignore +0 -0
  18. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/LICENSE +0 -0
  19. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/bin/zcode-pro +0 -0
  20. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/bin/zcode-pro.cmd +0 -0
  21. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/bin/zcode-pro.mjs +0 -0
  22. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/bin/zcode-pro.vbs +0 -0
  23. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/cli.mjs +0 -0
  24. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/pyproject.toml +0 -0
  25. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/cdp.mjs +0 -0
  26. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/main.mjs +0 -0
  27. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/paths.mjs +0 -0
  28. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/pickFolder.mjs +0 -0
  29. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/settings.mjs +0 -0
  30. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/setup.mjs +0 -0
  31. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/taskIndex.mjs +0 -0
  32. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/taskOrder.mjs +0 -0
  33. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/host/version.mjs +0 -0
  34. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/alias-migration.js +0 -0
  35. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/alias.js +0 -0
  36. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/copy-path.js +0 -0
  37. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/file-menu.js +0 -0
  38. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/idle-reclaim.js +0 -0
  39. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/image-menu.js +0 -0
  40. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/newtab-panels.js +0 -0
  41. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/open-folder.js +0 -0
  42. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/pinned-collapse.js +0 -0
  43. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/plugin-card-retry.js +0 -0
  44. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/plugin-updates.js +0 -0
  45. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/project-menu.js +0 -0
  46. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/relocate-dialog.js +0 -0
  47. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/sandbox-reclaim.js +0 -0
  48. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/session-switch.js +0 -0
  49. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/settings-entry.js +0 -0
  50. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/styles.js +0 -0
  51. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/task-order.js +0 -0
  52. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/title-gen.js +0 -0
  53. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/title-lock.js +0 -0
  54. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/toolbar-icons.js +0 -0
  55. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/turn-usage.js +0 -0
  56. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/ws-rows.js +0 -0
  57. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/features/ws-running.js +0 -0
  58. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/src/inject/provider-fields.js +0 -0
  59. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/zcode_pro/__main__.py +0 -0
  60. {zcode_pro-1.3.1 → zcode_pro-1.4.0}/zcode_pro/cli.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: zcode-pro
3
- Version: 1.3.1
3
+ Version: 1.4.0
4
4
  Summary: ZCode Pro — ZCode 桌面版界面增强启动器(不修改客户端文件),核心功能:项目自定义别名
5
5
  Project-URL: Homepage, https://github.com/duanluan/zcode-pro
6
6
  Project-URL: Repository, https://github.com/duanluan/zcode-pro
@@ -30,39 +30,66 @@ ZCode 桌面版界面增强工具。不修改客户端文件,通过 ZCode Pro
30
30
 
31
31
  ## ✨ 功能
32
32
 
33
- | 功能 | 说明 |
34
- | --- | --- |
35
- | 项目自定义别名 | 侧边栏显示自定义名称,仅界面显示,随时恢复;ZCode ≥ 3.16.1 已内置改名(项目菜单“编辑项目”),本功能自动停用并引导把已有别名迁移过去 |
36
- | 切换文件夹 | 将项目指向另一个文件夹,侧边栏、标签页与任务历史一并迁移;切换前建议先停止运行中的任务,历史检查点仍引用原路径;ZCode ≥ 3.16.1 官方已支持一个项目挂多个目录,本功能随之停用 |
37
- | 打开文件夹 / 复制路径 | 项目“更多”菜单:在系统文件管理器中打开项目目录,或复制项目路径 |
38
- | 会话拖动排序 | 拖动置顶、项目与分组中的会话调整顺序,刷新后保持 |
39
- | 会话快捷切换 | `alt+z` 在当前与上次会话间来回切换;按住 `alt` 按 `x`(上移)/ `c`(下移)在最近会话列表中选择(初始 10 条,`c` 到底再加载 5 条),`alt+e` 直接打开最近 10 条,`alt+r` 打开正在运行与运行完未查看的任务;方向键同样可选,松开 `alt` 或 `Enter` 切换(类 `alt+tab`);五个入口键可在 设置 → 快捷键 中修改 |
40
- | 重命名会话名锁定 | 手动重命名过的会话不再被自动标题覆盖,侧栏始终显示重命名后的名字 |
41
- | 任务名提示词 | 新会话开始作答时按所选供应商与提示词生成任务名(默认跟随当前会话、glm-5.3-flash,提问阶段的多条消息都计入),生成结果按手动重命名保存,官方自动标题不再覆盖;可在设置中选供应商、模型并编辑提示词,附测试按钮 |
42
- | 折叠时任务运行中提示 | 有会话在运行时,折叠的项目与“任务”“已置顶”等分区头显示与任务运行中同款的加载图标,全部结束后消失 |
43
- | 空闲项目内存回收 | 长时间未使用且无任务运行的项目自动释放其占用的内存,启动后也会自动回收一次未使用的项目;会话记录不受影响,再次打开时自动恢复(时长可调) |
44
- | 插件卡片自动重试 | 名额腾出后自动补挂因 64 上限失败的插件卡片(自动点"重新加载"),无需手动蹲守 |
45
- | 插件界面沙箱回收 | 插件卡片沙箱数量达到上限时释放最早创建的(正在查看的排最后),避免 64 个名额耗尽后新卡片打不开;被释放的旧卡片重新打开所在会话即恢复(上限可调) |
46
- | 侧栏菜单并入顶栏 | “新建任务 / 搜索 / 自动化 / 插件市场”收成顶部导航栏的图标按钮:悬停显示名称,对应界面打开时高亮,快捷键照常可用 |
47
- | 新标签页插件面板入口 | 官方“新标签页”只列官方面板与推荐的官方插件;本功能把第三方市场插件(headroom、rtk 等)的面板卡片加进去,点击在侧边面板打开 |
48
- | 状态栏统计 | 主界面底部右下角显示统计项:上下文占用(占用高时变色)、提问次数、今日/累计 token、任务总数,全部取自官方数据;各项的顺序与显隐在 设置 → 样式 → 状态栏 调整 |
49
- | 每轮回答 token 用量 | 在每条回答末尾操作按钮的时间后面显示该轮的输入/输出 token 与缓存命中率(本地记录只保留最近一段,更早的回答不标注) |
50
- | 已置顶分区可折叠 | 侧边栏“已置顶”标题可点击折叠/展开其任务列表,状态记住 |
51
- | 文件菜单增强 | 会话中文件链接的右键菜单新增“默认应用打开”“打开所在目录” |
52
- | 复制图片 | 右键会话中的图片或放大的预览图,复制到剪贴板 |
53
- | 界面样式调整 | 微调段落间距、内容宽度、各类行高、列表/引用块/表格间距与单元格边距;聚焦输入框时高亮预览受影响区域,即改即生效 |
54
- | 侧栏间距调整 | 微调侧边栏项目间距与任务间距,即改即生效 |
55
- | 字体调整 | 自定义界面字体(除终端外全部界面文字)、提问字体与回答字体,即改即生效 |
56
- | 全局提示词 | 编辑所有项目共享的默认指令,新会话起生效 |
57
- | 软件代理 | 为插件更新安装与本体升级设置 HTTP 代理,附连通性检测 |
58
- | 设置同步 | 手动把 ZCode Pro 设置与模型设置备份到 WebDAV,或在新电脑上恢复;仅在点击时传输 |
59
- | 视觉代理 | 主模型不识图时自动交给视觉模型识别图片,识别描述带给主模型;可视化编辑代理链(zcode-vision 插件) |
60
- | rtk 压缩 | 管理改写提醒与命令白名单,rtk 本体检查更新与一键升级(rtk 插件) |
61
- | Headroom | 管理压缩设备、省电切换与代理运行状态,headroom 本体检查更新与升级(headroom 插件) |
62
- | 插件更新 | 一键检查并更新 zcode-plugins 市场插件,可选启动时自动更新 |
33
+ 按设置弹窗中的位置分组排列:分类列为弹窗标签页,带 `·` 的(如“行为 · 全局提示词”)为标签页内的二级子标签,顺序与下方“设置界面”的截图一致。
34
+
35
+ | 分类 | 功能 | 说明 |
36
+ | --- | --- | --- |
37
+ | 功能 | 项目菜单增强(打开文件夹 / 复制路径) | 项目“更多”菜单:在系统文件管理器中打开项目目录,或复制项目路径 |
38
+ | | ~~项目自定义别名~~(已停用) | 侧边栏显示自定义名称,仅界面显示,随时恢复;ZCode ≥ 3.16.1 已内置改名(项目菜单“编辑项目”),本功能自动停用并引导把已有别名迁移过去 |
39
+ | | ~~切换文件夹~~(已停用) | 将项目指向另一个文件夹,侧边栏、标签页与任务历史一并迁移;切换前建议先停止运行中的任务,历史检查点仍引用原路径;ZCode ≥ 3.16.1 官方已支持一个项目挂多个目录,本功能随之停用 |
40
+ | | 会话拖动排序 | 拖动置顶、项目与分组中的会话调整顺序,刷新后保持 |
41
+ | | 会话快捷切换 | `alt+z` 在当前与上次会话间来回切换;按住 `alt` 按 `x`(上移)/ `c`(下移)在最近会话列表中选择(初始 10 条,`c` 到底再加载 5 条),`alt+e` 直接打开最近 10 条,`alt+r` 打开正在运行与运行完未查看的任务;方向键同样可选,松开 `alt` 或 `Enter` 切换(类 `alt+tab`);五个入口键可在 设置 → 快捷键 中修改 |
42
+ | | 重命名会话名锁定 | 手动重命名过的会话不再被自动标题覆盖,侧栏始终显示重命名后的名字 |
43
+ | | 已置顶分区可折叠 | 侧边栏“已置顶”标题可点击折叠/展开其任务列表,状态记住 |
44
+ | | 文件菜单增强 | 会话中文件链接的右键菜单新增“默认应用打开”“打开所在目录” |
45
+ | | 复制图片 | 右键会话中的图片或放大的预览图,复制到剪贴板 |
46
+ | | 插件界面沙箱回收 | 插件卡片沙箱数量达到上限时释放最早创建的(正在查看的排最后),避免 64 个名额耗尽后新卡片打不开;被释放的旧卡片重新打开所在会话即恢复(上限在配置文件 sandboxReclaimBudget 调整) |
47
+ | | 插件卡片自动重试 | 名额腾出后自动补挂因 64 上限失败的插件卡片(自动点“重新加载”),无需手动蹲守 |
48
+ | | 折叠时任务运行中提示 | 有会话在运行时,折叠的项目与“任务”“已置顶”等分区头显示与任务运行中同款的加载图标,全部结束后消失 |
49
+ | | 新标签页插件面板入口 | 官方“新标签页”只列官方面板与推荐的官方插件;本功能把第三方市场插件(headroom、rtk 等)的面板卡片加进去,点击在侧边面板打开 |
50
+ | | 插件更新 | 一键检查并更新 zcode-plugins 市场插件,可选启动时自动更新 |
51
+ | 快捷键 | 会话快捷键自定义 | 会话快捷切换的五个入口键(默认 `alt+z` / `x` / `c` / `e` / `r`)逐个修改:点“修改”后按下新键位(字母/数字)即生效,键位冲突会提示;可一键重置为默认 |
52
+ | 行为 | 全局提示词 | 编辑所有项目共享的默认指令,新会话起生效 |
53
+ | | 任务名提示词 | 新会话开始作答时按所选供应商与提示词生成任务名(默认跟随当前会话、glm-5.3-flash,提问阶段的多条消息都计入),生成结果按手动重命名保存,官方自动标题不再覆盖;可在设置中选供应商、模型并编辑提示词,附测试按钮 |
54
+ | 外观 · 样式 | 侧栏菜单并入顶栏 | “新建任务 / 搜索 / 自动化 / 插件市场”收成顶部导航栏的图标按钮:悬停显示名称,对应界面打开时高亮,快捷键照常可用 |
55
+ | | 字体调整 | 自定义界面字体(除终端外全部界面文字)、提问字体与回答字体,即改即生效 |
56
+ | | 侧栏间距调整 | 微调侧边栏项目间距与任务间距,即改即生效 |
57
+ | | 界面样式调整 | 微调段落间距、内容宽度、各类行高、列表/引用块/表格间距与单元格边距;聚焦输入框时高亮预览受影响区域,即改即生效 |
58
+ | 外观 · 状态栏 | 状态栏统计 | 提问输入框右下角和每轮回答最后显示统计项:上下文占用(占用高时变色)、提问次数、今日/累计 token、任务总数,全部取自官方数据;各项的顺序与显隐在 设置 → 外观 → 状态栏 调整 |
59
+ | | 每轮回答 token 用量 | 在每条回答末尾操作按钮的时间后面显示该轮的输入/输出 token 与缓存命中率(本地记录只保留最近一段,更早的回答不标注) |
60
+ | 外观 · 主题 | 界面皮肤 | 内置 11 套知名编辑器主题配色(Dracula / Nord / Tokyo Night / Catppuccin / Gruvbox / One Dark / Solarized / Rosé Pine / Everforest / Night Owl / Kanagawa),每套含明、暗两套变体,跟随 ZCode 当前明暗自动切换;另可自定义主题:明暗各五个锚点色派生整套配色,改色实时生效 |
61
+ | 外观 · 背景图 | 背景图 | 整窗铺背景,四种来源:无背景 / 本地图库(可传多张、点选当前、可单删)/ 文件夹(原地读取,按间隔定时轮换,可选随机或按文件名顺序)/ 网址(可按间隔定时刷新,配合随机图 API);可见度单滑杆调节;侧栏 / 会话流 / 输入框透出背景,弹窗与菜单保持不透明保可读;图库随 WebDAV 同步的 zcode-pro 组一起上传(覆盖式,不留历史版本) |
62
+ | 性能 | 空闲项目内存回收 | 长时间未使用且无任务运行的项目自动释放其占用的内存,启动后也会自动回收一次未使用的项目;会话记录不受影响,再次打开时自动恢复(时长可调) |
63
+ | 代理 | 软件代理 | 为插件更新安装与本体升级设置 HTTP 代理,附连通性检测 |
64
+ | 同步 | 设置同步 | 手动把 ZCode Pro 设置与模型设置备份到 WebDAV,或在新电脑上恢复;仅在点击时传输 |
65
+ | Vision | 视觉代理 | 主模型不识图时自动交给视觉模型识别图片,识别描述带给主模型;可视化编辑代理链(zcode-vision 插件) |
66
+ | Headroom | Headroom 压缩 | 管理压缩设备、省电切换与代理运行状态,headroom 本体检查更新与升级(headroom 插件) |
67
+ | rtk | rtk 压缩 | 管理改写提醒与命令白名单,rtk 本体检查更新与一键升级(rtk 插件) |
63
68
 
64
69
  各项功能均可在设置弹窗中开关或调整,ZCode 3.16.1 与 3.15.x 均可使用。
65
70
 
71
+ ## 🎛 设置界面
72
+
73
+ 右键点击 ZCode 侧边栏底部的设置按钮(齿轮)即可打开设置窗口,各标签页如下:
74
+
75
+ | 功能 | 快捷键 | 行为 · 全局提示词 |
76
+ | --- | --- | --- |
77
+ | <img src="docs/settings/01-features.png" width="280"> | <img src="docs/settings/02-shortcuts.png" width="280"> | <img src="docs/settings/03-behavior-global-prompt.png" width="280"> |
78
+
79
+ | 行为 · 任务名提示词 | 外观 · 样式 | 外观 · 状态栏 |
80
+ | --- | --- | --- |
81
+ | <img src="docs/settings/04-behavior-task-title.png" width="280"> | <img src="docs/settings/05-style-tweaks.png" width="280"> | <img src="docs/settings/06-style-status-bar.png" width="280"> |
82
+
83
+ | 性能 | 代理 | 同步 |
84
+ | --- | --- | --- |
85
+ | <img src="docs/settings/07-performance.png" width="280"> | <img src="docs/settings/08-proxy.png" width="280"> | <img src="docs/settings/09-sync.png" width="280"> |
86
+
87
+ | Vision | Headroom | rtk |
88
+ | --- | --- | --- |
89
+ | <img src="docs/settings/10-vision.png" width="280"> | <img src="docs/settings/11-headroom.png" width="280"> | <img src="docs/settings/12-rtk.png" width="280"> |
90
+
91
+ > 后三个标签页(Vision / Headroom / rtk)来自同名插件,未安装时显示一键安装卡,装好后恢复完整设置。
92
+
66
93
  ## 📦 安装与使用
67
94
 
68
95
  > **版本匹配**:ZCode ≥ 3.16.1 请使用 **zcode-pro 1.1.0**(npm / PyPI / AUR 最新发布版);ZCode ≤ 3.15.x 请使用 **zcode-pro 0.20.3**(旧版仍可用)。
@@ -0,0 +1,202 @@
1
+ # ZCode Pro
2
+
3
+ [简体中文](README.md) | English
4
+
5
+ ZCode Pro enhances the ZCode desktop UI. No client files are modified; just launch via the ZCode Pro shortcut or the `zcode-pro` terminal command.
6
+
7
+ [![npm](https://img.shields.io/npm/v/zcode-pro?logo=npm&logoColor=white)](https://www.npmjs.com/package/zcode-pro) [![PyPI](https://img.shields.io/pypi/v/zcode-pro?logo=pypi&logoColor=white)](https://pypi.org/project/zcode-pro/) [![AUR](https://img.shields.io/aur/version/zcode-pro?logo=archlinux&logoColor=white)](https://aur.archlinux.org/packages/zcode-pro) [![Windows](https://img.shields.io/badge/-Windows-0078D6?logo=data:image/svg%2Bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZmZmZiIgZD0iTTAsMEgxMS4zNzdWMTEuMzcySDBaTTEyLjYyMywwSDI0VjExLjM3MkgxMi42MjNaTTAsMTIuNjIzSDExLjM3N1YyNEgwWm0xMi42MjMsMEgyNFYyNEgxMi42MjMiLz48L3N2Zz4%3D)](https://github.com/duanluan/zcode-pro#-windows) [![macOS](https://img.shields.io/badge/-macOS-000000?logo=apple&logoColor=white)](https://github.com/duanluan/zcode-pro#-linux--macos) [![Linux](https://img.shields.io/badge/-Linux-FCC624?logo=linux&logoColor=black)](https://github.com/duanluan/zcode-pro#-linux--macos) [![QQ](https://img.shields.io/badge/QQ-428403354-12B7F5?logo=qq&logoColor=white)](https://github.com/duanluan/zcode-pro#-community) [![WeChat](https://img.shields.io/badge/WeChat-ai4only-07C160?logo=wechat&logoColor=white)](https://github.com/duanluan/zcode-pro#-community)
8
+
9
+ > **Opening settings: after launching ZCode Pro, right-click the settings button (gear) at the bottom of the ZCode sidebar to open the ZCode Pro settings window.**
10
+
11
+ ## ✨ Features
12
+
13
+ Grouped by where each feature lives in the settings window: the category column is the tab, entries with `·` (e.g. "Behavior · Global prompt") are sub-tabs, in the same order as the screenshots in the Settings section below.
14
+
15
+ | Category | Feature | Description |
16
+ | --- | --- | --- |
17
+ | Features | Project menu actions (open folder / copy path) | Project "More" menu: open the project directory in the file manager, or copy its path |
18
+ | | ~~Custom project alias~~ (retired) | Show a custom name for a project in the sidebar; UI-only, revert anytime; renaming is built into ZCode ≥ 3.16.1 (project menu "Edit project") — the feature disables itself there and offers to migrate existing aliases |
19
+ | | ~~Switch project folder~~ (retired) | Point a project at another folder; sidebar, tabs and task history follow. Stop running tasks before switching; historical checkpoints still reference the original path; retired on ZCode ≥ 3.16.1, where a project can hold multiple directories natively |
20
+ | | Session drag ordering | Reorder sessions in Pinned, Projects and Groups; persists across refreshes |
21
+ | | Session quick switch | `alt+z` toggles between the current and the last session; hold `alt` and press `x` (up) / `c` (down) to pick from recent sessions (10 shown initially, pressing `c` at the bottom loads 5 more), `alt+e` opens the last 10 directly, `alt+r` opens running / finished-but-unseen tasks; arrow keys also move the highlight, release `alt` or press `Enter` to switch (like `alt+tab`); the five trigger keys are customizable in Settings → Shortcuts |
22
+ | | Keep renamed session titles | Sessions you renamed keep their custom title; auto-generated titles no longer overwrite it in the sidebar |
23
+ | | Collapsible Pinned section | The sidebar "Pinned" header collapses/expands its task list; the state is remembered |
24
+ | | File menu actions | Adds "Open with default app" and "Reveal in file manager" to file links in chat |
25
+ | | Copy image | Right-click an image in chat or the enlarged preview to copy it to the clipboard |
26
+ | | Plugin card sandbox reclaim | Releases the oldest plugin-card sandboxes once the cap is hit (the one being viewed goes last), so new cards keep opening after the 64-slot pool fills up; released cards come back when their session is reopened (cap adjustable via the sandboxReclaimBudget config file key) |
27
+ | | Plugin card auto-retry | Auto-clicks "Reload" on cards that failed the 64-slot cap, so they recover as soon as a slot frees up |
28
+ | | Running indicator while collapsed | While any session is running, collapsed projects and the "Tasks" / "Pinned" section headers show the same loader the running task row uses; it disappears when all finish |
29
+ | | Plugin panels on the new tab page | The built-in "new tab page" only lists built-in panels and recommended official plugins; this adds cards for third-party marketplace plugin panels (headroom, rtk, …) that open in the side pane |
30
+ | | Plugin updates | Check and update zcode-plugins marketplace plugins in one click, optional auto-update on startup |
31
+ | Shortcuts | Shortcut customization | Rebind the five session quick switch trigger keys (`alt+z` / `x` / `c` / `e` / `r` by default) one by one: click "Modify" and press a new key (letters/digits only, conflicts rejected); reset all to defaults in one click |
32
+ | Behavior · Global prompt | Global prompt | Edit default instructions shared by all projects; applies to new sessions |
33
+ | Behavior · Task title prompt | Task name prompt | When a new session starts answering, generates the task name with a provider and prompt you choose (following the current session and glm-5.3-flash by default; every question sent before the first answer counts), saved as a manual rename the built-in auto title never overrides; provider, model and prompt are editable in settings, with a test button |
34
+ | Appearance · Styles | Sidebar menu in the top bar | Turns "New task / Search / Automations / Plugin store" into icon buttons in the top navigation bar: hover shows the name, highlighted while its view is open, shortcuts still work |
35
+ | | Font adjustment | Custom UI font (all interface text except the terminal), question font and answer font; applies instantly |
36
+ | | Sidebar spacing | Fine-tune sidebar project spacing and task spacing; applies instantly |
37
+ | | UI style adjustments | Fine-tune paragraph spacing, content width, line heights, list/quote/table spacing and cell padding; focusing an input highlights the affected areas; applies instantly |
38
+ | Appearance · Status bar | Status bar statistics | Shows statistics at the bottom-right of the input box and at the end of each answer: context usage (color-shifts when high), questions asked, today/total tokens and task count, all from official data; reorder or hide each item under Settings → Appearance → Status bar |
39
+ | | Per-turn token usage | Shows that turn's in/out tokens and cache hit rate after the time in each answer's action row (local records keep only a recent window; older answers stay unlabelled) |
40
+ | Appearance · Theme | UI skins | Eleven famous editor theme palettes (Dracula / Nord / Tokyo Night / Catppuccin / Gruvbox / One Dark / Solarized / Rosé Pine / Everforest / Night Owl / Kanagawa), each with light and dark variants that follow ZCode's current mode automatically; plus a custom theme: five anchor colors per mode derive the whole palette, applying live |
41
+ | Appearance · Background | Background image | Window-wide background from four sources: none / local library (upload many, pick the active one, delete freely) / folder (read in place, rotate on a timer, random or by filename) / URL (refresh on a timer for random-image APIs); single visibility slider; sidebar, chat and composer reveal the background while menus and dialogs stay opaque; the library uploads with the zcode-pro WebDAV sync group (overwrite, no history versions) |
42
+ | Performance | Idle project memory reclaim | Projects unused for a while with no running tasks release their memory automatically, and unused ones are reclaimed once after startup; sessions are untouched and reload when reopened (durations adjustable) |
43
+ | Proxy | Software proxy | Set an HTTP proxy for plugin updates/installs and tool upgrades, with connectivity test |
44
+ | Sync | Settings sync | Manually back up ZCode Pro settings and model settings to WebDAV, or restore them on a new computer; transfers only on click |
45
+ | Vision | Vision proxy | Automatically hand images to vision models for recognition when the main model cannot see them, and feed the descriptions to the main model; visual chain editor (zcode-vision plugin) |
46
+ | Headroom | Headroom | Manage compression device, power-save switching and proxy status; check and upgrade the headroom program (headroom plugin) |
47
+ | rtk | rtk compression | Manage rewrite hints and the command whitelist; check and upgrade the rtk program (rtk plugin) |
48
+
49
+ All features can be toggled or adjusted in the settings window; works on both ZCode 3.16.1 and 3.15.x.
50
+
51
+ ## 🎛 Settings
52
+
53
+ Right-click the settings button (gear) at the bottom of the ZCode sidebar to open the settings window:
54
+
55
+ | Features | Shortcuts | Behavior · Global prompt |
56
+ | --- | --- | --- |
57
+ | <img src="docs/settings/01-features.png" width="280"> | <img src="docs/settings/02-shortcuts.png" width="280"> | <img src="docs/settings/03-behavior-global-prompt.png" width="280"> |
58
+
59
+ | Behavior · Task title prompt | Appearance · Styles | Appearance · Status bar |
60
+ | --- | --- | --- |
61
+ | <img src="docs/settings/04-behavior-task-title.png" width="280"> | <img src="docs/settings/05-style-tweaks.png" width="280"> | <img src="docs/settings/06-style-status-bar.png" width="280"> |
62
+
63
+ | Performance | Proxy | Sync |
64
+ | --- | --- | --- |
65
+ | <img src="docs/settings/07-performance.png" width="280"> | <img src="docs/settings/08-proxy.png" width="280"> | <img src="docs/settings/09-sync.png" width="280"> |
66
+
67
+ | Vision | Headroom | rtk |
68
+ | --- | --- | --- |
69
+ | <img src="docs/settings/10-vision.png" width="280"> | <img src="docs/settings/11-headroom.png" width="280"> | <img src="docs/settings/12-rtk.png" width="280"> |
70
+
71
+ > The last three tabs (Vision / Headroom / rtk) come from the plugins of the same name; when a plugin is missing, the tab shows a one-click install card and switches to the full panel once installed.
72
+
73
+ ## 📦 Installation
74
+
75
+ > **Version match**: for ZCode ≥ 3.16.1 use **zcode-pro 1.1.0** (latest npm / PyPI / AUR release); for ZCode ≤ 3.15.x use **zcode-pro 0.20.3** (the previous release, still available).
76
+
77
+ Once installed, launch ZCode via the "ZCode Pro" shortcut in your app menu / Start menu, or the `zcode-pro` command in a terminal — the enhancements are enabled automatically in this mode; launching ZCode through its original entry does not load them. After launching, right-click the settings button at the bottom of the ZCode sidebar to open the ZCode Pro settings window.
78
+
79
+ ### 📦 npm / PyPI
80
+
81
+ At runtime the Node runtime bundled with ZCode is preferred; if ZCode cannot be found, system Node.js (≥ 22) is used.
82
+
83
+ ```bash
84
+ # Option 1: install/uninstall via npm
85
+ npm install -g zcode-pro
86
+ npm uninstall -g zcode-pro
87
+ # Option 2: install/uninstall via pip
88
+ pip install zcode-pro
89
+ pip uninstall zcode-pro
90
+
91
+ # Launch via the command
92
+ zcode-pro
93
+ # Add a Start-menu shortcut
94
+ zcode-pro setup
95
+ # Add a Start-menu shortcut + a desktop shortcut
96
+ zcode-pro setup --desktop
97
+ # Undo the shortcuts
98
+ zcode-pro setup --uninstall
99
+ ```
100
+
101
+ ### 🐧 Linux / macOS
102
+
103
+ ```bash
104
+ git clone https://github.com/duanluan/zcode-pro.git
105
+ cd zcode-pro && ./scripts/install.sh
106
+ ```
107
+
108
+ - Installs to `~/.local`; use `PREFIX=` to choose another location;
109
+ - On Linux, registers an app-menu shortcut "ZCode Pro" (icon reused from the installed ZCode);
110
+ - Do not use this script while the AUR package is installed (the script detects this and refuses): the user-level install would shadow the system-wide one;
111
+ - Uninstall: `./scripts/install.sh --uninstall`.
112
+
113
+ ### 🪟 Windows
114
+
115
+ Run with **PowerShell (Admin)**:
116
+ ```powershell
117
+ git clone https://github.com/duanluan/zcode-pro.git
118
+ cd zcode-pro
119
+
120
+ # Add a Start-menu shortcut
121
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1
122
+ # Add a Start-menu shortcut + a desktop shortcut
123
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Desktop
124
+ # ZCode in a non-default directory that auto-detection misses? Pass its path (persisted, removed on uninstall)
125
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Desktop -ZCodePath "D:\ProgramFiles\Zcode\ZCode.exe"
126
+
127
+ # Uninstall
128
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Uninstall
129
+ ```
130
+
131
+ ### 📦 AUR (Arch / Manjaro)
132
+
133
+ Installs `/usr/bin/zcode-pro` and a system-level app-menu shortcut. Depends on the [zcode](https://aur.archlinux.org/packages/zcode) package from the AUR.
134
+
135
+ ```bash
136
+ yay -S zcode-pro
137
+ paru -S zcode-pro
138
+ # Manual installation
139
+ git clone https://aur.archlinux.org/zcode-pro.git && cd zcode-pro && makepkg -si
140
+ ```
141
+
142
+ If you previously installed via `install.sh`, run `./scripts/install.sh --uninstall` in that repository clone before switching to the AUR package. Leftover user-level files would keep shadowing the system-wide entry, and you would keep launching the old version.
143
+
144
+ ### 🚀 Run without installing
145
+
146
+ No standalone Node.js required: the runtime bundled with ZCode is preferred and used even without a system Node; works whether ZCode is installed in the default or a custom directory (auto-detected, falling back to the registry).
147
+
148
+ ```bash
149
+ git clone https://github.com/duanluan/zcode-pro.git && cd zcode-pro
150
+
151
+ # Linux / macOS (auto-detects /opt/ZCode, /Applications/ZCode.app)
152
+ ./bin/zcode-pro
153
+ # Windows (auto-detects default locations, falls back to the registry)
154
+ bin\zcode-pro.cmd
155
+
156
+ # Manually add a Start-menu shortcut (--desktop also adds a desktop shortcut, --uninstall undoes)
157
+ ./bin/zcode-pro setup
158
+ bin\zcode-pro.cmd setup
159
+ ```
160
+
161
+ ## 📖 Reference
162
+
163
+ Command-line options (see `zcode-pro --help` for all):
164
+
165
+ | Option | Description |
166
+ | --- | --- |
167
+ | `--cdp-port` | Debug port, default 9333 |
168
+ | `--helper-port` | Local helper port, default 47889 |
169
+ | `--zcode-path` | Explicit path to the ZCode executable |
170
+ | `--inject-only` | Attach to a running instance only; do not launch a new one |
171
+ | `--verbose` | Verbose logging |
172
+ | `setup [--desktop] [--uninstall]` | Install/undo local shortcuts (`--desktop` also adds a desktop one) |
173
+
174
+ Each option can also be overridden with a `ZCODEPRO_*` environment variable.
175
+
176
+ Configuration and data locations:
177
+
178
+ | Content | Location |
179
+ | --- | --- |
180
+ | Feature switches, aliases, software proxy | `~/.zcode/zcodepro.json` |
181
+ | Startup diagnostics log (silent shortcut launches, Windows) | `~/.zcode/zcodepro.log` |
182
+ | Global prompt | `~/.zcode/AGENTS.md` |
183
+ | Vision proxy (zcode-vision plugin) | `~/.zcode/zcode-vision.json` |
184
+ | rtk compression (rtk plugin) | `~/.zcode-rtk/` |
185
+ | Headroom (headroom plugin) | `~/.zcode/headroom.json` |
186
+
187
+ After uninstalling, just start ZCode from the official entry; no system cleanup is needed.
188
+
189
+ ## 🔌 Plugin recommendation
190
+
191
+ [duanluan/zcode-plugins](https://github.com/duanluan/zcode-plugins) is a companion plugin marketplace for ZCode: AI code review, request compression and command-output compression plugins that save tokens. To install: ZCode → Plugin Marketplace → "Add" (top right) → Add plugin marketplace, and enter `duanluan/zcode-plugins`. Installed plugins can be checked and updated from ZCode Pro settings.
192
+
193
+ ## 💬 Community
194
+
195
+ - QQ group: **428403354** ([join](https://qm.qq.com/q/WXuISJK3ug))
196
+ - WeChat group: add **ai4only** on WeChat to be invited
197
+
198
+ <p>
199
+ <img src="https://raw.githubusercontent.com/duanluan/zcode-pro/main/assets/qq-group.png" width="200" alt="QQ group QR code" />
200
+ &nbsp;&nbsp;
201
+ <img src="https://raw.githubusercontent.com/duanluan/zcode-pro/main/assets/wechat-ai4only.png" width="200" alt="WeChat QR code (ai4only)" />
202
+ </p>
@@ -0,0 +1,204 @@
1
+ # ZCode Pro
2
+
3
+ [English](README.en.md) | 简体中文
4
+
5
+ ZCode 桌面版界面增强工具。不修改客户端文件,通过 ZCode Pro 快捷方式或终端命令 `zcode-pro` 启动即可。
6
+
7
+ [![npm](https://img.shields.io/npm/v/zcode-pro?logo=npm&logoColor=white)](https://www.npmjs.com/package/zcode-pro) [![PyPI](https://img.shields.io/pypi/v/zcode-pro?logo=pypi&logoColor=white)](https://pypi.org/project/zcode-pro/) [![AUR 版本](https://img.shields.io/aur/version/zcode-pro?logo=archlinux&logoColor=white)](https://aur.archlinux.org/packages/zcode-pro) [![Windows](https://img.shields.io/badge/-Windows-0078D6?logo=data:image/svg%2Bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZmlsbD0iI2ZmZmZmZiIgZD0iTTAsMEgxMS4zNzdWMTEuMzcySDBaTTEyLjYyMywwSDI0VjExLjM3MkgxMi42MjNaTTAsMTIuNjIzSDExLjM3N1YyNEgwWm0xMi42MjMsMEgyNFYyNEgxMi42MjMiLz48L3N2Zz4%3D)](https://github.com/duanluan/zcode-pro#-windows) [![macOS](https://img.shields.io/badge/-macOS-000000?logo=apple&logoColor=white)](https://github.com/duanluan/zcode-pro#-linux--macos) [![Linux](https://img.shields.io/badge/-Linux-FCC624?logo=linux&logoColor=black)](https://github.com/duanluan/zcode-pro#-linux--macos) [![QQ 群](https://img.shields.io/badge/QQ-428403354-12B7F5?logo=qq&logoColor=white)](https://github.com/duanluan/zcode-pro#-交流与反馈) [![微信](https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1-ai4only-07C160?logo=wechat&logoColor=white)](https://github.com/duanluan/zcode-pro#-交流与反馈)
8
+
9
+ > ⚙️ **打开设置:启动 ZCode Pro 后,右键点击 ZCode 侧边栏底部的设置按钮(齿轮)即可打开 ZCode Pro 设置窗口。**
10
+
11
+ ## ✨ 功能
12
+
13
+ 按设置弹窗中的位置分组排列:分类列为弹窗标签页,带 `·` 的(如“行为 · 全局提示词”)为标签页内的二级子标签,顺序与下方“设置界面”的截图一致。
14
+
15
+ | 分类 | 功能 | 说明 |
16
+ | --- | --- | --- |
17
+ | 功能 | 项目菜单增强(打开文件夹 / 复制路径) | 项目“更多”菜单:在系统文件管理器中打开项目目录,或复制项目路径 |
18
+ | | ~~项目自定义别名~~(已停用) | 侧边栏显示自定义名称,仅界面显示,随时恢复;ZCode ≥ 3.16.1 已内置改名(项目菜单“编辑项目”),本功能自动停用并引导把已有别名迁移过去 |
19
+ | | ~~切换文件夹~~(已停用) | 将项目指向另一个文件夹,侧边栏、标签页与任务历史一并迁移;切换前建议先停止运行中的任务,历史检查点仍引用原路径;ZCode ≥ 3.16.1 官方已支持一个项目挂多个目录,本功能随之停用 |
20
+ | | 会话拖动排序 | 拖动置顶、项目与分组中的会话调整顺序,刷新后保持 |
21
+ | | 会话快捷切换 | `alt+z` 在当前与上次会话间来回切换;按住 `alt` 按 `x`(上移)/ `c`(下移)在最近会话列表中选择(初始 10 条,`c` 到底再加载 5 条),`alt+e` 直接打开最近 10 条,`alt+r` 打开正在运行与运行完未查看的任务;方向键同样可选,松开 `alt` 或 `Enter` 切换(类 `alt+tab`);五个入口键可在 设置 → 快捷键 中修改 |
22
+ | | 重命名会话名锁定 | 手动重命名过的会话不再被自动标题覆盖,侧栏始终显示重命名后的名字 |
23
+ | | 已置顶分区可折叠 | 侧边栏“已置顶”标题可点击折叠/展开其任务列表,状态记住 |
24
+ | | 文件菜单增强 | 会话中文件链接的右键菜单新增“默认应用打开”“打开所在目录” |
25
+ | | 复制图片 | 右键会话中的图片或放大的预览图,复制到剪贴板 |
26
+ | | 插件界面沙箱回收 | 插件卡片沙箱数量达到上限时释放最早创建的(正在查看的排最后),避免 64 个名额耗尽后新卡片打不开;被释放的旧卡片重新打开所在会话即恢复(上限在配置文件 sandboxReclaimBudget 调整) |
27
+ | | 插件卡片自动重试 | 名额腾出后自动补挂因 64 上限失败的插件卡片(自动点“重新加载”),无需手动蹲守 |
28
+ | | 折叠时任务运行中提示 | 有会话在运行时,折叠的项目与“任务”“已置顶”等分区头显示与任务运行中同款的加载图标,全部结束后消失 |
29
+ | | 新标签页插件面板入口 | 官方“新标签页”只列官方面板与推荐的官方插件;本功能把第三方市场插件(headroom、rtk 等)的面板卡片加进去,点击在侧边面板打开 |
30
+ | | 插件更新 | 一键检查并更新 zcode-plugins 市场插件,可选启动时自动更新 |
31
+ | 快捷键 | 会话快捷键自定义 | 会话快捷切换的五个入口键(默认 `alt+z` / `x` / `c` / `e` / `r`)逐个修改:点“修改”后按下新键位(字母/数字)即生效,键位冲突会提示;可一键重置为默认 |
32
+ | 行为 | 全局提示词 | 编辑所有项目共享的默认指令,新会话起生效 |
33
+ | | 任务名提示词 | 新会话开始作答时按所选供应商与提示词生成任务名(默认跟随当前会话、glm-5.3-flash,提问阶段的多条消息都计入),生成结果按手动重命名保存,官方自动标题不再覆盖;可在设置中选供应商、模型并编辑提示词,附测试按钮 |
34
+ | 外观 · 样式 | 侧栏菜单并入顶栏 | “新建任务 / 搜索 / 自动化 / 插件市场”收成顶部导航栏的图标按钮:悬停显示名称,对应界面打开时高亮,快捷键照常可用 |
35
+ | | 字体调整 | 自定义界面字体(除终端外全部界面文字)、提问字体与回答字体,即改即生效 |
36
+ | | 侧栏间距调整 | 微调侧边栏项目间距与任务间距,即改即生效 |
37
+ | | 界面样式调整 | 微调段落间距、内容宽度、各类行高、列表/引用块/表格间距与单元格边距;聚焦输入框时高亮预览受影响区域,即改即生效 |
38
+ | 外观 · 状态栏 | 状态栏统计 | 提问输入框右下角和每轮回答最后显示统计项:上下文占用(占用高时变色)、提问次数、今日/累计 token、任务总数,全部取自官方数据;各项的顺序与显隐在 设置 → 外观 → 状态栏 调整 |
39
+ | | 每轮回答 token 用量 | 在每条回答末尾操作按钮的时间后面显示该轮的输入/输出 token 与缓存命中率(本地记录只保留最近一段,更早的回答不标注) |
40
+ | 外观 · 主题 | 界面皮肤 | 内置 11 套知名编辑器主题配色(Dracula / Nord / Tokyo Night / Catppuccin / Gruvbox / One Dark / Solarized / Rosé Pine / Everforest / Night Owl / Kanagawa),每套含明、暗两套变体,跟随 ZCode 当前明暗自动切换;另可自定义主题:明暗各五个锚点色派生整套配色,改色实时生效 |
41
+ | 外观 · 背景图 | 背景图 | 整窗铺背景,四种来源:无背景 / 本地图库(可传多张、点选当前、可单删)/ 文件夹(原地读取,按间隔定时轮换,可选随机或按文件名顺序)/ 网址(可按间隔定时刷新,配合随机图 API);可见度单滑杆调节;侧栏 / 会话流 / 输入框透出背景,弹窗与菜单保持不透明保可读;图库随 WebDAV 同步的 zcode-pro 组一起上传(覆盖式,不留历史版本) |
42
+ | 性能 | 空闲项目内存回收 | 长时间未使用且无任务运行的项目自动释放其占用的内存,启动后也会自动回收一次未使用的项目;会话记录不受影响,再次打开时自动恢复(时长可调) |
43
+ | 代理 | 软件代理 | 为插件更新安装与本体升级设置 HTTP 代理,附连通性检测 |
44
+ | 同步 | 设置同步 | 手动把 ZCode Pro 设置与模型设置备份到 WebDAV,或在新电脑上恢复;仅在点击时传输 |
45
+ | Vision | 视觉代理 | 主模型不识图时自动交给视觉模型识别图片,识别描述带给主模型;可视化编辑代理链(zcode-vision 插件) |
46
+ | Headroom | Headroom 压缩 | 管理压缩设备、省电切换与代理运行状态,headroom 本体检查更新与升级(headroom 插件) |
47
+ | rtk | rtk 压缩 | 管理改写提醒与命令白名单,rtk 本体检查更新与一键升级(rtk 插件) |
48
+
49
+ 各项功能均可在设置弹窗中开关或调整,ZCode 3.16.1 与 3.15.x 均可使用。
50
+
51
+ ## 🎛 设置界面
52
+
53
+ 右键点击 ZCode 侧边栏底部的设置按钮(齿轮)即可打开设置窗口,各标签页如下:
54
+
55
+ | 功能 | 快捷键 | 行为 · 全局提示词 |
56
+ | --- | --- | --- |
57
+ | <img src="docs/settings/01-features.png" width="280"> | <img src="docs/settings/02-shortcuts.png" width="280"> | <img src="docs/settings/03-behavior-global-prompt.png" width="280"> |
58
+
59
+ | 行为 · 任务名提示词 | 外观 · 样式 | 外观 · 状态栏 |
60
+ | --- | --- | --- |
61
+ | <img src="docs/settings/04-behavior-task-title.png" width="280"> | <img src="docs/settings/05-style-tweaks.png" width="280"> | <img src="docs/settings/06-style-status-bar.png" width="280"> |
62
+
63
+ | 性能 | 代理 | 同步 |
64
+ | --- | --- | --- |
65
+ | <img src="docs/settings/07-performance.png" width="280"> | <img src="docs/settings/08-proxy.png" width="280"> | <img src="docs/settings/09-sync.png" width="280"> |
66
+
67
+ | Vision | Headroom | rtk |
68
+ | --- | --- | --- |
69
+ | <img src="docs/settings/10-vision.png" width="280"> | <img src="docs/settings/11-headroom.png" width="280"> | <img src="docs/settings/12-rtk.png" width="280"> |
70
+
71
+ > 后三个标签页(Vision / Headroom / rtk)来自同名插件,未安装时显示一键安装卡,装好后恢复完整设置。
72
+
73
+ ## 📦 安装与使用
74
+
75
+ > **版本匹配**:ZCode ≥ 3.16.1 请使用 **zcode-pro 1.1.0**(npm / PyPI / AUR 最新发布版);ZCode ≤ 3.15.x 请使用 **zcode-pro 0.20.3**(旧版仍可用)。
76
+
77
+ 安装后,通过应用菜单 / 开始菜单中的“ZCode Pro”快捷方式或终端命令 `zcode-pro` 启动 ZCode,增强在该方式下自动生效;使用原有 ZCode 入口启动时不加载增强。
78
+
79
+ ### 📦 npm / PyPI
80
+
81
+ 运行时优先复用 ZCode 自带的运行时;未找到 ZCode 时回退系统 Node.js(≥ 22)。
82
+
83
+ ```bash
84
+ # 方式一:npm 安装/卸载
85
+ npm install -g zcode-pro
86
+ zcode-pro setup --uninstall # 卸载前先撤销快捷方式(如创建过)
87
+ npm uninstall -g zcode-pro
88
+ # 方式二:pip 安装/卸载
89
+ pip install zcode-pro
90
+ zcode-pro setup --uninstall # 卸载前先撤销快捷方式(如创建过)
91
+ pip uninstall zcode-pro
92
+
93
+ # 通过命令启动
94
+ zcode-pro
95
+ # 添加开始菜单快捷方式
96
+ zcode-pro setup
97
+ # 添加开始菜单快捷方式 + 桌面快捷方式
98
+ zcode-pro setup --desktop
99
+ # 撤销添加快捷方式
100
+ zcode-pro setup --uninstall
101
+ ```
102
+
103
+ ### 🐧 Linux / macOS
104
+
105
+ - 安装至 `~/.local`,可通过 `PREFIX=` 指定其他位置;
106
+ - Linux 会注册应用菜单快捷方式“ZCode Pro”(图标复用已安装的 ZCode);
107
+ - 已通过 AUR 安装时请勿再使用本脚本(脚本会检测并拒绝),用户级安装会遮蔽系统级入口;
108
+ - 卸载:`./scripts/install.sh --uninstall`。
109
+
110
+ ```bash
111
+ git clone https://github.com/duanluan/zcode-pro.git
112
+ cd zcode-pro && ./scripts/install.sh
113
+ ```
114
+
115
+ ### 🪟 Windows
116
+
117
+ 使用 **PowerShell (管理员)** 运行:
118
+ ```powershell
119
+ git clone https://github.com/duanluan/zcode-pro.git
120
+ cd zcode-pro
121
+
122
+ # 添加开始菜单快捷方式
123
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1
124
+ # 添加开始菜单快捷方式 + 桌面快捷方式
125
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Desktop
126
+ # ZCode 装在非默认目录且自动定位不到时,显式指定其路径(持久保存,卸载时清除)
127
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Desktop -ZCodePath "D:\ProgramFiles\Zcode\ZCode.exe"
128
+
129
+ # 卸载
130
+ powershell -ExecutionPolicy Bypass -File scripts\install.ps1 -Uninstall
131
+ ```
132
+
133
+ ### 📦 AUR
134
+
135
+ 安装 `/usr/bin/zcode-pro` 与系统级应用菜单快捷方式,依赖 AUR 的 [zcode](https://aur.archlinux.org/packages/zcode) 包。
136
+
137
+ ```bash
138
+ yay -S zcode-pro
139
+ paru -S zcode-pro
140
+ # 手动安装方式
141
+ git clone https://aur.archlinux.org/zcode-pro.git && cd zcode-pro && makepkg -si
142
+ ```
143
+
144
+ 从手动安装(`install.sh`)迁移到 AUR 前,请先在原仓库执行 `./scripts/install.sh --uninstall` 清理 `~/.local` 下的旧文件,再安装本包;否则旧的用户级快捷方式会一直遮蔽系统级入口,实际运行的仍是旧版本。
145
+
146
+ ### 🚀 手动运行(不安装)
147
+
148
+ 无需单独安装 Node.js:优先使用 ZCode 内置运行时,缺少系统 Node 时亦能运行;ZCode 安装在默认或自定义目录均可(自动探测,必要时查注册表)。
149
+
150
+ ```bash
151
+ git clone https://github.com/duanluan/zcode-pro.git && cd zcode-pro
152
+
153
+ # Linux / macOS(自动探测 /opt/ZCode、/Applications/ZCode.app)
154
+ ./bin/zcode-pro
155
+ # Windows(自动探测默认安装位置,找不到时查注册表)
156
+ bin\zcode-pro.cmd
157
+
158
+ # 手动添加开始菜单快捷方式(--desktop 同时添加桌面快捷方式,--uninstall 撤销添加快捷方式)
159
+ ./bin/zcode-pro setup
160
+ bin\zcode-pro.cmd setup
161
+ ```
162
+
163
+ ## 📖 参考
164
+
165
+ 命令行选项(`zcode-pro --help` 查看全部):
166
+
167
+ | 选项 | 说明 |
168
+ | --- | --- |
169
+ | `--cdp-port` | 调试端口,默认 9333 |
170
+ | `--helper-port` | 本地辅助服务端口,默认 47889 |
171
+ | `--zcode-path` | 显式指定 ZCode 可执行文件 |
172
+ | `--inject-only` | 只接管已在运行的实例,不启动新实例 |
173
+ | `--verbose` | 详细日志 |
174
+ | `setup [--desktop] [--uninstall]` | 安装/撤销本机快捷方式(`--desktop` 同时加桌面) |
175
+
176
+ 各选项也可用环境变量 `ZCODEPRO_*` 覆盖。
177
+
178
+ 配置与数据位置:
179
+
180
+ | 内容 | 位置 |
181
+ | --- | --- |
182
+ | 功能开关、项目别名、软件代理 | `~/.zcode/zcodepro.json` |
183
+ | 启动诊断日志(Windows 快捷方式静默启动排查) | `~/.zcode/zcodepro.log` |
184
+ | 全局提示词 | `~/.zcode/AGENTS.md` |
185
+ | 视觉代理(zcode-vision 插件) | `~/.zcode/zcode-vision.json` |
186
+ | rtk 压缩(rtk 插件) | `~/.zcode-rtk/` |
187
+ | Headroom(headroom 插件) | `~/.zcode/headroom.json` |
188
+
189
+ 卸载后直接使用官方 ZCode 入口启动即可,无需清理系统位置。
190
+
191
+ ## 🔌 插件推荐
192
+
193
+ [duanluan/zcode-plugins](https://github.com/duanluan/zcode-plugins) 是配套的 ZCode 插件市场,提供 AI 代码评审、对话请求压缩、命令输出压缩等插件,可显著节省 token。安装方式:ZCode → 插件市场 → 右上角“添加”→ 添加插件市场,填写 `duanluan/zcode-plugins`。已安装的插件可在 ZCode Pro 设置中一键检查并更新。
194
+
195
+ ## 💬 交流与反馈
196
+
197
+ - QQ 群:**428403354**([点击加入](https://qm.qq.com/q/WXuISJK3ug))
198
+ - 微信群:添加微信 **ai4only** 邀请进群
199
+
200
+ <p>
201
+ <img src="https://raw.githubusercontent.com/duanluan/zcode-pro/main/assets/qq-group.png" width="200" alt="QQ 群二维码" />
202
+ &nbsp;&nbsp;
203
+ <img src="https://raw.githubusercontent.com/duanluan/zcode-pro/main/assets/wechat-ai4only.png" width="200" alt="微信二维码(ai4only)" />
204
+ </p>