clash-kit 1.1.1 → 1.1.5

package/.gitignore

@@ -1,21 +1,30 @@
-.DS_Store
-node_modules
-.env
-dist
-
-.vscode
-.idea
-
-*.log
-
-clash-kit
-clash-kit.exe
-config.yaml
-profiles
-ruleset
-
-# clash 相关
-cache.db
-geoip.metadb
-m.yaml
-.current_profile
+.DS_Store
+node_modules
+.env
+dist
+
+.vscode
+.idea
+
+*.log
+
+clash-kit
+clash-kit.exe
+config.yaml
+profiles
+ruleset
+
+# clash 相关
+cache.db
+geoip.metadb
+m.yaml
+.current_profile
+dns-helper
+
+# brew packages
+clash-kit-*
+
+# ai coding
+.agents
+.github
+.gemini

package/LICENSE.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2020-present, 荣顶 and wechat-bot contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+MIT License
+
+Copyright (c) 2020-present, 荣顶 and wechat-bot contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,126 +1,159 @@
-# Clash Kit
-
-一个基于 Node.js 的 Clash 命令行管理工具，旨在简化 Clash 的配置管理、订阅切换和节点测速等操作。
-
-目前已兼容 Windows，MacOs，Linux。
-
-## 截图
-
-<img width="1920" alt="image" src="https://github.com/user-attachments/assets/1183f778-62b0-4ac7-ab55-b821b66161f0" />
-
-## 特性
-
-- 🔄 **订阅管理**：支持添加、切换多个订阅源。
-- 🌐 **节点切换**：交互式选择并切换当前使用的代理节点。
-- 🔥 **热重载**：切换订阅后立即生效，无需重启服务。
-- ⚡ **节点测速**：支持多线程并发测速，彩色高亮显示延迟结果。
-- 📊 **状态监控**：实时查看服务运行状态、当前节点及延迟。
-- 🛠 **自动初始化**：自动处理二进制文件权限问题。
-
-- 💻 **系统代理**：一键开启/关闭 macOS 系统 HTTP 代理。
-- 🛡 **TUN 模式**：高级网络模式，接管系统所有流量（真 · 全局代理）。
-
-## 使用
-
-### 1. 安装
-
-```bash
-npm install -g clash-kit
-# 或者
-pnpm add -g clash-kit
-```
-
-### 2. 初始化
-
-首次安装后，需要先初始化 Clash 内核与权限：
-
-```bash
-clash init
-# 推荐用简化命令（文档后续均以简化命令为例）
-ck init
-```
-
-### 3. 添加订阅
-
-```bash
-# 交互式管理订阅（添加、切换、删除等）【推荐使用这种方式来管理订阅】
-ck sub
-
-# 列出所有订阅
-ck sub -l
-
-# 手动添加订阅
-ck sub -a "https://example.com/subscribe?token=xxx" -n "abcName"
-```
-
-### 4. 启动服务
-
-启动 Clash 核心服务（建议在一个单独的终端窗口运行）：
-
-```bash
-# 启动 Clash 代理服务
-ck on # 或者 ck start
-
-# 启动并自动开启系统代理
-ck on -s
-# 启动并自动开启 TUN 模式(全局代理, 需要 sudo 权限)
-ck on -t
-
-# 关闭服务并关闭系统代理
-ck off # 或者 ck stop
-```
-
-### 4. 节点切换（自动测速）
-
-进入交互式界面，自动对当前节点组进行并发测速，并展示带有即时延迟数据的节点列表供选择。
-
-```bash
-# 切换节点 (支持别名: node, proxy, switch)
-ck use
-# 或者
-ck switch
-# 或者
-ck node
-```
-
-### 5. 更多功能
-
-```bash
-# 查看状态
-ck info # 或者 ck status, ck view
-
-# 节点并发测速 (仅测速不切换，支持别名: test, ls, t)
-ck list # 或者 ck test, ck ls
-
-# 设置系统代理
-ck sys on
-ck sys off
-
-# 开启 TUN 模式 (需要 sudo 权限)
-ck tun on # 开启
-ck tun off # 关闭
-```
-
-## 命令详解
-
-| 命令 (别名)                   | 说明                       | 示例                                                                     |
-| ----------------------------- | -------------------------- | ------------------------------------------------------------------------ |
-| `ck init`                     | 初始化内核及权限           | `ck init`                                                                |
-| `ck on` (`start`)             | 启动 Clash 服务            | `ck on` `ck on -s` (启动并设置系统代理) `ck on -t` (启动并开启 TUN 模式) |
-| `ck off` (`stop`)             | 停止服务并关闭代理         | `ck off`                                                                 |
-| `ck info` (`status`, `view`)  | 查看运行状态及当前节点延迟 | `ck info` / `ck status` / `ck view`                                      |
-| `ck sysproxy` (`sys`)         | 设置系统代理               | `ck sys on` / `ck sys off`                                               |
-| `ck tun`                      | 设置 TUN 模式 (需要 sudo)  | `ck tun on`                                                              |
-| `ck sub`                      | 管理订阅（交互式）【推荐】 | `ck sub`                                                                 |
-| `ck sub -l`                   | 列出所有订阅               | `ck sub -l`                                                              |
-| `ck sub -a <url>`             | 添加订阅                   | `ck sub -a "http..." -n "pro"`                                           |
-| `ck sub -u <name>`            | 切换订阅                   | `ck sub -u "pro"`                                                        |
-| `ck use` (`node`, `switch`)   | 切换节点 (自动测速)        | `ck use` / `ck node`                                                     |
-| `ck list` (`ls`, `test`, `t`) | 节点测速列表 (不切换)      | `ck list` / `ck test`                                                    |
-
-## License
-
-[MIT](./LICENSE).
-
-开源不易，点赞鼓励！
-点一个 Star⭐️ 支持我们~ 🌸Let's enjoy it!
+# Clash Kit
+
+<a target="_blank" href="https://github.com/wangrongding/clash-kit"><img src="https://img.shields.io/github/stars/wangrongding/clash-kit" alt="GitHub stars" /></a>
+<a target="_blank" href="https://www.npmjs.com/package/clash-kit"><img src="https://img.shields.io/npm/dt/clash-kit?style=flat&label=downloads&color=cb3837&labelColor=cb0000&logo=npm" alt="npm downloads"/></a>
+
+一个基于 Node.js 的 Clash 命令行管理工具，旨在简化 Clash 的配置管理、订阅切换和节点测速等操作。
+
+目前已兼容 Windows，MacOs，Linux。
+
+<img width="604" height="315" alt="image" src="https://github.com/user-attachments/assets/7c97ef51-5a95-4612-aa43-ce66423d7560" />
+
+## 特性
+
+- 🔄 **订阅管理**：支持添加、切换、修改、删除多个订阅源。
+- 🌐 **节点切换**：交互式选择并切换当前使用的代理节点。
+- 🔥 **热重载**：切换订阅/开关 TUN 后立即生效，无需重启服务。
+- ⚡ **节点测速**：支持多线程并发测速，彩色高亮显示延迟结果。
+- 📊 **状态监控**：实时查看服务运行状态、当前节点及延迟。
+- 🛠 **自动初始化**：自动处理二进制文件权限问题。
+
+- 💻 **系统代理**：一键开启/关闭 macOS 系统 HTTP 代理。
+- 🛡 **TUN 模式**：高级网络模式，接管系统所有流量（真 · 全局代理）。
+
+## 安装
+
+- 支持通过 npm 或其它任意包管理器全局安装：
+
+```bash
+npm install -g clash-kit
+# 或者
+pnpm add -g clash-kit
+# 或者
+yarn global add clash-kit
+```
+
+- 也支持通过 Homebrew 安装：
+
+```bash
+# 1. 先通过 brew tap 添加仓库
+brew tap wangrongding/clash-kit https://github.com/wangrongding/clash-kit
+# 2. 安装 clash-kit
+brew install clash-kit
+```
+
+## 使用
+
+### 1. 初始化
+
+首次安装后，需要先初始化 Clash 内核与权限：
+
+```bash
+# 推荐用简化命令（文档后续均以简化命令为例）
+ck init # 或者 clash init
+```
+
+### 3. 管理订阅
+
+```bash
+# 交互式管理订阅（添加、切换、修改、删除）【推荐】
+ck sub
+
+# 列出所有订阅
+ck sub -l
+
+# 手动添加订阅（-n 名称，-a 链接）
+ck sub -n "test123" -a "https://example.com/subscribe?token=xxx"
+
+# 手动切换订阅
+ck sub -u "test123"
+```
+
+交互式模式 (`ck sub`) 提供以下操作：
+
+| 操作     | 说明                                       |
+| -------- | ------------------------------------------ |
+| 切换订阅 | 从现有订阅中选择并立即生效（热重载）       |
+| 添加订阅 | 依次输入名称和链接，完成下载               |
+| 修改订阅 | 重命名 和/或 更换订阅链接（均可留空跳过）  |
+| 删除订阅 | 选择后需二次确认，若删除当前订阅会自动解绑 |
+
+### 4. 启动服务
+
+启动 Clash 核心服务（建议在一个单独的终端窗口运行）：
+
+```bash
+# 启动 Clash 代理服务
+ck on # 或者 ck start
+
+# 启动并自动开启系统代理
+ck on -s
+# 启动并自动开启 TUN 模式(全局代理, 需要 sudo 权限)
+ck on -t
+```
+
+### 5. 关闭服务 或 重新启动服务
+
+```bash
+# 关闭服务
+ck off # 或者 ck stop
+
+# 重新启动服务
+ck rs # 或者 ck restart
+```
+
+### 6. 节点切换（自动测速）
+
+进入交互式界面，自动对当前节点组进行并发测速，并展示带有即时延迟数据的节点列表供选择。
+
+```bash
+# 切换节点 (支持别名: node, proxy, switch)
+ck use
+```
+
+### 7. 更多功能
+
+```bash
+# 查看状态
+ck info # 或者 ck status, ck view
+
+# 节点并发测速 (仅测速不切换，支持别名: test, ls, t)
+ck ls # 或者 ck list，ck test，ck t
+
+# 设置系统代理
+ck sys on
+ck sys off
+
+# 开启 TUN 模式 (需要 sudo 权限)
+ck tun on # 开启
+ck tun off # 关闭
+```
+
+## 命令详解
+
+| 命令 (别名)                   | 说明                       | 示例                                                                     |
+| ----------------------------- | -------------------------- | ------------------------------------------------------------------------ |
+| `ck init`                     | 初始化内核及权限           | `ck init`                                                                |
+| `ck on` (`start`)             | 启动 Clash 服务            | `ck on` `ck on -s` (启动并设置系统代理) `ck on -t` (启动并开启 TUN 模式) |
+| `ck off` (`stop`)             | 停止服务并关闭代理         | `ck off`                                                                 |
+| `ck rs` (`restart`)           | 重启 Clash 服务            | `ck rs` `ck rs -s` (重启并设置系统代理) `ck rs -t` (重启并开启 TUN 模式) |
+| `ck info` (`status`, `view`)  | 查看运行状态及当前节点延迟 | `ck info` / `ck status` / `ck view`                                      |
+| `ck sysproxy` (`sys`)         | 设置系统代理               | `ck sys on` / `ck sys off`                                               |
+| `ck tun`                      | 设置 TUN 模式 (需要 sudo)  | `ck tun on` / `ck tun off`                                               |
+| `ck sub`                      | 管理订阅（交互式）【推荐】 | `ck sub`                                                                 |
+| `ck sub -l`                   | 列出所有订阅               | `ck sub -l`                                                              |
+| `ck sub -n <name> -a <url>`   | 添加订阅                   | `ck sub -n "pro" -a "http..."`                                           |
+| `ck sub -u <name>`            | 切换订阅                   | `ck sub -u "pro"`                                                        |
+| `ck use` (`node`, `switch`)   | 切换节点 (自动测速)        | `ck use` / `ck node`                                                     |
+| `ck list` (`ls`, `test`, `t`) | 节点测速列表 (不切换)      | `ck list` / `ck test`                                                    |
+
+## 截图
+
+<img width="1920" alt="image" src="https://github.com/user-attachments/assets/1183f778-62b0-4ac7-ab55-b821b66161f0" />
+
+## License
+
+[MIT](./LICENSE).
+
+开源不易，点赞鼓励！
+点一个 Star⭐️ 支持我们~ 🌸Let's enjoy it!

