kscript 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa60e97dd2e5ebd0282945488335f81226666cc547f74608eb5b6d04370eec69
-  data.tar.gz: 628577d54846ee750cf65e648bb13bce7c286182b49ef52813edb551b182a6f2
+  metadata.gz: a72c639d7028f3032a3ab8d6508308cd174a1174f698d5099f86356b1bef9f31
+  data.tar.gz: 898a2845e93a58bb1760a92850b091b84fcd374d92b138c13022e85dc6868877
 SHA512:
-  metadata.gz: 79c677939e03109beac01c935773433218d95b663f7a4fea56980d3e6dbfc652eaadec7ed37ce1da38e77089cd6ff7524631e46a7dda71744e3868d8badf1734
-  data.tar.gz: f29744a4e376a0476f91ee3a5788cd713f7a5c333114a3e4ef3616f5b3cb45783cceaca02b5798b2bf88c3038a28c50fe168d9e08c4700c31a5c3fd48376687c
+  metadata.gz: 869a3dfa24680f0c6e95cbdb82f0d8e6f981f5868d5f5c30b0183b7d2490b64ee2ce670e08190f095eea1291f26c31293e215759ee9545eab2a1d602b36a9bba
+  data.tar.gz: 5d24ef70c21851e42b337fd8e0222d50bb9f0def1e61a0121e2edaac8eb5fd16d4233adb8560e428eada8ee5e312a2c717f5ce30826c93891988861a38ee6260

data/README.md

@@ -1,4 +1,5 @@
 # kscript
+
 ```
 ______                     _____        _____
 ___  /________________________(_)_________  /_
@@ -8,20 +9,32 @@ _  ,<  _(__  )/ /__ _  /   _  / __  /_/ / /_
                                 /_/
 ```
 
