clash-kit 1.0.1 → 1.0.3

package/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+node_modules
+.env
+dist
+
+.vscode
+.idea
+
+*.log
+
+clash-kit
+config.yaml
+profiles
+ruleset
+
+# clash 相关
+cache.db
+geoip.metadb
+m.yaml
+.current_profile

package/LICENSE.md

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

@@ -99,20 +99,9 @@ sudo ck tun on
 
 <img width="2742" height="1994" alt="image" src="https://github.com/user-attachments/assets/1183f778-62b0-4ac7-ab55-b821b66161f0" />
 
-## 目录结构
-
-- `bin/`: CLI 入口文件
-- `lib/`: 核心逻辑库
-- `profiles/`: 存放下载的订阅配置文件
-- `clash-meta`: Clash 核心二进制文件
-- `config.yaml`: 当前生效的配置文件
-
-## 注意事项
-
-- 本工具依赖 `clash-meta` 二进制文件，请确保其与本工具在同一目录下（安装包已包含）。
-- 测速功能依赖 Clash API，请确保 `clash start` 正在运行。
-- 默认 API 地址为 `http://127.0.0.1:9090`。
-
 ## License
 
-ISC
+[MIT](./LICENSE).
+
+开源不易，点赞鼓励！
+点一个 Star⭐️ 支持我们~ 🌸Let's enjoy it!

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/index.js

@@ -11,14 +11,14 @@ const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
 // ---------------- 1. 配置项 ----------------
-const CLASH_BIN_PATH = path.join(__dirname, 'clash-meta') // 解压后的二进制文件路径
+const CLASH_BIN_PATH = path.join(__dirname, 'clash-kit') // 解压后的二进制文件路径
 const CLASH_CONFIG_PATH = path.join(__dirname, 'config.yaml') // 配置文件路径
 
 // ---------------- 2. 启动 Clash.Meta 进程 ----------------
 function startClash() {
   // 尝试停止已存在的进程
   try {
-    execSync('pkill -f clash-meta')
+    execSync('pkill -f clash-kit')
   } catch (e) {
     // 忽略错误，说明没有运行中的进程
   }
@@ -65,7 +65,7 @@ async function cleanup() {
 
     // 停止 Clash 进程
     try {
-      execSync('pkill -f clash-meta')
+      execSync('pkill -f clash-kit')
       console.log('Clash 服务已停止')
     } catch (e) {
       // 进程可能已经停止
@@ -101,7 +101,7 @@ function setupExitHandlers() {
 
 // ---------------- 5. 执行流程 ----------------
 export function main() {
-  // 检查 clash-meta 二进制文件是否存在
+  // 检查 clash-kit 二进制文件是否存在
   if (!fs.existsSync(CLASH_BIN_PATH)) {
     return console.error(chalk.red('\n找不到 Clash.Meta 内核文件,请先运行 clash init 命令初始化内核！\n'))
   }
@@ -118,7 +118,7 @@ export function main() {
 
   console.log(chalk.green('\n代理服务已在后台启动✅'))
   if (clashProcess.pid) {
-    console.log(`PID: ${chalk.yellow(clashProcess.pid)}`)
+    console.log(`进程名称：${chalk.yellow('clash-kit')} PID: ${chalk.yellow(clashProcess.pid)}`)
   }
 
   console.log(``)
@@ -126,7 +126,13 @@ export function main() {
   console.log(`SOCKS5 Proxy: ${chalk.cyan(`127.0.0.1:${socks}`)}`)
   console.log(`API:          ${chalk.cyan.underline(getApiBase())}`)
   console.log(``)
-  console.log(chalk.gray('提示: 如需停止代理可使用 clash stop 命令'))
+
+  console.log(chalk.gray('运行日志文件: ' + path.join(__dirname, 'clash.log')))
+  console.log(chalk.blue('提示：如需查看运行状态可使用 clash status 命令'))
+  console.log(chalk.blue('如需停止代理可使用 clash stop 命令'))
+  console.log(chalk.gray('----------------------------------------'))
+  console.log(chalk.gray('如需切换系统代理模式可使用 clash sysproxy on/off 命令'))
+  console.log(chalk.gray('如需切换 TUN 模式可使用 clash tun on/off 命令'))
 }
 
 // 运行脚本

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,25 +2,94 @@ 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, '../..')
-  const binName = process.platform === 'win32' ? 'clash-meta.exe' : 'clash-meta'
+  const binName = process.platform === 'win32' ? 'clash-kit.exe' : 'clash-kit'
   const binPath = path.join(rootDir, binName)
   const configPath = path.join(rootDir, 'config.yaml')
 
   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/stop.js

@@ -17,9 +17,9 @@ export async function stop() {
       console.log('TUN 模式已关闭')
     }
 
-    // 使用 pkill 匹配进程名包含 clash-meta 的进程
+    // 使用 pkill 匹配进程名包含 clash-kit 的进程
     spinner.text = '正在停止 Clash 服务...'
-    execSync('pkill -f clash-meta')
+    execSync('pkill -f clash-kit')
     spinner.succeed('Clash 服务已停止')
   } catch (err) {
     // pkill 如果没找到进程会抛出错误，这里捕获并提示

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/kernel.js

@@ -52,7 +52,7 @@ export async function downloadClash(targetDir) {
   const downloadUrl = `https://github.com/MetaCubeX/mihomo/releases/download/${version}/${name}-${version}.${urlExt}`
   const tempFileName = `mihomo-temp.${urlExt}`
   const tempPath = path.join(targetDir, tempFileName)
-  const targetBinName = `clash-meta${isWin ? '.exe' : ''}`
+  const targetBinName = `clash-kit${isWin ? '.exe' : ''}`
   const targetBinPath = path.join(targetDir, targetBinName)
 
   // 3. 下载文件

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/lib/tun.js

@@ -8,7 +8,7 @@ import { reloadConfig } from './api.js'
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 const CONFIG_PATH = path.join(__dirname, '../config.yaml')
-const BIN_PATH = path.join(__dirname, '../clash-meta')
+const BIN_PATH = path.join(__dirname, '../clash-kit')
 
 export function checkTunPermissions() {
   if (process.platform === 'win32') return true // Windows 需要管理员权限终端，难以通过文件属性判断

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clash-kit",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "module",
   "description": "A command-line interface for managing Clash configurations, subscriptions, and proxies.",
   "bin": {
@@ -10,7 +10,11 @@
   "files": [
     "bin",
     "lib",
+    ".gitignore",
+    "default.yaml",
+    "country.mmdb",
     "index.js",
+    "LICENSE.md",
     "package.json",
     "README.md"
   ],