package/bin/index.js

@@ -1,86 +1,114 @@
 #!/usr/bin/env node
-
-import { Command } from 'commander'
-import { createRequire } from 'module'
-import { init } from '../lib/commands/init.js'
-import { start } from '../lib/commands/start.js'
-import { stop } from '../lib/commands/stop.js'
-import { setSysProxy } from '../lib/commands/sysproxy.js'
-import { setTun } from '../lib/commands/tun.js'
-import { status } from '../lib/commands/status.js'
-import { manageSub } from '../lib/commands/sub.js'
-import { proxy } from '../lib/commands/proxy.js'
-import { test } from '../lib/commands/test.js'
-
-const require = createRequire(import.meta.url)
-const pkg = require('../package.json')
-
-const program = new Command()
-
-program.name('clash').alias('ck').description('Clash CLI 管理工具 (Alias: ck)').version(pkg.version, '-v, --version')
-
-// 初始化 clash 内核
-program
-  .command('init')
-  .description('初始化 Clash 内核 (下载、解压并设置权限)')
-  .option('-f, --force', '强制重新下载内核')
-  .action(init)
-
-// 启动 clash 服务
-program
-  .command('on')
-  .alias('start')
-  .description('启动 Clash 服务, -s 自动开启系统代理, -t 自动开启 TUN 模式(全局代理)')
-  .option('-s, --sysproxy', '启动后自动开启系统代理')
-  .option('-t, --tun', '启动后自动开启 TUN 模式')
-  .action(start)
-
-// 停止 clash 服务
-program.command('off').alias('stop').description('停止 Clash 服务').action(stop)
-
-// 设置系统代理
-program
-  .command('sysproxy')
-  .alias('sys')
-  .description('设置系统代理')
-  .argument('[action]', 'on 或 off')
-  .action(setSysProxy)
-
-// 设置 TUN 模式（真正的全局代理，所有流量都会被代理）
-program.command('tun').description('设置 TUN 模式 (可能需要提权)').argument('[action]', 'on 或 off').action(setTun)
-
-// 查看 clash 状态
-program.command('info').alias('status').alias('view').description('查看 Clash 运行状态').action(status)
-
-// 管理订阅
-program
-  .command('sub')
-  .description('管理订阅')
-  .option('-a, --add <url>', '添加订阅链接')
-  .option('-n, --name <name>', '订阅名称')
-  .option('-l, --list', '列出所有订阅')
-  .option('-u, --use <name>', '切换使用的订阅')
-  .action(manageSub)
-
-// 切换节点
-program
-  .command('use')
-  .aliases(['node', 'proxy', 'switch'])
-  .description('切换节点 (别名: node, proxy, switch)')
-  .action(proxy)
-
-// 列出所有节点，并测速
-program
-  .command('list')
-  .alias('ls')
-  .alias('test')
-  .alias('t')
-  .description('节点测速 (别名: list, ls, test, t) ')
-  .action(test)
-
-// Support -V for version
-if (process.argv.includes('-V')) {
-  process.argv[process.argv.indexOf('-V')] = '-v'
-}
-
-program.parse(process.argv)
+
+import { Command } from 'commander'
+import { createRequire } from 'module'
+import { init } from '../lib/commands/init.js'
+import { start } from '../lib/commands/start.js'
+import { restart } from '../lib/commands/restart.js'
+import { stop } from '../lib/commands/stop.js'
+import { setSysProxy } from '../lib/commands/sysproxy.js'
+import { setTun } from '../lib/commands/tun.js'
+import { status } from '../lib/commands/status.js'
+import { manageSub } from '../lib/commands/sub.js'
+import { proxy } from '../lib/commands/proxy.js'
+import { test } from '../lib/commands/test.js'
+import updateNotifier from 'update-notifier'
+
+const require = createRequire(import.meta.url)
+const pkg = require('../package.json')
+
+updateNotifier({
+  pkg: pkg,
+  updateCheckInterval: 1000 * 60 * 60 * 24, // 检查更新间隔，1 day
+  shouldNotifyInNpmScript: true,
+}).notify({
+  isGlobal: true,
+  boxenOptions: {
+    title: '有新版本的 Clash Kit 可用',
+    padding: 1,
+    margin: 1,
+    align: 'center',
+    borderColor: 'yellowBright',
+    borderStyle: 'round',
+  },
+})
+const program = new Command()
+
+program.name('clash').alias('ck').description('Clash CLI 管理工具 (Alias: ck)').version(pkg.version, '-v, --version')
+
+// 初始化 clash 内核
+program
+  .command('init')
+  .description('初始化 Clash 内核 (下载、解压并设置权限)')
+  .option('-f, --force', '强制重新下载内核')
+  .action(init)
+
+// 启动 clash 服务
+program
+  .command('on')
+  .alias('start')
+  .description('启动 Clash 服务, -s 自动开启系统代理, -t 自动开启 TUN 模式(全局代理)')
+  .option('-s, --sysproxy', '启动后自动开启系统代理')
+  .option('-t, --tun', '启动后自动开启 TUN 模式')
+  .action(start)
+
+// 停止 clash 服务
+program.command('off').alias('stop').description('停止 Clash 服务').action(stop)
+
+// 重启 clash 服务
+program
+  .command('restart')
+  .alias('re')
+  .alias('rs')
+  .description('重启 Clash 服务')
+  .option('-s, --sysproxy', '启动后自动开启系统代理')
+  .option('-t, --tun', '启动后自动开启 TUN 模式')
+  .action(restart)
+
+// 设置系统代理
+program
+  .command('sysproxy')
+  .alias('sys')
+  .description('设置系统代理')
+  .argument('[action]', 'on 或 off')
+  .action(setSysProxy)
+
+// 设置 TUN 模式（真正的全局代理，所有流量都会被代理）
+program.command('tun').description('设置 TUN 模式 (可能需要提权)').argument('[action]', 'on 或 off').action(setTun)
+
+// 查看 clash 状态
+program.command('info').alias('status').alias('view').description('查看 Clash 运行状态').action(status)
+
+// 管理订阅
+program
+  .command('sub')
+  .description('管理订阅')
+  .option('-a, --add <url>', '添加订阅链接')
+  .option('-n, --name <name>', '订阅名称')
+  .option('-l, --list', '列出所有订阅')
+  .option('-u, --use <name>', '切换使用的订阅')
+  .option('-d, --delete <name>', '删除订阅')
+  .action(manageSub)
+
+// 切换节点
+program
+  .command('use')
+  .aliases(['node', 'proxy', 'switch'])
+  .description('切换节点 (别名: node, proxy, switch)')
+  .action(proxy)
+
+// 列出所有节点，并测速
+program
+  .command('list')
+  .alias('ls')
+  .alias('test')
+  .alias('t')
+  .description('节点测速 (别名: list, ls, test, t) ')
+  .action(test)
+
+// Support -V for version
+if (process.argv.includes('-V')) {
+  process.argv[process.argv.indexOf('-V')] = '-v'
+}
+
+program.parse(process.argv)

