@morndream/mihomo-tui 0.5.0-rc.6 → 0.5.0

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 (3) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +63 -36
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,10 @@
5
5
 
6
6
  ## [Unreleased]
7
7
 
8
+ ## [0.5.0] - 2026-09-28
9
+
10
+ - 首个正式版，汇总 rc.0–rc.6 的全部变更，功能与 `0.5.0-rc.6` 一致。核心能力：mihomo（Clash.Meta）内核的 CLI + TUI 管理——六页 TUI（节点 / 订阅 / 规则 / 日志 / 连接 / 设置）、订阅事务（更新不覆盖手写 `config.yaml`）、规则编辑器、内核安装与服务化、shell 系统代理集成；完整适配 mihomo v1.19.28+ 的 provider 节点 API 行为变更。
11
+
8
12
  ## [0.5.0-rc.6] - 2026-09-28
9
13
 
10
14
  - 完整适配 mihomo v1.19.28+ 的 API 行为变更（上游 85c1798f 有意恢复原版 Clash 行为：provider 节点不再合并进 `/proxies`，按节点名的查询与测速也不再回退到 provider）。节点视图改为 `/proxies` + `/providers/proxies` 合并——节点的类型、延迟历史、provider 归属恢复完整；provider 节点的单节点测速统一改走 `/providers/proxies/{provider}/{node}/healthcheck`（新旧内核同形，无需按内核版本分支）；rc.5 的组测速端点与 overlay 兜底保持不变。
package/README.md CHANGED
@@ -20,9 +20,13 @@ mihomo 目录，全部数据只落本机。
20
20
  | --- | --- |
21
21
  | ![节点页：左侧代理组列表，右侧节点延迟五档显示](docs/assets/tui-proxies.png) | ![订阅页：订阅列表含节点数、流量进度条与到期时间](docs/assets/tui-subscriptions.png) |
22
22
 
23
- | 规则页：生效规则与规则集 | |
23
+ | 规则页：生效规则与规则集 | 日志页：级别切换与关键字过滤 |
24
24
  | --- | --- |
25
- | ![规则页：生效规则列表与规则集](docs/assets/tui-rules.png) | |
25
+ | ![规则页：生效规则列表与规则集](docs/assets/tui-rules.png) | ![日志页：WebSocket 日志流，支持级别切换与关键字过滤](docs/assets/tui-logs.png) |
26
+
27
+ | 连接页：实时连接，按流量排序与关闭 | 设置页：程序配置与内核版本管理 |
28
+ | --- | --- |
29
+ | ![连接页：实时连接列表，支持按流量排序与关闭](docs/assets/tui-connections.png) | ![设置页：程序配置与内核版本管理](docs/assets/tui-settings.png) |
26
30
 
27
31
  ## 能做什么
28
32
 
@@ -95,12 +99,6 @@ grep linux-x64 checksums.txt | sha256sum -c - # checksums.txt 含全部五个
95
99
  chmod +x mihomo-tui-*-linux-x64
