@oldsuns/pi-switch 0.2.1 → 0.2.3

package/README.md

@@ -6,26 +6,30 @@ CLI：`pi-switch` · npm 包：`@oldsuns/pi-switch` · Node 薄壳 + Rust/napi
 
 ## 功能
 
-- **主页**：provider / model 计数、默认模型、关键路径
+- **主页**：provider / model 计数、默认模型、关键路径；启动后台静默检查 npm 新版本，有更新时弹出确认对话框可一键安装
 - **配置 (Profiles)**：本地 provider 库与 Pi 启用子集；新建 / 编辑 / 删除 / 复制；在线导入模型
 - **会话 (Sessions)**：浏览 JSONL session、筛选、预览、复制消息、删除
-- **设置 (Settings)**：语言、models.dev 元数据、默认参数、重载、校验、备份、OpenCode 导入
+- **设置 (Settings)**：语言、models.dev 元数据、默认参数、重载、校验、备份、OpenCode 导入、自动检查更新、手动检查更新
 - 完整库保存在 `~/.pi-switch/providers.json`，只有已启用项写入 Pi 的 `models.json`
 
 ## 要求
 
 - Node.js `>= 20`
-- 本地构建原生模块需要 Rust 工具链与 `@napi-rs/cli`
-- 预构建目标：macOS (x64/arm64)、Linux (gnu/musl x64)、Windows (msvc x64)
+- 预构建原生模块当前仅覆盖 Windows (msvc x64)——直接 `npm install -g` 即装即用
+- 本地构建原生模块（仅开发者）需要 Rust 工具链与 `@napi-rs/cli`
 
-## 安装与运行
+## 快速开始
 
 ```bash
-npm install
-npm run build:native:debug
-node ./bin/pi-switch.js
+# 全局安装
+npm install -g @oldsuns/pi-switch
+
+# 打开 TUI
+pi-switch
 ```
 
+首次运行会自动把现有的 `~/.pi/agent/models.json` 全量导入本地库，**不修改** Pi 配置；随后即可在 Profiles 中勾选要加入 Pi 的 provider / model。
+
 CLI：
 
 ```bash
@@ -36,6 +40,18 @@ pi-switch --version      # / -v
 pi-switch --help         # / -h / help
 ```
 
+Windows 上无需 Rust：预构建原生模块随 npm 包分发，`pi-switch` 开箱即用。本地开发见下文「开发者」。
+
+## 开发者
+
+从源码构建：
+
+```bash
+npm install
+npm run build:native:debug
+node ./bin/pi-switch.js
+```
+
 ## 界面与快捷键
 
 全局导航：`j/k` 或方向键移动；菜单中 `Enter` / `l` 进入内容，`h` / `Esc` / `Tab` 回菜单；`?` 帮助；`q` 退出（多数界面 `Ctrl+C` 也退出，会话预览除外）。
@@ -87,6 +103,8 @@ Session 根目录优先级：`PI_CODING_AGENT_SESSION_DIR` → `PI_CODING_AGENT_
 |----|------|
 | 语言 | English / 中文（`en` / `zh-CN`） |
 | 从 models.dev 获取模型信息 | 开关实时元数据（默认开） |
+| 自动检查更新 | 启动时后台自动检查 npm `@oldsuns/pi-switch` 新版本（开关，默认开） |
+| 检查更新（手动） | 立即检查新版本（绕过 24h 缓存） |
 | 默认模型参数 | 仅关闭实时元数据时显示，用于导入缺省 |
 | 重载配置 | 从磁盘重读 |
 | 验证配置 | doctor |
@@ -131,6 +149,7 @@ Session 根目录优先级：`PI_CODING_AGENT_SESSION_DIR` → `PI_CODING_AGENT_
 | `~/.config/opencode/opencode.json` | OpenCode 只读导入源 |
 | `~/.pi-switch/backups/` | version 2 备份（providers + models + settings），最多 10 份 |
 | `~/.pi-switch/write.lock` | 写入互斥锁 |
+| `~/.pi-switch/update.json` | npm 新版本检查缓存（`lastCheck` + `latest` + `dismissed`，每 24h 最多联网一次） |
 
 `settings.json` 中与 pi-switch 相关的字段：
 
@@ -139,6 +158,7 @@ Session 根目录优先级：`PI_CODING_AGENT_SESSION_DIR` → `PI_CODING_AGENT_
 | `defaultProvider` + `defaultModel` | 默认模型（成对存在或同时缺省） |
 | `piSwitch.language` | `en` \| `zh-CN` |
 | `piSwitch.fetchModelMetadata` | 是否拉 models.dev（默认 `true`） |
+| `piSwitch.checkForUpdates` | 是否启动时检查 npm 新版本（默认 `true`） |
 | `piSwitch.modelDefaults` | 关闭实时元数据时的导入缺省（context / maxTokens / cost） |
 
 ## 数据安全
@@ -151,6 +171,22 @@ Session 根目录优先级：`PI_CODING_AGENT_SESSION_DIR` → `PI_CODING_AGENT_
 - Session 删除只作用于选中的 JSONL，并校验路径必须位于 session 根目录内；优先调用系统 `trash`，失败后再永久删除。
 - 正常退出、错误和 panic 都会恢复 raw mode、alternate screen 与光标。
 
+## 自动更新检查与安装
+
+启动时若 Settings 中「自动检查更新」开启（默认开），pi-switch 会在后台线程静默访问 npm registry 查询 `@oldsuns/pi-switch` 的 `latest` 版本，与当前版本对比：
+
+- 有新版本：弹出确认对话框（显示 `当前 → 最新`），用户可选择立即安装或跳过。跳过后同一版本不再弹窗，但主页仍显示横幅。手动检查（Settings 中「检查更新」）始终弹窗。
+- 无新版本、离线或请求失败：静默无提示，不打扰用户。
+
+安装流程：
+
+1. 用户在确认对话框按 `Enter/y` 确认 → 后台执行 `npm install -g @oldsuns/pi-switch`，显示加载动画。
+2. 安装成功 → 通知「更新已安装，请重启 pi-switch 生效」。
+3. 安装失败 → 弹出错误通知（如权限不足、网络问题）。
+4. 用户按 `Esc/n` 跳过 → 记录已跳过的版本到缓存，同一版本不再自动弹窗；主页横幅仍提示有新版本。
+
+检查结果缓存在 `~/.pi-switch/update.json`，自动检查每 24h 最多联网一次。后台线程独立于目录导入任务，不阻塞 UI。Settings 中可随时关闭「自动检查更新」。
+
 ## 验证
 
 ```bash
@@ -164,3 +200,7 @@ npm run pack:check
 ## 许可
 
 MIT
+
+## 致谢
+
+感谢 [LINUX DO](https://linux.do) 社区的讨论与反馈。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oldsuns/pi-switch",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A focused terminal UI for Pi provider and model configuration",
   "type": "module",
   "bin": {
@@ -38,10 +38,17 @@
     "provider",
     "models"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OldSuns/pi-switch.git"
+  },
   "license": "MIT",
   "engines": {
     "node": ">=20"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@napi-rs/cli": "^3.7.1"
   }