package/default.yaml

@@ -1,46 +1,46 @@
-# HTTP 代理端口
-port: 7890
-# SOCKS5 代理端口
-socks-port: 7891
-# 允许局域网连接
-allow-lan: true
-
-# 规则模式：Rule（规则） / Global（全局）/ Direct（直连）
-mode: Rule
-# 日志级别：info / warning / error / debug / silent
-log-level: info
-# 外部控制接口（用于 Dashboard）
-external-controller: 127.0.0.1:9090
-
-# 代理节点定义 (示例)
-proxies:
-  # - name: "Shadowsocks 示例"
-  #   type: ss
-  #   server: server
-  #   port: 443
-  #   cipher: chacha20-ietf-poly1305
-  #   password: "password"
-
-  # - name: "Vmess 示例"
-  #   type: vmess
-  #   server: server
-  #   port: 443
-  #   uuid: uuid
-  #   alterId: 64
-  #   cipher: auto
-
-# 代理组定义
-proxy-groups:
-  - name: PROXY
-    type: select
-    proxies:
-      - DIRECT
-      # - "Shadowsocks 示例"
-
-# 规则定义
-rules:
-  - DOMAIN-SUFFIX,google.com,PROXY
-  - DOMAIN-KEYWORD,google,PROXY
-  - DOMAIN,google.com,PROXY
-  - GEOIP,CN,DIRECT
-  - MATCH,PROXY
+# HTTP 代理端口
+port: 7890
+# SOCKS5 代理端口
+socks-port: 7891
+# 允许局域网连接
+allow-lan: true
+
+# 规则模式：Rule（规则） / Global（全局）/ Direct（直连）
+mode: Rule
+# 日志级别：info / warning / error / debug / silent
+log-level: info
+# 外部控制接口（用于 Dashboard）
+external-controller: 127.0.0.1:9090
+
+# 代理节点定义 (示例)
+proxies:
+  # - name: "Shadowsocks 示例"
+  #   type: ss
+  #   server: server
+  #   port: 443
+  #   cipher: chacha20-ietf-poly1305
+  #   password: "password"
+
+  # - name: "Vmess 示例"
+  #   type: vmess
+  #   server: server
+  #   port: 443
+  #   uuid: uuid
+  #   alterId: 64
+  #   cipher: auto
+
+# 代理组定义
+proxy-groups:
+  - name: PROXY
+    type: select
+    proxies:
+      - DIRECT
+      # - "Shadowsocks 示例"
+
+# 规则定义
+rules:
+  - DOMAIN-SUFFIX,google.com,PROXY
+  - DOMAIN-KEYWORD,google,PROXY
+  - DOMAIN,google.com,PROXY
+  - GEOIP,CN,DIRECT
+  - MATCH,PROXY