minecodex 2.0.37 → 2.0.38

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 (2) hide show
  1. package/README.md +26 -89
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,114 +1,51 @@
1
1
  <p align="center">
2
- <img src="./assets/readme/hero.svg" width="100%" alt="MineCodex：给 Codex Desktop 增加轻量、本地优先的插件，包含模型滑条、笔记与图片库">
2
+ <img src="./assets/readme/hero.svg" width="100%" alt="MineCodex：让 Codex 更顺手">
3
3
  </p>
4
4
 
5
5
  # MineCodex
6
6
 
7
- MineCodex 给 Codex Desktop 增加一组轻量、本地优先的扩展功能。配置、提示词和图片索引保存在本机。Images 的本地浏览不上传图片；使用云端收藏、加入文件夹或部分生成编辑操作时，所选图片会通过 Codex 原生能力上传至 OpenAI。
7
+ 为 Codex Desktop 添加轻量扩展，按需开启，让日常使用更顺手。
8
8
 
9
- ## 插件列表
9
+ ## 功能
10
10
 
11
- | 插件 | 说明 |
11
+ | 插件 | 功能 |
12
12
  | --- | --- |
13
- | **模型窗口** · Model Panel | 快速切换模型和思考强度，收藏常用模型。 |
14
- | **提示词库** · Prompt Library | 分类保存常用提示词，需要时一键填入输入框。 |
15
- | **额度环** · Usage Ring | 在侧栏查看五小时和每周剩余额度，点击打开用量详情。 |
16
- | **会话状态** · Session Status | 查看回复速度、Token 用量和上下文占用，了解对话消耗。 |
17
- | **Markdown 阅读增强** · Markdown Reader | 让 Markdown 文档更易读，支持章节目录、表格展开和代码复制。 |
18
- | **文件级联浏览** · Cascading File Browser | 点击文件顶部路径，分列浏览文件夹并快速切换文件。 |
19
- | **图片集合** · Image Collection | 集中浏览生成的图片，查看提示词并复用创作思路。 |
20
- | **站点收藏** · Saved Sites | 发现项目正在运行的网页，收藏常用网址，随时打开。 |
21
- | **快捷聊天增强** · Enhance Quick Chat | 补回 ⌘⌥N；关闭后开新聊天，最小化后恢复当前聊天，发送后展开。支持固定窗口、原生历史与退出遮罩修复。 |
22
- | **侧栏聚焦** · Sidebar Focus | 一键收起侧栏中的其他分组，再次点击恢复原来的展开状态。 |
23
- | **隐藏额度推广** · Hide Usage Promotions | 隐藏输入框上方的套餐升级推广，让对话更清爽。 |
13
+ | 模型窗口 | 切换模型和思考强度，搜索、收藏常用模型。 |
14
+ | 提示词库 | 分类管理提示词，一键填入输入框，不自动发送。 |
15
+ | 额度环 | 查看五小时与每周剩余额度，点击打开用量详情。 |
16
+ | 会话状态 | 查看回复速度、Token 用量和上下文占用。 |
17
+ | Markdown 阅读增强 | 改善文档排版，支持章节目录、表格展开和代码复制。 |
18
+ | 文件级联浏览 | 点击文件路径，分列浏览目录并切换文件。 |
19
+ | 图片集合 | 浏览本机生成图片，查看提示词，收藏到 Library。 |
20
+ | 站点收藏 | 发现本地项目网页，收藏网址并快速打开。 |
21
+ | 快捷聊天增强 | 恢复快捷键，发送后展开，支持历史与窗口固定。 |
22
+ | 侧栏聚焦 | 收起其他任务分组，再次点击恢复布局。 |
23
+ | 隐藏额度推广 | 隐藏输入框上方的套餐升级推广。 |
24
24
 
25
25
  ## 安装
26
26
 
