mihomo-cli 1.0.0-alpha.1 → 1.0.1

package/README.md

@@ -1,17 +1,19 @@
 # mihomo-cli
 
-一个基于命令行的 mihomo (Clash.Meta) 客户端，支持 macOS、Windows 和 Linux。
+一个基于命令行的 mihomo (Clash.Meta) 客户端，专为 macOS 设计。Windows / Linux 正在适配中，敬请期待。
 
 ## 功能特性
 
-- 🌐 **订阅管理** - 添加和更新订阅链接
-- 🚀 **进程管理** - 启动、停止、重启 mihomo 内核
+- 🌐 **订阅管理** - 添加/更新订阅，支持流量统计和到期时间显示
+- 🔄 **自动更新** - 启动时自动检查并更新过期订阅
+- 🔍 **模糊匹配** - `sub use` / `sub web` 支持订阅名称模糊匹配
+- 🚀 **进程管理** - 启动/停止/切换模式，自动清理残留进程
 - 🔄 **双模式支持** - Mixed 模式和 TUN 透明代理模式
 - 📊 **状态监控** - 查看运行状态、内存、CPU 占用
-- 📝 **日志查看** - 实时查看运行日志
+- 📝 **日志管理** - 实时日志 + 历史日志归档（自动轮转，保留7天）
 - 🎨 **Web UI** - 一键打开 Web 控制面板 (zash/metacubexd/yacd)
-- 🔄 **内核更新** - 自动检查并更新 mihomo 内核
-- 💻 **跨平台** - 支持 macOS、Windows、Linux
+- 🔄 **内核更新** - 自动检查更新，支持 GitHub 镜像加速
+- ⌨️ **命令别名** - `mihomo` / `mmc` / `mh` 均可调用
 
 ## 安装
 
@@ -24,49 +26,51 @@ npm install -g mihomo-cli
 ### 方式二：源码安装
 
 ```bash
-# 克隆仓库
 git clone https://github.com/yourname/mihomo-cli.git
 cd mihomo-cli
-
-# 安装依赖
 npm install
-
-# 全局链接（可选）
 npm link
 ```
 