96
100
  ```
97
101
 
98
- ### 发布机制
99
-
100
- 推送 `v*` tag 触发 [.github/workflows/release.yml](.github/workflows/release.yml)：五平台
101
- 交叉编译、三平台冒烟、Release 附加产物与 npm 同步发布；`-rc` 后缀的 tag 自动标记预发布并
102
- 发布到 npm 的 `next` dist-tag。项目未提供 Docker 或云平台部署配置。
103
-
104
102
  ### 卸载内核
105
103
 
106
104
  `kernel install` 装的二进制、归档与引导配置，手工清理：
@@ -126,34 +124,63 @@ mihomo-tui status
126
124
 
127
125
  ## 第一次使用
128
126
 
129
- 1. **还没有 mihomo 内核？** 一条命令自助闭环：
130
-
131
- ```bash
132
- mihomo-tui kernel install # 下载安装最新稳定版内核 + 生成最小引导配置
133
- mihomo-tui kernel service install # 可选：一键开机自启（systemd/launchd/计划任务）
134
- ```
135
-
136
- 官方源失败自动回退镜像（可 `--mirror` 指定、`--port` 自定义控制口端口）；`config.yaml`
137
- 已存在时绝不触碰。已有内核的用户跳过本步。
138
- 2. `mihomo-tui status` 确认内核可达，输出内核版本、模式、端口与 provider 概览；连不上时
139
- 检查内核是否已启动（安装但未启动的场景报错会单独提示）、`external-controller` 地址与
140
- `secret` 是否正确。
141
- 3. `~/.config/mihomo-tui/config.json` 首次运行自动生成，确认 `api`、`secret` 与
142
- `mihomoDir`（订阅事务和规则编辑器写 `config.yaml` 的位置）指向你的内核。
143
- 4. 进入 TUI（直接运行 `mihomo-tui`），在订阅页按 `a` 新增订阅；已有「整份订阅」旧配置的
144
- 用户可用 `node scripts/migrate-config.mjs --dry-run --diff` 预览改造方案，确认后 `--apply`。
145
- 5. 节点页 `Enter` 选用节点、`t` 测速；订阅页 `u` 更新当前订阅、`U` 全部更新。
146
- 6. 要用 `proxy on` / `proxy off` / `proxy status` 快捷命令管理本 shell 的系统代理环境变量，
147
- 把集成装进 bashrc（首次运行 `mihomo-tui` 时命令行也会输出同样提示）：
148
-
149
- ```bash
150
- echo 'eval "$(mihomo-tui proxy init)"' >> ~/.bashrc && source ~/.bashrc
151
- proxy on # 开启本 shell 的系统代理，端口自动发现
152
- ```
153
- 7. 备份与迁移：配置变更自动留 `config.yaml.bak.*`（保留 7 天）；换设备时拷贝
154
- `~/.config/mihomo-tui/` 与 mihomo 目录即可完整复原。
155
- 8. 注意：新增 / 删除订阅会重启一次 mihomo 服务（秒级断流，更新不断流）；切节点、切模式等
156
- 运行时改动重启后丢失，需持久化的变更写入 `config.yaml` 后执行 `mihomo-tui reload`。
127
+ ### 1. 安装内核（已有内核可跳过）
128
+
129
+ 还没有 mihomo 内核时，一条命令完成下载安装与最小引导配置：
130
+
131
+ ```bash
132
+ mihomo-tui kernel install # 下载最新稳定版内核 + 生成最小引导配置
133
+ mihomo-tui kernel service install # 可选：一键开机自启（systemd / launchd / 计划任务）
134
+ ```
135
+
136
+ 官方源失败自动回退镜像，可用 `--mirror` 指定镜像、`--port` 自定义控制口端口；已存在的
137
+ `config.yaml` 绝不触碰。
138
+
139
+ ### 2. 确认内核可达
140
+
141
+ ```bash
142
+ mihomo-tui status # 输出内核版本、模式、端口与 provider 概览
143
+ ```
144
+
145
+ 连不上时依次检查：内核是否已启动（安装但未启动会单独提示）、`external-controller` 地址、
146
+ `secret` 是否正确。程序配置 `~/.config/mihomo-tui/config.json` 首次运行自动生成，确认其中
147
+ `api`、`secret` 与 `mihomoDir`（订阅事务和规则编辑器写 `config.yaml` 的位置）都指向你的内核。
148
+
149
+ ### 3. 加订阅、选节点
150
+
151
+ 直接运行 `mihomo-tui` 进入 TUI：
152
+
153
+ ```bash
154
+ mihomo-tui # 进入 TUI
155
+ ```
156
+
157
+ - 订阅页：`a` 新增订阅、`u` 更新当前订阅、`U` 全部更新。
158
+ - 节点页：`Enter` 选用节点、`t` 测速。
159
+
160
+ 已有「整份订阅」旧配置的用户，先预览改造方案再应用：
161
+
162
+ ```bash
163
+ node scripts/migrate-config.mjs --dry-run --diff # 预览
164
+ node scripts/migrate-config.mjs --apply # 确认后应用
165
+ ```
166
+
167
+ ### 4. （可选）shell 系统代理集成
168
+
169
+ 把集成装进 `~/.bashrc` 后即可用 `proxy on` / `proxy off` / `proxy status` 管理本 shell 的
170
+ 系统代理环境变量（首次运行 `mihomo-tui` 也会输出同样提示）：
171
+
172
+ ```bash
173
+ echo 'eval "$(mihomo-tui proxy init)"' >> ~/.bashrc && source ~/.bashrc
174
+ proxy on # 开启本 shell 的系统代理，端口自动发现
175
+ ```
176
+
177
+ ### 须知
178
+
179
+ - **备份与迁移**：配置变更自动留 `config.yaml.bak.*`（保留 7 天）；换设备时拷贝
180
+ `~/.config/mihomo-tui/` 与 mihomo 目录即可完整复原。
181
+ - **重启行为**：新增 / 删除订阅会重启一次 mihomo 服务（秒级断流，更新本身不断流）；切节点、
182
+ 切模式等运行时改动重启后丢失，需持久化的变更写入 `config.yaml` 后执行 `mihomo-tui reload`。
183
+
157
184
 
158
185
  ## CLI 速查
159
186
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@morndream/mihomo-tui",
3
- "version": "0.5.0-rc.6",
3
+ "version": "0.5.0",
4
4
  "description": "CLI + TUI manager for the mihomo proxy kernel (API-driven, with a guarded transactional config layer)",
5
5
  "type": "module",
6
6
  "license": "MIT",