kscript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa60e97dd2e5ebd0282945488335f81226666cc547f74608eb5b6d04370eec69
+  data.tar.gz: 628577d54846ee750cf65e648bb13bce7c286182b49ef52813edb551b182a6f2
+SHA512:
+  metadata.gz: 79c677939e03109beac01c935773433218d95b663f7a4fea56980d3e6dbfc652eaadec7ed37ce1da38e77089cd6ff7524631e46a7dda71744e3868d8badf1734
+  data.tar.gz: f29744a4e376a0476f91ee3a5788cd713f7a5c333114a3e4ef3616f5b3cb45783cceaca02b5798b2bf88c3038a28c50fe168d9e08c4700c31a5c3fd48376687c

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# See kscript.gemspec for gem dependencies

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 kevin197011
+
+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.

data/README.md

@@ -0,0 +1,169 @@
+# kscript
+```
+______                     _____        _____
+___  /________________________(_)_________  /_
+__  //_/_  ___/  ___/_  ___/_  /___  __ \\  __/
+_  ,<  _(__  )/ /__ _  /   _  / __  /_/ / /_
+/_/|_| /____/ \\___/ /_/    /_/  _  .___/\\__/
+                                /_/
+```
+
+A collection of Ruby utility scripts for various system administration and development tasks.
+
+[![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)
+
+## Installation
+
+### Gem install (recommended)
+
+```bash
+gem install kscript
+```
+
+Or from local source:
+
+```bash
+git clone https://github.com/kevin197011/kscript.git
+cd kscript
+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]
+```
+
+Or, for legacy usage via curl:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/SCRIPT_NAME.rb | ruby
+```
+
+## 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
+```
+
+2. View system resource usage:
+```bash
+curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/mac-top-usage.rb | ruby
+```
+
+3. Scan ports:
+```bash
+curl -sSL https://raw.githubusercontent.com/kevin197011/kscript/main/bin/port-scanner.rb | ruby
+```
+
+## Dependencies
+
+Required gems:
+```ruby
+gem 'http'
+gem 'rubocop'
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 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
+
+## Unified CLI Usage
+
+After gem install, you can use the unified kk command:
+
+```bash
+kk <command> [args...]
+
+# List all available tools
+kk --help
+
+# 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
+
+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
+```
+
+> 每次升级或新增命令后，补全脚本也会自动更新。
+

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2025 kk
+#
+# This software is released under the MIT License.
+# https://opensource.org/licenses/MIT
+
+require 'time'
+require 'rake'
+require 'bundler/gem_tasks'
+
+task default: %w[push]
+
+task :push do
+  system <<-SHELL
+    rubocop -A
+    git update-index --chmod=+x push
+    git add .
+    git commit -m "Update #{Time.now}"
+    git pull
+    git push origin main
+  SHELL
+end
+
+# 其他自定义任务可在此添加
+task :dev do
+  sh <<-SHELL
+    gem uninstall kscript -aIx
+    gem build kscript.gemspec
+    gem install kscript-*.gem
+    kscript help
+    kscript list
+    kscript version
+  SHELL
+end

data/bin/kscript

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'kscript/cli'
+
+Kscript::CLI.start(ARGV)

data/kscript.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'lib/kscript/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kscript'
+  spec.version       = Kscript::VERSION
+  spec.authors       = ['Kk']
+  spec.email         = ['kevin197011@outlook.com']
+
+  spec.summary       = 'A collection of Ruby utility scripts for sysadmin and development.'
+  spec.description   = 'Kscript provides a set of handy Ruby scripts for system administration, development, and automation.'
+  spec.homepage      = 'https://github.com/kevin197011/kscript'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.files = Dir.chdir(__dir__) do
+    files = `git ls-files -z`.split("\x0")
+    files.select! do |f|
+      f =~ %r{^(lib/|bin/kscript|README|LICENSE|Rakefile|Gemfile|kscript\.gemspec)}
+    end
+    files
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['kscript']
+  spec.require_paths = ['lib']
+
+  # Runtime dependencies
+  spec.add_dependency 'http', '>= 4.0', '< 6.0'
+  spec.add_dependency 'thor', '1.3.2'
+
+  # Development dependencies
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  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/banner.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Kscript
+  BANNER = <<~BANNER
+    ______                     _____        _____
+    ___  /________________________(_)_________  /_
+    __  //_/_  ___/  ___/_  ___/_  /___  __ \\  __/
+    _  ,<  _(__  )/ /__ _  /   _  / __  /_/ / /_
+    /_/|_| /____/ \\___/ /_/    /_/  _  .___/\\__/
+                                    /_/
+  BANNER
+end

data/lib/kscript/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'kscript'
+
+module Kscript
+  # Base class for all kscript scripts
+  class Base
+    attr_reader :logger
+
+    def initialize(service: nil, log_level: nil, trace_id: 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
+
+    # 通用工具方法可在此扩展
+    def with_error_handling
+      yield
+    rescue StandardError => e
+      logger.error("Unhandled error: #{e.class} - #{e.message}", error: e.class.name, backtrace: e.backtrace&.first(5))
+      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
+      if name.start_with?('Kk') && name.end_with?('Utils')
+        cmd = name[2..-6] # 去掉 Kk 和 Utils
+        # 转 snake_case
+        cmd = cmd.gsub(/([A-Z])/, '_\1').downcase.sub(/^_/, '').sub(/_$/, '')
+        Kscript::Plugin.register(cmd.to_sym, subclass)
+      end
+      super if defined?(super)
+    end
+
+    # 判断是否为人性化输出模式（无 --log/--log-level 参数且 ENV['LOG'] 未设置）
+    def human_output?
+      !(ARGV.include?('--log') || ARGV.include?('--log-level') || ENV['LOG'])
+    end
+  end
+end

data/lib/kscript/cli.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require 'kscript'
+require 'io/console'
+require 'kscript/banner'
+require 'thor'
+
+module Kscript
+  class CLI < Thor
+    class_option :log_level, type: :string, desc: 'Set log level (debug, info, warn, error, fatal)',
+                             aliases: '--log-level'
+    class_option :log, type: :boolean, desc: 'Enable structured log output', default: false
+
+    def self.banner(command, _namespace = nil, _subcommand = false)
+      "kscript #{command.usage}" if command.respond_to?(:usage)
+    end
+
+    desc 'version', 'Show kscript version'
+    map %w[--version -v] => :version
+    def version
+      puts Kscript::BANNER
+      puts color('─' * 80, 90)
+      require 'kscript/version'
+      puts "kscript version: #{Kscript::VERSION}"
+    end
+
+    desc 'list', 'List all available commands'
+    def list
+      puts Kscript::BANNER
+      puts color('─' * 80, 90)
+      plugin_infos = Kscript::PluginLoader.plugin_infos
+      grouped = plugin_infos.group_by { |info| info[:group] || 'other' }
+      group_colors = %w[36 32 35 34 33 31 90 37]
+      group_names = grouped.keys.sort
+      group_names.each_with_index do |group, idx|
+        color_code = group_colors[idx % group_colors.size]
+        group_label = color("[#{group.capitalize}]", color_code)
+        puts group_label
+        puts color('─' * 80, 90)
+        grouped[group].each do |info|
+          command = info[:name].to_s.sub(/^kk_/, '')
+          desc = info[:description] || ''
+          usage = info[:class].respond_to?(:usage) ? info[:class].usage : nil
+          arguments = info[:class].respond_to?(:arguments) ? info[:class].arguments : nil
+          author = info[:class].respond_to?(:author) ? info[:class].author : nil
+          print "  #{green(command.ljust(16))}"
+          print gray(desc)
+          puts
+          if usage && !usage.to_s.strip.empty?
+            usage.to_s.split("\n").each_with_index do |line, idx|
+              prefix = idx.zero? ? gray('    usage:') : gray('          ')
+              puts "#{prefix} #{cyan(line.strip)}"
+            end
+          end
+          puts gray("    args:  #{arguments}") if arguments && !arguments.to_s.strip.empty?
+          puts gray("    by:    #{author}") if author && !author.to_s.strip.empty?
+          puts gray("    #{'-' * 60}")
+        end
+        puts
+      end
+    end
+
+    # 动态注册所有插件为子命令
+    reserved = if defined?(Thor::Util::THOR_RESERVED_WORDS)
+                 Thor::Util::THOR_RESERVED_WORDS.map(&:to_s)
+               else
+                 %w[shell help start version list exit invoke method_missing]
+               end
+    Kscript::PluginLoader.plugin_infos.each do |info|
+      orig_command = info[:name].to_s.sub(/^kk_/, '')
+      # shell -> sh
+      command = orig_command == 'shell' ? 'sh' : orig_command
+      command = reserved.include?(command) ? "#{command}_cmd" : command
+      klass = info[:class]
+      desc command,
+           (info[:description] || 'No description') + (reserved.include?(orig_command) ? " (original: #{orig_command})" : '')
+      define_method(command) do |*args|
+        puts Kscript::BANNER
+        puts color('─' * 80, 90)
+        begin
+          instance = klass.new(*args)
+          instance.run
+        rescue ArgumentError => e
+          warn "Argument error: #{e.message}"
+          puts "Usage: kscript #{command} #{klass.respond_to?(:arguments) ? klass.arguments : '[args...]'}"
+          exit 1
+        end
+      end
+    end
+
+    desc 'completion SHELL', 'Generate shell completion script (zsh or bash)'
+    def completion(shell = 'zsh', capture: false)
+      commands = %w[version help
+                    list] + Kscript::PluginLoader.plugin_infos.map do |info|
+                              cmd = info[:name].to_s.sub(/^kk_/, '')
+                              cmd = 'sh' if cmd == 'shell'
+                              cmd
+                            end
+      output = StringIO.new
+      case shell
+      when 'zsh'
+        output.puts "#compdef kscript\n"
+        output.puts '_kscript() {'
+        output.puts '  local -a commands'
+        output.puts '  commands=('
+        commands.each do |cmd|
+          output.puts "    '#{cmd}:kscript command'"
+        end
+        output.puts '  )'
+        output.puts "  _describe 'command' commands"
+        output.puts '}'
+        output.puts 'compdef _kscript kscript'
+      when 'bash'
+        output.puts '_kscript_completions() {'
+        output.puts "  COMPREPLY=($(compgen -W \"#{commands.join(' ')}\" -- \"${COMP_WORDS[1]}\"))"
+        output.puts '}'
+        output.puts 'complete -F _kscript_completions kscript'
+      else
+        output.puts "Unsupported shell: #{shell}. Only 'zsh' and 'bash' are supported."
+        return capture ? output.string : (puts output.string)
+      end
+      capture ? output.string : (puts output.string)
+    end
+
+    no_commands do
+      def color(str, code)
+        "\e[#{code}m#{str}\e[0m"
+      end
+
+      def cyan(str)
+        color(str, 36)
+      end
+
+      def green(str)
+        color(str, 32)
+      end
+
+      def gray(str)
+        color(str, 90)
+      end
+
+      def bold(str)
+        color(str, 1)
+      end
+    end
+
+    # Thor help 美化
+    def self.exit_on_failure?
+      true
+    end
+
+    def help(*_args)
+      puts Kscript::BANNER
+      puts color('─' * 80, 90)
+      # 只展示主命令（version、help、list）
+      Kscript::PluginLoader.plugin_infos.select do |info|
+        info[:name].to_s.sub(/^kk_/, '')
+        false # 不输出插件命令
+      end
+      # 只输出主命令
+      puts bold('Available commands:')
+      puts green('  version'.ljust(16)) + gray('Show kscript version')
+      puts green('  help'.ljust(16)) + gray('Describe available commands or one specific command')
+      puts green('  list'.ljust(16)) + gray('List all available commands')
+      puts
+      puts bold('Options:')
+      puts gray('  --log-level, [--log-level=LOG_LEVEL]            # Set log level (debug, info, warn, error, fatal)')
+      puts gray('               [--log], [--no-log], [--skip-log]  # Enable structured log output')
+      puts gray('  --log                        # Enable  structured log output')
+      puts gray('                                                  # Default: false')
+      puts
+      puts gray("Use 'kscript list' to see all business subcommands.")
+      nil
+    end
+  end
+end
+
+# CLI 启动时自动检测并安装 shell 补全脚本
+begin
+  require_relative 'utils'
+  Kscript::Utils::Config.ensure_completion_installed
+rescue StandardError => e
+  warn "[kscript] Shell completion auto-install failed: #{e.message}"
+end

data/lib/kscript/logger.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Kscript
+  # Structured logger for all scripts
+  class Logger
+    LEVELS = %i[debug info warn error fatal unknown].freeze
+
+    # 极客风格终端输出
+    COLORS = {
+      info: "\e[32m", # green
+      warn: "\e[33m", # yellow
+      error: "\e[31m", # red
+      debug: "\e[90m", # gray
+      reset: "\e[0m"
+    }.freeze
+
+    def initialize(service: 'kscript', level: :info, out: $stdout, human_output: nil)
+      @service = service
+      @logger = ::Logger.new(out)
+      @logger.level = ::Logger.const_get(level.to_s.upcase)
+      @human_output = human_output
+    end
+
+    # 允许外部设置输出模式
+    def set_human_output(val)
+      @human_output = val
+    end
+
+    def human_output?
+      @human_output == true
+    end
+
+    def log_mode?
+      @human_output == false
+    end
+
+    LEVELS.each do |level|
+      define_method(level) do |message, context = {}|
+        if human_output?
+          puts "[#{level.to_s.upcase}] #{message} #{context.map { |k, v| "#{k}=#{v}" }.join(' ')}".strip
+        else
+          log(level, message, context)
+        end
+      end
+    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 }
+      }
+      @logger.send(level, entry.to_json)
+    end
+
+    # 极客风格终端输出
+    def klog(level, message, context = {})
+      if human_output?
+        puts "[#{level.to_s.upcase}] #{message} #{context.map { |k, v| "#{k}=#{v}" }.join(' ')}".strip
+      else
+        ts = Time.now.strftime('%Y-%m-%d %H:%M:%S')
+        lvl = level.to_s.upcase
+        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(' ')
+        line = "[#{ts}] [#{lvl}] [#{svc}] [#{trace}] #{message}"
+        line += " | #{ctx_str}" unless ctx_str.empty?
+        $stdout.puts "#{color}#{line}#{COLORS[:reset]}"
+      end
+    end
+
+    # 便捷方法
+    def kinfo(msg, ctx = {})
+      klog(:info, msg, ctx)
+    end
+
+    def kwarn(msg, ctx = {})
+      klog(:warn, msg, ctx)
+    end
+
+    def kerror(msg, ctx = {})
+      klog(:error, msg, ctx)
+    end
+
+    def kdebug(msg, ctx = {})
+      klog(:debug, msg, ctx)
+    end
+  end
+end