-A collection of Ruby utility scripts for various system administration and development tasks.
+[![Gem Version](https://img.shields.io/gem/v/kscript?style=flat-square)](https://rubygems.org/gems/kscript)
+[![CI Status](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml/badge.svg?branch=main)](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml)
+
+> Ruby CLI 工具集，专为系统运维、开发自动化、网络与项目管理场景设计。支持插件化、极致美化输出、自动补全、结构化日志、CI/CD 自动发布等现代特性。
+
+---
 
-[![Gem Version](https://img.shields.io/gem/v/kscript)](https://rubygems.org/gems/kscript)
-[![Ruby](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml/badge.svg)](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml)
+## ✨ 特性亮点
+- **统一 CLI 框架**：所有命令一键调用，美化输出
+- **插件化架构**：业务命令即插件，易扩展、易维护
+- **极致美化**：ASCII banner、彩色分组、对齐、分隔线，极客体验
+- **人性化/结构化日志双模式**：`--log`/`--log-level` 切换，支持 JSON/终端友好输出
+- **自动补全**：zsh/bash 补全脚本自动部署，命令一键补全
+- **参数健壮**：所有插件兼容多余参数，支持全局参数过滤
+- **CI/CD 自动发布**：GitHub Actions 自动构建并推送 RubyGem
+- **多平台支持**：macOS、Linux、Windows（部分工具）
 
-## Installation
+---
 
-### Gem install (recommended)
+## 🚀 安装
 
 ```bash
 gem install kscript
 ```
 
-Or from local source:
+或源码安装：
 
 ```bash
 git clone https://github.com/kevin197011/kscript.git
@@ -30,140 +43,130 @@ gem build kscript.gemspec
 gem install ./kscript-*.gem
 ```
 
-### Bundler (for development)
-
-```bash
-git clone https://github.com/kevin197011/kscript.git
-cd kscript
-bundle install
-```
-
-## Usage
+---
 
-Most scripts can be executed directly via command line after gem install:
+## 🛠️ 快速上手
 
+### 查看所有命令
 ```bash
-kscript SCRIPT_NAME [args]
+kscript list
 ```
 
-Or, for legacy usage via curl:
-
+### 查看主命令帮助
 ```bash
-curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/SCRIPT_NAME.rb | ruby
+kscript help
 ```
 
-## Available Scripts
-
-### System Tools
-- `mac-top-usage.rb` - Display top CPU and memory usage processes on macOS
-- `port-scanner.rb` - Multi-threaded port scanner
-- `mouse-simulator.rb` - Simulate mouse movement to prevent system idle
-- `source-cleaner.rb` - Clean up old source code versions
-- `ffmpeg-installer.rb` - FFmpeg installation script for Linux systems
-
-### Network Tools
-- `ip-api.rb` - Query IP geolocation information (supports auto-detecting public IP)
-- `apnic-ip-range.rb` - Fetch IP ranges from APNIC database
-- `wireguard-acl.rb` - Configure WireGuard firewall access control
-- `wireguard-password.rb` - Generate WireGuard password hashes
-
-### Development Tools
-- `shell-helper.rb` - Quick shell command reference tool
-- `rename.rb` - Batch rename files using regular expressions
-- `jenkins-job-manager.rb` - Manage Jenkins jobs (export/import)
-- `kibana-utils.rb` - Kibana management utilities
-
-### Windows Specific
-- `windows-font-enhancer.rb` - Enhance Windows font rendering (macOS-like)
-
-### Infrastructure Tools
-- `elastic-cert-fingerprint.rb` - Generate Elasticsearch certificate fingerprints
-- `lvm-mounter.rb` - LVM volume creation and mounting utility
-
-## Examples
-
-1. Query IP geolocation:
+### 查看版本
 ```bash
-# Query specific IP
-curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/ip-api.rb | ruby 8.8.8.8
-
-# Query your public IP
-curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/ip-api.rb | ruby
+kscript version
 ```
 
-2. View system resource usage:
+### 执行插件命令
 ```bash
-curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/mac-top-usage.rb | ruby
+kscript <command> [args...]
+# 例如
+kscript apnic CN
+kscript portscan 192.168.1.1
+kscript sh 'ls -l'
+kscript projscan ~/projects
 ```
 
-3. Scan ports:
+### 结构化日志模式
 ```bash
-curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/port-scanner.rb | ruby
+kscript apnic CN --log
+kscript portscan 192.168.1.1 --log-level=debug
 ```
 
-## Dependencies
+---
+
+## 🧩 插件与命令一览
+
+> 运行 `kscript list` 可分组美化展示所有插件命令
+
+- **network**
+  - `apnic`：获取国家 IPv4 段
+  - `portscan`：端口扫描
+  - `ip`：IP 工具
+  - `wg_acl`：WireGuard 防火墙 ACL
+  - `wg_pass`：WireGuard 密码工具
+- **project**
+  - `projscan`：扫描目录下所有 git 项目
+  - `cleaner`：源码多版本清理
+  - `rename`：批量重命名文件
+- **system/macos**
+  - `syscheck`：macOS 系统健康检查
+  - `top`：macOS 资源占用排行
+  - `optimize`：macOS 性能优化
+  - `sh`：命令行速查/cheatsheet
+- **media**
+  - `ffmpeg`：FFmpeg 安装与检测
+- **elastic**
+  - `es_fingerprint`：Elasticsearch 证书指纹
+  - `kibana`：Kibana 空间/索引/用户/角色自动化
+- **ci**
+  - `jenkins`：Jenkins Job 导入导出
+- **其它**
+  - `usd`：美元汇率工具
+  - `lvm`：LVM 卷管理
+  - `windows_font_enhancer`：Windows 字体增强
+
+---
+
+## ⚡ Shell 自动补全
+
+- **首次运行自动为 zsh/bash 部署补全脚本**，无需手动操作
+- 补全脚本路径：
+  - zsh: `~/.zsh/completions/_kscript`
+  - bash: `~/.bash_completion.d/kscript`
+- 手动生成：
+  ```bash
+  kscript completion zsh > ~/.zsh/completions/_kscript
+  kscript completion bash > ~/.bash_completion.d/kscript
+  ```
+
+---
+
+## ⚙️ 全局配置
+
+在 `~/.kscriptrc` (YAML) 配置全局参数：
 
-Required gems:
-```ruby
-gem 'http'
-gem 'rubocop'
+```yaml
+log_level: debug
 ```
 
-## License
+---
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+## 🧑‍💻 插件开发规范
+- 插件文件统一放在 `lib/kscript/plugins/kk_xxx_utils.rb`
+- 类名如 `KkApnicUtils`，自动注册为 `apnic` 命令
+- 支持 `self.description`、`self.usage`、`self.arguments`、`self.group`、`self.author`
+- 输出统一用 `logger.kinfo`/`logger.kerror`，支持结构化日志
+- 兼容多余参数，避免 ArgumentError
 
-## Contributing
+---
 
-1. Fork it
-2. Create your feature branch (`git checkout -b feature/my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin feature/my-new-feature`)
-5. Create new Pull Request
+## 🚚 CI/CD 自动发布
 
-## Unified CLI Usage
+- `.github/workflows/gem-push.yml`：main 分支和 PR 自动构建、tag push 自动发布到 RubyGems
+- 需在 GitHub secrets 配置 `RUBYGEMS_API_KEY`
+- [CI 状态与历史](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml)
 
-After gem install, you can use the unified kk command:
+---
 
-```bash
-kk <command> [args...]
+## 📄 许可证
 
-# List all available tools
-kk --help
+MIT License. 详见 [LICENSE](LICENSE)。
 
-# Example: scan ports
-kk port-scanner 192.168.1.1
-
-# Example: check macOS system
-kk mac-sys-check
-```
+---
 
-Each subcommand supports --help for its own usage.
+## 🤝 贡献
 
-## Global Configuration
+1. Fork & PR
+2. 遵循输出与插件开发规范
+3. 保持文档与代码同步
 
-You can set global options for all kk tools in `~/.kscriptrc` (YAML format):
-
-```yaml
-log_level: debug
-trace_id: my-global-trace
-```
-
-- These settings will be used by default for all commands unless overridden by CLI options or environment variables.
-
-## Shell Completion 自动补全
-
-kscript 现已支持 zsh 和 bash 的命令自动补全，且**安装后首次运行会自动为你部署补全脚本**，无需手动操作。
-
-- **zsh 补全脚本路径**：`~/.zsh/completions/_kscript`
-- **bash 补全脚本路径**：`~/.bash_completion.d/kscript`
-
-如需手动重新生成补全脚本，可运行：
-
-```bash
-kscript completion zsh > ~/.zsh/completions/_kscript
-kscript completion bash > ~/.bash_completion.d/kscript
-```
+---
 
-> 每次升级或新增命令后，补全脚本也会自动更新。
+如需更多示例、插件开发指导或遇到问题，欢迎提 issue 或 PR！
 

data/Rakefile

@@ -33,3 +33,10 @@ task :dev do
     kscript version
   SHELL
 end
+
+task :install do
+  sh <<-SHELL
+    gem uninstall kscript -aIx
+    gem install kscript
+  SHELL
+end

data/kscript.gemspec

@@ -27,7 +27,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Runtime dependencies
+  spec.add_dependency 'bcrypt', '>= 3.1', '< 4.0'
   spec.add_dependency 'http', '>= 4.0', '< 6.0'
+  spec.add_dependency 'nokogiri', '>= 1.13', '< 2.0'
   spec.add_dependency 'thor', '1.3.2'
 
   # Development dependencies
@@ -35,11 +37,4 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   # spec.extensions = ['ext/install.rb'] # 已移除，防止 native extension build 错误
-
-  spec.post_install_message = <<~MSG
-    [kscript] Shell completion is available!
-    To enable shell completion for your shell, please run:
-      ruby ext/install.rb
-    Or see README for more details.
-  MSG
 end

data/lib/kscript/base.rb

@@ -7,11 +7,9 @@ module Kscript
   class Base
     attr_reader :logger
 
-    def initialize(service: nil, log_level: nil, trace_id: nil)
+    def initialize(service: nil, log_level: nil)
       config = defined?(Kscript::Utils::Config) ? Kscript::Utils::Config.load : nil
       log_level ||= config&.log_level || ENV['KSCRIPT_LOG_LEVEL'] || :info
-      trace_id ||= config&.trace_id || ENV['KSCRIPT_TRACE_ID']
-      @trace_id = trace_id
       @logger = Kscript::Logger.new(service: service || self.class.name, level: log_level)
       @logger.set_human_output(human_output?)
     end
@@ -24,12 +22,6 @@ module Kscript
       exit(1)
     end
 
-    # 提供 trace_id 给 logger
-    def logger
-      @logger.define_singleton_method(:default_trace_id) { @trace_id } if @trace_id
-      @logger
-    end
-
     # 自动注册所有 Kscript::Base 的子类为插件
     def self.inherited(subclass)
       name = subclass.name.split('::').last

data/lib/kscript/logger.rb

@@ -45,14 +45,12 @@ module Kscript
     end
 
     def log(level, message, context = {})
-      trace_id = context[:trace_id] || (respond_to?(:default_trace_id) ? default_trace_id : nil) || SecureRandom.hex(8)
       entry = {
         timestamp: Time.now.utc.iso8601,
         level: level.to_s.upcase,
         service: @service,
         message: message,
-        trace_id: trace_id,
-        context: context.reject { |k, _| k == :trace_id }
+        context: context
       }
       @logger.send(level, entry.to_json)
     end
@@ -67,7 +65,7 @@ module Kscript
         svc = @service || 'kscript'
         trace = context[:trace_id] || (respond_to?(:default_trace_id) ? default_trace_id : nil) || '-'
         color = COLORS[level] || COLORS[:info]
-        ctx_str = context.reject { |k, _| k == :trace_id }.map { |k, v| "#{k}=#{v}" }.join(' ')
+        ctx_str = context.map { |k, v| "#{k}=#{v}" }.join(' ')
         line = "[#{ts}] [#{lvl}] [#{svc}] [#{trace}] #{message}"
         line += " | #{ctx_str}" unless ctx_str.empty?
         $stdout.puts "#{color}#{line}#{COLORS[:reset]}"

data/lib/kscript/utils.rb

@@ -24,10 +24,6 @@ module Kscript
         self['log_level']
       end
 
-      def trace_id
-        self['trace_id']
-      end
-
       # 自动检测并安装 shell 补全脚本
       def self.ensure_completion_installed(shell = nil)
         shell ||= ENV['SHELL']

data/lib/kscript/version.rb

@@ -6,5 +6,5 @@
 # https://opensource.org/licenses/MIT
 
 module Kscript
-  VERSION = '0.1.0'
+  VERSION = '1.0.1'
 end

data/lib/kscript.rb

@@ -5,9 +5,26 @@
 # This software is released under the MIT License.
 # https://opensource.org/licenses/MIT
 
+# Ruby 标准库
 require 'json'
 require 'logger'
 require 'securerandom'
+require 'yaml'
+require 'fileutils'
+require 'base64'
+require 'rexml/document'
+require 'net/http'
+require 'timeout'
+require 'socket'
+require 'open3'
+require 'openssl'
+
+# 第三方 gem
+require 'http'
+require 'bcrypt'
+require 'nokogiri'
+require 'thor'
+
 require 'kscript/plugins'
 require 'kscript/base'
 require 'kscript/logger'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kscript
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kk
@@ -10,6 +10,26 @@ bindir: bin
 cert_chain: []
 date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +50,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -104,11 +144,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: |
-  [kscript] Shell completion is available!
-  To enable shell completion for your shell, please run:
-    ruby ext/install.rb
-  Or see README for more details.
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib