clash-kit 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,6 @@
-# Clash CLI
+# Clash Kit
+
+<img width="800" alt="clash-kit" src="https://github.com/user-attachments/assets/dd7dfd29-f59a-418b-8623-6ab08ece9ddb" />
 
 一个基于 Node.js 的 Clash 命令行管理工具，旨在简化 Clash 的配置管理、订阅切换和节点测速等操作。
 
@@ -12,7 +14,7 @@
 - 🛠 **自动初始化**：自动处理二进制文件权限问题。
 
 - 💻 **系统代理**：一键开启/关闭 macOS 系统 HTTP 代理。
-- 🛡 **TUN 模式**：高级网络模式，接管系统所有流量（类 VPN 体验）。
+- 🛡 **TUN 模式**：高级网络模式，接管系统所有流量（真 · 全局代理）。
 
 ## 使用
 
@@ -30,6 +32,8 @@ pnpm add -g clash-kit
 
 ```bash
 clash init
+# 推荐用简化命令（文档后续均以简化命令为例）
+ck init
 ```
 
 ### 3. 启动服务
@@ -38,58 +42,62 @@ clash init
 
 ```bash
 # 启动 Clash 代理服务
-clash start
+ck start
 
 # 启动并自动开启系统代理
-clash start -s
+ck start -s
 ```
 
 ### 4. 添加订阅
 
 ```bash
-# 交互式管理订阅（添加、切换、删除等）
-clash sub
+# 交互式管理订阅（添加、切换、删除等）【推荐使用这种方式来管理订阅】
+ck sub
 
 # 手动添加订阅
-clash sub -a "https://example.com/subscribe?token=xxx" -n "abcName"
+ck sub -a "https://example.com/subscribe?token=xxx" -n "abcName"
 ```
 
 ### 4. 节点测速与切换
 
 ```bash
 # 测速
-clash test
+ck test
 
 # 切换节点
-clash proxy
+ck proxy
 ```
 
 ### 5. 更多功能
 
 ```bash
 # 查看状态
-clash status
+ck status
 
 # 开启 TUN 模式 (需要 sudo 权限)
-sudo clash tun on
+sudo ck tun on
 ```
 
 ## 命令详解
 
-| 命令                  | 说明                       | 示例                                  |
-| --------------------- | -------------------------- | ------------------------------------- |
-| `clash init`          | 初始化内核及权限           | `clash init`                          |
-| `clash start`         | 启动 Clash 服务            | `clash start -s` (启动并设置系统代理) |
-| `clash stop`          | 停止服务并关闭代理         | `clash stop`                          |
-| `clash status`        | 查看运行状态及当前节点延迟 | `clash status`                        |
-| `clash sub`(推荐)     | 管理订阅（交互式）         | `clash sub`                           |
-| `clash sub -a <url>`  | 添加订阅                   | `clash sub -a "http..." -n "pro"`     |
-| `clash sub -u <name>` | 切换订阅                   | `clash sub -u "pro"`                  |
-| `clash sub -l`        | 列出所有订阅               | `clash sub -l`                        |
-| `clash proxy`         | 切换节点（交互式）         | `clash proxy`                         |
-| `clash test`          | 节点并发测速               | `clash test`                          |
-| `clash sysproxy`      | 设置系统代理 (on/off)      | `clash sysproxy on`                   |
-| `clash tun`           | 设置 TUN 模式 (on/off)     | `sudo clash tun on`                   |
+| 命令 (别名)           | 说明                       | 示例                            |
+| --------------------- | -------------------------- | ------------------------------- |
+| `ck init` (`i`)       | 初始化内核及权限           | `ck i`                          |
+| `ck start` (`on`)     | 启动 Clash 服务            | `ck on -s` (启动并设置系统代理) |
+| `ck stop` (`off`)     | 停止服务并关闭代理         | `ck off`                        |
+| `ck status` (`st`)    | 查看运行状态及当前节点延迟 | `ck st`                         |
+| `ck sub` (`s`)        | 管理订阅（交互式）         | `ck s`                          |
+| `ck sub -a <url>`     | 添加订阅                   | `ck s -a "http..." -n "pro"`    |
+| `ck sub -u <name>`    | 切换订阅                   | `ck s -u "pro"`                 |
+| `ck sub -l`           | 列出所有订阅               | `ck s -l`                       |
+| `ck proxy` (`p`)      | 切换节点（交互式）         | `ck p`                          |
+| `ck test` (`t`)       | 节点并发测速               | `ck t`                          |
+| `ck sysproxy` (`sys`) | 设置系统代理 (on/off)      | `ck sys on`                     |
+| `ck tun`              | 设置 TUN 模式 (on/off)     | `sudo ck tun on`                |
+
+## 截图
+
+<img width="2742" height="1994" alt="image" src="https://github.com/user-attachments/assets/1183f778-62b0-4ac7-ab55-b821b66161f0" />
 
 ## 目录结构
 

package/bin/index.js

@@ -13,7 +13,7 @@ import { test } from '../lib/commands/test.js'
 
 const program = new Command()
 
-program.name('clash').description('Clash CLI 管理工具').version('1.0.0')
+program.name('clash').alias('ck').description('Clash CLI 管理工具 (Alias: ck)').version('1.0.0')
 
 // 初始化 clash 内核
 program
@@ -29,13 +29,18 @@ program.command('start').description('启动 Clash 服务').option('-s, --syspro
 program.command('stop').description('停止 Clash 服务').action(stop)
 
 // 设置系统代理
-program.command('sysproxy').description('设置系统代理').argument('[action]', 'on 或 off').action(setSysProxy)
+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('status').description('查看 Clash 运行状态').action(status)
+program.command('status').alias('st').description('查看 Clash 运行状态').action(status)
 
 // 管理订阅
 program
@@ -48,9 +53,9 @@ program
   .action(manageSub)
 
 // 切换节点
-program.command('proxy').description('切换节点').action(proxy)
+program.command('proxy').alias('p').description('切换节点').action(proxy)
 
 // 节点测速
-program.command('test').description('节点测速').action(test)
+program.command('test').alias('t').description('节点测速').action(test)
 
 program.parse(process.argv)

package/default.yaml

@@ -0,0 +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

package/lib/api.js

@@ -104,3 +104,13 @@ export async function reloadConfig(configPath) {
     throw new Error(`重载配置失败: ${err.message}`)
   }
 }
+
+export async function isClashRunning() {
+  try {
+    // 使用较短的超时时间快速检查
+    await axios.get(`${getApiBase()}/version`, { timeout: 200 })
+    return true
+  } catch (err) {
+    return false
+  }
+}

package/lib/commands/init.js

@@ -2,12 +2,57 @@ import path from 'path'
 import fs from 'fs'
 import { fileURLToPath } from 'url'
 import { downloadClash } from '../kernel.js'
