codex-ringside 0.1.0-rc.0 → 0.1.1

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/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.1
4
+
5
+ - Add copyable English and Chinese AI installation prompts to the README, covering prerequisites, installation, existing settings and status verification.
6
+ - Present AI-assisted and terminal installation as separate options. Runtime behavior is unchanged.
7
+
8
+ ## 0.1.0
9
+
10
+ First stable public release. Includes all candidate features, with verified Codex Plus migration, preserved backgrounds and a single active renderer component on the development Mac.
11
+
12
+ Validation: 85 tests; Node.js 22, 24 and 26 on Apple Silicon; Node.js 24 on Intel; Swift compiled from the published package contents on both architectures. Official publishing uses GitHub Actions OIDC with provenance and matching release checksums.
13
+
3
14
  ## 0.1.0-rc.0
4
15
 
5
16
  First public candidate of Codex Ringside, formerly the local Codex Plus project.
package/README.md CHANGED
@@ -14,6 +14,34 @@ See your remaining allowance at a glance, hover for reset times, and click a rin
14
14
 
15
15
  Requirements: macOS, Node.js 22+, Xcode Command Line Tools (`xcode-select --install`), and a signed-in compatible desktop client. The development host is `/Applications/ChatGPT.app`, version `26.1027.30824`, on Apple Silicon. Other host versions depend on compatible internal interfaces and are not individually verified. The CLI and settings panel currently use Chinese labels.
16
16
 
17
+ ### Option 1: Ask an AI assistant
18
+
19
+ Copy the prompt below into an AI assistant that can run commands on your Mac. The assistant can check prerequisites, install Ringside and verify the result. Complete any macOS authorization or host sign-in prompts yourself when needed.
20
+
21
+ ```text
22
+ Please install Codex Ringside on my Mac: https://github.com/tccpc/codex-ringside
23
+
24
+ Read the repository's README first and briefly explain what will be installed, including the local debug port.
25
+ Check macOS, Node.js 22+, Xcode Command Line Tools and a compatible signed-in desktop client.
26
+ If this is not macOS, explain that it is unsupported and stop.
27
+ Help resolve missing prerequisites, and tell me when a system dialog needs my input.
28
+
29
+ Install from the official npm registry:
30
+ npx --yes --registry=https://registry.npmjs.org/ codex-ringside@latest install
31
+
32
+ Preserve existing Ringside or Codex Plus settings.
33
+ If the compatible desktop app is outside the default location, use CODEX_RINGSIDE_APP to specify the detected path.
34
+
35
+ After installation, run:
36
+ npx --yes --registry=https://registry.npmjs.org/ codex-ringside@latest status
37
+
38
+ Report whether the background agent is running and the usage ring is placed, then give me the uninstall command.
39
+ If the ring is not visible yet, explain the status and tell me to save my work and reopen the client manually.
40
+ Do not close or force-quit the client I am using.
41
+ ```
42
+
43
+ ### Option 2: Install from the terminal
44
+
17
45
  ```bash
18
46
  npx codex-ringside@latest install
19
47
  ```
package/README.zh-CN.md CHANGED
@@ -21,6 +21,34 @@
21
21
 
22
22
  需要 macOS、Node.js 22+ 和 Xcode Command Line Tools(`xcode-select --install`),以及已登录的兼容桌面客户端。开发与真机验证使用 `/Applications/ChatGPT.app`,版本 `26.1027.30824`。其他客户端版本依赖相同内部结构,未逐一验证。
23
23
 
24
+ ### 方式一:让 AI 帮你安装
25
+
26
+ 把下面整段提示词复制给能在你的 Mac 上运行终端命令的 AI 助手,让它完成环境检查、安装和结果验证。遇到 macOS 授权弹窗或客户端登录时,由你本人完成操作。
27
+
28
+ ```text
29
+ 请帮我在这台 Mac 上安装 Codex Ringside,项目地址:https://github.com/tccpc/codex-ringside
30
+
31
+ 先阅读仓库的 README,简要说明安装内容和本机调试端口的用途。
32
+ 检查 macOS、Node.js 22+、Xcode Command Line Tools,以及已登录的兼容桌面客户端。
33
+ 如果不是 macOS,请说明不支持并停止安装。
34
+ 缺少依赖时协助补齐,需要我处理系统弹窗时再提示我。
35
+
36
+ 从官方 npm 源安装:
37
+ npx --yes --registry=https://registry.npmjs.org/ codex-ringside@latest install
38
+
39
+ 保留已有的 Ringside 或 Codex Plus 设置;
40
+ 如果兼容桌面应用不在默认位置,用 CODEX_RINGSIDE_APP 指定检测到的应用路径。
41
+
42
+ 安装后运行:
43
+ npx --yes --registry=https://registry.npmjs.org/ codex-ringside@latest status
44
+
45
+ 告诉我后台是否正常运行、侧栏圆环是否已显示,并给出卸载命令。
46
+ 圆环尚未显示时,解释当前状态,提醒我保存工作后手动重开客户端;
47
+ 不要主动关闭或强制结束我正在使用的客户端。
48
+ ```
49
+
50
+ ### 方式二:终端安装
51
+
24
52
  以下命令显式安装后台任务;仅下载 npm 包不会安装或启动后台。命令行和设置面板目前使用中文。
25
53
 
26
54
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "codex-ringside",
3
- "version": "0.1.0-rc.0",
3
+ "version": "0.1.1",
4
4
  "description": "Usage rings and customizable backgrounds for the Codex desktop app. Unofficial macOS add-on.",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",