27
- MineCodex 支持 macOS 与 Windows 系统，需要 Node.js 22.5 或更高版本。安装程序会自动扫描 `/Applications/ChatGPT.app` 或 `~/Applications/ChatGPT.app` 寻找 Codex Desktop；在 Windows 上则通过 MSIX 包（`OpenAI.Codex`）定位官方 ChatGPT 应用并校验 OpenAI 签名。如果均未找到，安装将暂停并给出说明。
27
+ 支持 macOS 与 Windows。先安装 Codex Desktop 和 [Node.js](https://nodejs.org/) 22.5 或更高版本，然后在终端运行：
28
28
 
29
29
  ```bash
30
30
  npm install -g minecodex
31
31
  mcx install
32
+ mcx open
32
33
  ```
33
34
 
34
- 运行 `mcx install` 不会强制关闭或启动 Codex，也不会影响当前打开的窗口。安装完成后，终端会说明更改将在下一次重启 Codex 时生效，并询问是否立即重启；默认选项为 **No**。只有在您明确确认，或后续手动运行 `mcx restart` 时，才会重新打开 Codex。安装完成后，macOS 的“登录项与扩展”中会添加名为 **MineCodex** 的后台项目。
35
-
36
- `mcx install`、`mcx update`、`mcx restart` 和 `mcx uninstall` 会在终端持续显示当前阶段；`mcx open` 仅在需要启动后台服务时显示进度。查询类命令保持简洁，便于直接阅读或用于脚本。
37
-
38
- MineCodex 只以后台辅助服务运行，前台应用始终是 OpenAI 签名的官方 ChatGPT 应用，并继续使用官方默认用户数据。通过 Dock、Finder、Spotlight、登录项或会话恢复打开 ChatGPT 时，后台服务会验证官方应用与对应进程；若该进程尚未开放兼容的本机调试端口，则确认其完整退出后再重新打开官方应用并注入功能。MineCodex 不修改官方应用文件、`app.asar`、Dock 项目或默认打开方式。在 macOS 上，后台项目出现在"登录项与扩展"中；在 Windows 上，后台任务出现在任务计划程序（任务名 `MineCodex`）。
39
-
40
- 打开本地控制台：
35
+ 安装后重启 Codex 即可使用。在控制台按需开关功能，修改后运行 `mcx restart` 应用设置。
41
36
 
42
- ```bash
43
- mcx open
44
- ```
37
+ 如需在 Codex 内打开控制台和 Prompt 页面，先安装 [Codex CLI](https://developers.openai.com/codex/cli/)，再运行 `mcx plugin install`，从 Explore／探索中打开。
45
38
 
46
- 常用命令：
39
+ ## 常用命令
47
40
 
48
41
  | 命令 | 作用 |
49
42
  | --- | --- |
50
- | `mcx install` | 安装或修复 MineCodex |
51
- | `mcx uninstall [--purge]` | 移除扩展；默认保留个人数据，带 `--purge` 参数才会清理 |
52
- | `mcx update` | 更新到最新的稳定版本 |
53
- | `mcx open` | 打开 MineCodex 控制台 |
54
- | `mcx plugin install` | 通过官方插件机制注册 Codex 内的 MineCodex 控制台入口 |
55
- | `mcx status [--json]` | 查看安装与插件运行状态 |
56
- | `mcx restart` | 重启 Codex 并应用插件开启/关闭状态 |
57
-
58
- 关闭某项功能仅停用对应的扩展服务，不会删除任何个人数据；修改设置后运行 `mcx restart` 即可应用更改。
59
-
60
- 运行 `mcx plugin install` 后，在 Codex 的 Explore／探索中打开 MineCodex，也可按原生
61
- 导航设置固定到侧栏。该本地插件使用官方 MCP Apps 入口与面板，复用原有控制台。
62
- 关闭面板不会停止增强；各项功能继续由 MineCodex 本地服务和注入运行时提供。
63
- 当前正在运行的窗口若未刷新插件目录，下次正常启动后查看。安装命令不会重启 Codex。
64
- 插件卸载使用 `codex plugin remove minecodex@minecodex-local`，不删除增强配置或数据。
65
-
66
- 运行 `mcx uninstall` 会移除名为 MineCodex 的后台项目，并默认保留配置设置、Notes 笔记和 Images 图片索引；只有显式加上 `--purge` 参数，才会清理 MineCodex 产生的本地配置。MineCodex 绝不会删除 `~/.codex/generated_images` 中的原始图片或 Notes 引用的本地文件。
67
-
68
- ## 数据与图片操作
69
-
70
- 本地 Image Gen 浏览、搜索、提示词查看和下载不会创建云端图片。首次收藏或加入文件夹时，会将所选图片上传到 OpenAI 的 Library；收藏和文件夹关系由云端保存。首次上传后取消文件夹选择，已产生的云端副本仍会保留，界面会提示“图片已保存到 Library，但未加入文件夹”。
71
-
72
- 图片生成编辑可能通过原生能力准备临时上传附件；查看图片不会触发这类操作。从 Image Gen 删除仅隐藏本地索引条目，保留原始图片和云端副本。卸载或 `--purge` 不会删除云端图片，也不会删除 Codex 的原始生成图片。
73
-
74
- ## 更新后的自检
75
-
76
- MineCodex 在每个 Codex 窗口启动并完成注入后，后台检查一次功能安装、原生锚点与实际使用的设计变量。新窗口、页面重载或重新接入时重新检查；结果代表检查时的页面，不持续监测后续页面切换。控制台区分“正在自检”“部分窗口可用”“外观适配需要更新”“暂不可用”和“当前页面不适用”。没有输入框或未打开 Sites / Images 时，相关功能可能不适用，并不直接表示版本不兼容。
77
-
78
- 可使用控制台的“复制诊断信息”提供自检结果。诊断包含功能、窗口、锚点与设计变量证据，不包含提示词、聊天内容、账号资料或安装路径。自检可用表示当前检查项通过，实际保存、上传、模型切换等操作仍以各自的结果为准。
79
-
80
- ## 工作原理
81
-
82
- MineCodex 统一管理 Codex 内的菜单入口、主题风格与界面适配。Model Slider、Prompts 各自管理操作界面，Images 在原生 Images 中接入本地生成图片和提示词查看；Session Status 只读汇总本机 Codex 会话事件，Hide Upsell Banner 优化界面展示。所有功能按需开启，关闭后即停止运行。
83
-
84
- ## 开发
85
-
86
- ```bash
87
- npm install
88
- npm test
89
- npm run check
90
- npm run pack:check
91
- npm run pack:audit
92
- ```
93
-
94
- 维护者发布流程见 [GitHub Actions 发布说明](https://github.com/Vontean/MineCodex/blob/main/docs/npm-publishing.md)。发布工作流仅允许维护者本人触发，使用 npm 可信发布，无需长期访问令牌。
43
+ | `mcx open` | 打开控制台 |
44
+ | `mcx update` | 更新到最新版本 |
45
+ | `mcx restart` | 重启 Codex 并应用设置 |
46
+ | `mcx status` | 查看运行状态 |
47
+ | `mcx uninstall` | 卸载，保留个人数据 |
95
48
 
96
49
  ## 许可
97
50
 
98
- MineCodex 是非官方独立扩展项目，与 OpenAI 无关联。项目自有代码以 MIT License 授权；第三方图标、品牌和兼容资产遵循各自的权利说明，见 [`features/model-slider/THIRD_PARTY_NOTICES.md`](features/model-slider/THIRD_PARTY_NOTICES.md) 与 [`features/session-status/vendor/lucide-LICENSE`](features/session-status/vendor/lucide-LICENSE)。
99
-
100
- ## 侧栏聚焦
101
-
102
- 展开侧栏时，点击铃铛与搜索之间的聚焦按钮，保留当前任务路径并收起其他分支。再次点击恢复原先布局；切换任务时跟随路径，手动调整分支时退出聚焦。
103
-
104
- ## 在电脑之间迁移数据
105
-
106
- 在 `mcx gui` 底部打开「数据迁移」，导出 `.mcx.json` 文件，再到另一台 Mac 或 Windows
107
- 电脑的同一入口导入。确认前可查看新增、重复和冲突数量。只补充缺失项，重复项跳过，
108
- 冲突保留本机版本，不删除已有数据。
109
-
110
- 支持 Prompts 与分类、公网 Sites、模型收藏。模型旧收藏在新版模型滑条首次启动后收录，
111
- 导入收藏在下次启动 Codex 后载入。图片文件、本地站点、账号信息与设备设置不包含在文件中；
112
- 可迁移功能的特殊说明可通过 info 查看。这是手动迁移，不是自动云同步。文件包含提示词正文，请妥善保管。
113
-
114
- 官方插件提供 MineCodex 控制台与 **Prompt** 两个入口，分别使用 MCX 品牌图标与 Prompt 图标。Prompt 仍由 MCX 管理，沿用原有提示词数据；输入框里的快捷提示词继续只填入、不发送。
51
+ [MIT](LICENSE)。MineCodex 是非官方独立扩展，与 OpenAI 无关联；第三方素材遵循各自的[权利说明](features/model-slider/THIRD_PARTY_NOTICES.md)。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "minecodex",
3
- "version": "2.0.37",
3
+ "version": "2.0.38",
4
4
  "description": "Lightweight, local-first plugins for the Codex desktop app.",
5
5
  "license": "MIT",
6
6
  "type": "module",