+import axios from 'axios'
+import ora from 'ora'
+import chalk from 'chalk'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
-const DEFAULT_CONFIG = `mixed-port: 7890
-`
+const DEFAULT_CONFIG = `mixed-port: 7890\n`
+
+const RESOURCES = [
+  {
+    filename: 'country.mmdb',
+    url: 'https://github.com/MetaCubeX/meta-rules-dat/releases/download/latest/country-lite.mmdb',
+  },
+  // {
+  //   filename: 'geoip.metadb',
+  //   url: 'https://github.com/MetaCubeX/meta-rules-dat/releases/download/latest/geoip.metadb',
+  // },
+  // {
+  //   filename: 'geosite.dat',
+  //   url: 'https://github.com/MetaCubeX/meta-rules-dat/releases/download/latest/geosite.dat',
+  // },
+  // {
+  //   filename: 'geoip.dat',
+  //   url: 'https://github.com/MetaCubeX/meta-rules-dat/releases/download/latest/geoip.dat',
+  // },
+  // {
+  //   filename: 'ASN.mmdb',
+  //   url: 'https://github.com/MetaCubeX/meta-rules-dat/releases/download/latest/GeoLite2-ASN.mmdb',
+  // },
+]
+
+async function downloadResource(resource, targetDir) {
+  const filePath = path.join(targetDir, resource.filename)
+  const spinner = ora(`正在下载 ${resource.filename}...`).start()
+
+  try {
+    const response = await axios({
+      url: resource.url,
+      method: 'GET',
+      responseType: 'arraybuffer',
+      timeout: 30 * 1000, // 30s timeout
+    })
+    fs.writeFileSync(filePath, response.data)
+    spinner.succeed(`${resource.filename} 下载完成`)
+  } catch (e) {
+    spinner.fail(`${resource.filename} 下载失败: ${e.message}`)
+    // 不要抛出错误，让其他资源继续下载
+    // throw e
+  }
+}
 
 export async function init(options) {
   const rootDir = path.join(__dirname, '../..')
@@ -18,9 +63,33 @@ export async function init(options) {
   try {
     // 创建默认配置文件（如果不存在）
     if (!fs.existsSync(configPath)) {
-      fs.writeFileSync(configPath, DEFAULT_CONFIG, 'utf8')
-      console.log(`已创建默认配置文件: ${configPath}`)
+      const defaultConfigPath = path.join(rootDir, 'default.yaml')
+      if (fs.existsSync(defaultConfigPath)) {
+        fs.copyFileSync(defaultConfigPath, configPath)
+        console.log(`已从 default.yaml 创建配置文件: ${configPath}`)
+      } else {
+        console.warn(chalk.yellow('警告: 未找到 default.yaml，将创建最小配置文件'))
+        fs.writeFileSync(configPath, DEFAULT_CONFIG, 'utf8')
+      }
+    }
+
+    // 检查并下载资源文件
+    console.log(chalk.blue('\n正在检查资源文件...'))
+    for (const resource of RESOURCES) {
+      const filePath = path.join(rootDir, resource.filename)
+      if (options.force && fs.existsSync(filePath)) {
+        try {
+          fs.unlinkSync(filePath)
+        } catch (e) {}
+      }
+
+      if (!fs.existsSync(filePath)) {
+        await downloadResource(resource, rootDir)
+      } else {
+        console.log(chalk.gray(`资源 ${resource.filename} 已存在`))
+      }
     }
+    console.log(chalk.green('资源检查完成\n'))
 
     if (fs.existsSync(binPath) && !options.force) {
       console.log(`Clash 内核已存在: ${binPath}`)

package/lib/commands/sub.js

@@ -23,10 +23,7 @@ async function handleAddSubscription(url, name) {
 
 export async function manageSub(options) {
   if (options.add) {
-    if (!options.name) {
-      console.error('错误: 添加订阅时必须指定名称 (-n)')
-      return
-    }
+    if (!options.name) return console.error('错误: 添加订阅时必须指定名称 (-n)')
     try {
       await handleAddSubscription(options.add, options.name)
     } catch (err) {
@@ -34,7 +31,7 @@ export async function manageSub(options) {
     }
   } else if (options.list) {
     const profiles = sub.listProfiles()
-    console.log('可用订阅:')
+    console.log(`${profiles.length ? '已添加的订阅:' : '暂无已添加的订阅'}`)
     profiles.forEach(p => console.log(`- ${p}`))
   } else if (options.use) {
     try {

package/lib/subscription.js

@@ -3,7 +3,7 @@ import path from 'path'
 import axios from 'axios'
 import { fileURLToPath } from 'url'
 import ora from 'ora'
-import { reloadConfig } from './api.js'
+import { reloadConfig, isClashRunning } from './api.js'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -47,9 +47,7 @@ export function getCurrentProfile() {
 
 export async function useProfile(name) {
   const source = path.join(PROFILES_DIR, `${name}.yaml`)
-  if (!fs.existsSync(source)) {
-    throw new Error(`配置文件 ${name} 不存在`)
-  }
+  if (!fs.existsSync(source)) throw new Error(`配置文件 ${name} 不存在`)
 
   const spinner = ora(`正在切换到配置 ${name}...`).start()
 
@@ -58,11 +56,14 @@ export async function useProfile(name) {
   fs.writeFileSync(CURRENT_PROFILE_PATH, name)
 
   // 尝试热重载
-  try {
-    await reloadConfig(CONFIG_PATH)
-    spinner.succeed('Clash 配置已切换并热重载生效')
-  } catch (err) {
-    // 忽略错误，可能是 Clash 未运行
-    spinner.warn('配置已切换，但 Clash 未运行或无法连接，将在下次启动时生效')
+  if (await isClashRunning()) {
+    try {
+      await reloadConfig(CONFIG_PATH)
+      spinner.succeed('Clash 配置已切换并热重载生效')
+    } catch (err) {
+      spinner.warn(`配置已切换，但热重载失败: ${err.message}`)
+    }
+  } else {
+    spinner.succeed('配置已切换（Clash 未运行，将在下次启动时生效）')
   }
 }

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "clash-kit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "A command-line interface for managing Clash configurations, subscriptions, and proxies.",
   "bin": {
+    "ck": "./bin/index.js",
     "clash": "./bin/index.js"
   },
   "files": [
     "bin",
     "lib",
     "index.js",
+    "country.mmdb",
+    "default.yaml",
     "package.json",
     "README.md"
   ],