-### 方式三：使用预编译二进制
-
-从 [Releases](https://github.com/yourname/mihomo-cli/releases) 页面下载对应平台的二进制文件。
-
 ## 快速开始
 
 ### 1. 下载内核
 
 ```bash
-mihomo-cli kernel
+# 使用默认镜像
+mihomo kernel
+
+# 或指定镜像
+mihomo kernel hk.gh-proxy.org
+
+# 或直连（不使用镜像）
+mihomo kernel --no-mirror
 ```
 
 ### 2. 添加订阅
 
 ```bash
-mihomo-cli sub add "https://your-subscription-url" "my-proxy"
+mihomo sub add "https://your-subscription-url" "my-proxy"
 ```
 
 ### 3. 启动代理
 
 ```bash
 # Mixed 模式（默认）
-mihomo-cli start
+mihomo start
 
-# TUN 模式（需要管理员权限）
-mihomo-cli start tun
+# 切换到 TUN 模式（透明代理，需要管理员权限）
+mihomo start tun
+
+# 再次执行 start = 重启 / 切换模式
 ```
 
 ### 4. 打开 Web UI
 
 ```bash
-mihomo-cli ui
+mihomo ui          # 默认 zash
+mihomo ui dash     # metacubexd
+mihomo ui yacd     # YACD
 ```
 
 ## 命令参考
@@ -75,30 +79,42 @@ mihomo-cli ui
 
 | 命令 | 说明 |
 |------|------|
-| `mihomo-cli start [tun|mixed]` | 启动代理 (默认 mixed) |
-| `mihomo-cli stop` | 停止代理 |
-| `mihomo-cli restart` | 重启代理 |
-| `mihomo-cli status` | 查看运行状态 |
-| `mihomo-cli log` | 实时查看日志 |
-| `mihomo-cli clean` | 清理残留进程 |
+| `mihomo start [tun\|mixed]` | 启动/重启/切换代理模式 |
+| `mihomo stop` | 停止代理 |
+| `mihomo status` | 查看运行状态 |
+| `mihomo log` | 实时查看日志 (`-o` 用系统编辑器打开) |
+| `mihomo logs` | 列出历史日志归档 |
+| `mihomo logs <编号>` | 查看指定归档日志 (`-n N` 指定行数, `-o` 打开) |
 
 ### 订阅管理
 
 | 命令 | 说明 |
 |------|------|
-| `mihomo-cli sub list` | 列出所有订阅 |
-| `mihomo-cli sub add <url> [name]` | 添加订阅 |
-| `mihomo-cli sub update [name]` | 更新订阅 |
+| `mihomo sub list` | 列出所有订阅（含流量、到期时间） |
+| `mihomo sub add <url> [name]` | 添加订阅 |
+| `mihomo sub update` | 更新所有订阅 |
+| `mihomo sub update <name>` | 更新指定订阅（支持模糊匹配） |
+| `mihomo sub use <name>` | 设置默认订阅（支持模糊匹配） |
+| `mihomo sub web [name]` | 打开订阅页面（无参打开默认） |
 
 ### 其他命令
 
 | 命令 | 说明 |
 |------|------|
-| `mihomo-cli kernel` | 更新内核到最新版本 |
-| `mihomo-cli ui [zash|dash|yacd]` | 打开 Web UI |
-| `mihomo-cli dirs` | 显示数据目录位置 |
-| `mihomo-cli version` | 显示版本信息 |
-| `mihomo-cli help` | 显示帮助信息 |
+| `mihomo kernel [镜像\|--no-mirror]` | 更新内核 |
+| `mihomo ui [zash\|dash\|yacd]` | 打开 Web UI |
+| `mihomo dirs` | 显示数据目录位置 |
+| `mihomo reset [--full]` | 重置用户数据 (--full 同时删除内核) |
+| `mihomo version` | 显示版本信息 |
+| `mihomo help` | 显示帮助信息 |
+
+### 命令别名
+
+以下任意命令等效：
+- `mihomo-cli` (原名)
+- `mihomo`
+- `mmc`
+- `mh`
 
 ## 模式说明
 
@@ -111,34 +127,54 @@ mihomo-cli ui
 ### TUN 模式（透明代理）
 
 - 全局自动路由，所有流量自动走代理
-- 需要 sudo/管理员权限
+- 需要 sudo / 管理员权限
 - 首次使用会自动配置 DNS 和路由
 
-## 数据目录
+## 内核更新镜像
 
-用户数据存储位置（与安装位置分离，更新不丢失）：
+国内网络可使用镜像加速 GitHub 下载：
 
-| 平台 | 路径 |
-|------|------|
-| macOS | `~/Library/Application Support/mihomo-cli/` |
-| Windows | `%APPDATA%\mihomo-cli\` |
-| Linux | `~/.config/mihomo-cli/` |
+```bash
+# 使用指定镜像
+mihomo kernel hk.gh-proxy.org
+
+# 可用镜像
+v6.gh-proxy.org      # (默认)
+gh-proxy.org
+hk.gh-proxy.org
+cdn.gh-proxy.org
+edgeone.gh-proxy.org
+
+# 直连不使用镜像
+mihomo kernel --no-mirror
+```
+
+## 订阅自动更新
+
+- 默认更新间隔：12 小时（或订阅服务端指定的 `profile-update-interval`）
+- 触发时机：`start` 命令、`sub list` 命令
+- 更新失败时继续使用本地缓存，不影响使用
 
-目录结构：
+## 数据目录
+
+用户数据存储位置（与安装位置分离，更新不丢失）：
 
 ```
-mihomo-cli/
+~/Library/Application Support/mihomo-cli/
 ├── config/
-│   ├── config.yaml    # 当前配置
-│   ├── override.yaml  # 覆盖配置（TUN/DNS 设置）
-│   └── settings.json  # 用户设置（订阅列表、内核版本）
-├── data/
-│   ├── pid            # 进程 PID
-│   ├── cache.db       # 缓存数据库
-│   ├── geoip.metadb   # GeoIP 数据库
-│   └── geosite.dat    # GeoSite 数据库
-└── logs/
-    └── mihomo.log     # 运行日志
+│   ├── config.yaml      # 当前运行配置
+│   ├── settings.json    # 用户设置（订阅列表、内核版本）
+│   └── subs-cache.json  # 订阅动态缓存（流量、到期时间等）
+├── runtime/
+│   ├── pid              # 进程 PID
+│   └── config.yaml      # mihomo 运行时配置
+├── logs/
+│   ├── mihomo.log       # 当前日志
+│   └── mihomo.YYYY-MM-DD_HH-MM-SS.log  # 归档日志
+├── subs/
+│   └── <name>.yaml      # 订阅原始配置
+└── core/
+    └── mihomo           # mihomo 内核二进制
 ```
 
 ## Web UI
@@ -156,24 +192,20 @@ mihomo-cli/
 ### 进程无法停止
 
 ```bash
-# macOS/Linux
 sudo pkill -9 mihomo
-
-# Windows (管理员 PowerShell)
-taskkill /F /IM mihomo.exe
 ```
 
 ### TUN 模式无法启动
 
-1. 确保使用 sudo/管理员权限
+1. 确保使用 sudo / 管理员权限
 2. 检查是否有其他程序占用 53 端口
-3. 查看日志获取详细错误信息：`mihomo-cli log`
+3. 查看日志：`mihomo log`
 
 ### 订阅更新失败
 
 - 检查网络连接
 - 确认订阅 URL 有效且未过期
-- URL 中的 token 等敏感信息会被自动脱敏
+- URL 中的 token 等敏感信息会自动脱敏
 
 ### 端口被占用
 
@@ -183,52 +215,11 @@ taskkill /F /IM mihomo.exe
 
 ## 安全特性
 
-- **URL 脱敏**：订阅 URL 中的 token、key、password 等敏感参数在错误信息和日志中自动替换为 `***`
+- **URL 脱敏**：订阅 URL 中的 token、key、password 等敏感参数自动替换为 `***`
 - **文件权限**：配置文件使用 `0o600` 权限（仅所有者可读可写），目录使用 `0o700` 权限
-- **信号处理**：优雅处理 SIGINT/SIGTERM 信号，防止数据损坏
+- **信号处理**：优雅处理 SIGINT/SIGTERM 信号
 - **异常捕获**：全局 uncaughtException 和 unhandledRejection 处理
 
-## 发布
-
-### npm 发布
-
-```bash
-# 登录 npm
-npm login
-
-# 发布（需要先更新版本号）
-npm publish --access public
-```
-
-### 打包二进制
-
-```bash
-# 使用 pkg 打包
-npm run pkg
-
-# 输出在 dist/ 目录
-```
-
-## 开发
-
-```bash
-# 克隆仓库
-git clone https://github.com/yourname/mihomo-cli.git
-cd mihomo-cli
-
-# 安装依赖
-npm install
-
-# 运行
-node index.js help
-
-# 检查代码
-npm run lint
-
-# 打包二进制
-npm run pkg
-```
-
 ## 许可证
 
 MIT License - 详见 [LICENSE](LICENSE) 文件。