ruby-shell 3.4.5 → 3.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a0c1e45454167bc454071a1419673d2ca195980970208c54b2745870709e024
-  data.tar.gz: 4981d0f400409d059e703df8d6daa9eab3be19e6a4e0da3f96de7533aac66c6c
+  metadata.gz: 70cf831b842cb78920de4f541751dc71b1ec87d4d2619eb813d726aa9abe844d
+  data.tar.gz: 3a1baee44aa63c583f62485d6df477b5aeca1f04801ce2dd6c9b92a35795e27e
 SHA512:
-  metadata.gz: 6632764744a12eb79fda32cf92677e44e0ded8cab07e9b41cad11cfb911df0f678c63d9f8448390c8556fca89d11bb83a37864050f75c716c9589e05c88d4e67
-  data.tar.gz: fe1dee534ac7e91a7ad925ba6845acc49e9ca897763486973589d5f8997a6b78771ae1155f20ef8bf42d982a3fe4f37255a33a8a1499223cec77fa3b7319b935
+  metadata.gz: 96e26e3cb1788d7aa04eea7d8aabf034ac59f904fcc808151c3297d6a896794330be4e92c372c71f96376605e9943cd734c8871373fe6c4bf07e5fb3a0bbd891
+  data.tar.gz: ef2907de7d2758f996beb911677430b1e1e674b388ebfa726d2dbead4e8b9670dc03baa7009b534ca268064ae4feaf8c1c6dc474552c1f6a6e60a86068cbd147

data/PLUGIN_GUIDE.md

@@ -661,6 +661,113 @@ Planned for v4.0:
 
 ---
 
+## Included Plugins
+
+rsh comes with several useful plugins out of the box. Enable them with `:plugins "enable", "pluginname"`.
+
+### venv - Virtual Environment Indicators
+
+Shows active Python venv, Ruby rbenv/rvm, Node nvm, and Conda environments in your prompt.
+
+**Features:**
+- Detects Python virtualenv: `(py:myenv)`
+- Shows Ruby rbenv/rvm versions: `(rb:3.2.0)`
+- Displays Node version: `(node:18.0.0)`
+- Shows Conda environments: `(conda:base)`
+- Color-coded indicators (green for Python, red for Ruby, yellow for Node, cyan for Conda)
+
+**Usage:** Simply enable the plugin, indicators appear automatically when in an active environment.
+
+### extract - Universal Archive Handler
+
+Extract any archive format with a single command.
+
+**Features:**
+- Handles: `.tar.gz`, `.tar.bz2`, `.tar.xz`, `.zip`, `.rar`, `.7z`, `.gz`, `.bz2`, `.xz`, `.Z`, `.deb`, `.rpm`
+- Auto-detects format from extension
+- Success/error feedback with color
+
+**Commands:**
+- `extract file.tar.gz` - Extract any supported archive
+
+**Example:**
+```ruby
+extract project.tar.gz
+extract backup.zip
+extract archive.7z
+```
+
+### docker - Container Integration
+
+Quick Docker container management with prompt indicators.
+
+**Features:**
+- Shows running container count in prompt: `[docker:3]`
+- Quick container management commands
+- Docker Compose shortcuts
+
+**Commands:**
+- `dps` - List running containers (docker ps)
+- `dpsa` - List all containers (docker ps -a)
+- `dex <container>` - Execute bash in container
+- `dlogs <container> [lines]` - Show container logs (default 50 lines)
+- `dstop` - Stop all running containers
+- `dclean` - Remove all stopped containers
+- `dcup` - Docker compose up -d
+- `dcdown` - Docker compose down
+- `dcrestart` - Docker compose restart
+
+**Example:**
+```ruby
+dps                    # List running containers
+dex web_1              # Enter bash in web_1 container
+dlogs nginx 100        # Show last 100 log lines
+```
+
+### clipboard - Cross-Platform Clipboard
+
+Copy and paste text to/from system clipboard.
+
+**Features:**
+- Auto-detects clipboard tool (xclip, xsel, wl-copy/paste, pbcopy/paste, clip.exe)
+- Works on Linux (X11/Wayland), macOS, and Windows WSL
+- Copy last command, arbitrary text, or file contents
+
+**Commands:**
+- `clip [text]` - Copy text to clipboard (copies last command if no args)
+- `clipp` - Paste from clipboard and display
+- `clipf <file>` - Copy file contents to clipboard
+
+**Example:**
+```ruby
+clip                   # Copy last command
+clip some text here    # Copy this text
+clipf config.yml       # Copy file contents
+clipp                  # Show clipboard contents
+```
+
+### git_prompt - Git Branch Indicator
+
+Shows current git branch in prompt when in a git repository.
+
+**Features:**
+- Displays current branch: `[main]`
+- Only shows when in a git repo
+- Yellow color coding
+
+**Usage:** Enable and branch appears automatically in prompt.
+
+### command_logger - Command Logging
+
+Logs all commands to a file for audit/review.
+
+**Features:**
+- Logs commands with timestamp
+- Customizable log file location
+- Useful for command history analysis
+
+---
+
 ## Example Plugin Templates
 
 ### Minimal Plugin

data/README.md

@@ -136,6 +136,7 @@ Special commands:
 * `:nick` lists all command nicks, `:gnick` lists general nicks
 * `:nick -name` delete a command nick, `:gnick -name` delete a general nick
 * `:history` will list the command history, while `:rmhistory` will delete the history
+* `:rehash` rebuilds the executable cache (useful after installing new commands)
 * `:jobs` will list background jobs, `:fg [job_id]` brings jobs to foreground, `:bg [job_id]` resumes stopped jobs
 * `:defun func(args) = code` defines Ruby functions callable as shell commands (persistent!)
 * `:defun` lists all user-defined functions, `:defun -func` removes functions

data/bin/rsh

@@ -8,7 +8,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rsh
 # License:    Public domain
-@version    = "3.4.5" # Dynamic directory colors in prompt via LS_COLORS integration
+@version    = "3.4.7" # Added :rehash command to manually rebuild executable cache
 
 # MODULES, CLASSES AND EXTENSIONS
 class String # Add coloring to strings (with escaping for Readline)
@@ -154,7 +154,7 @@ begin # Initialization
   @slow_command_threshold = 0             # Threshold for slow command alerts (0 = disabled)
   @plugin_dir = Dir.home + '/.rsh/plugins' # Plugins directory
   @plugins = []                           # Loaded plugin instances
-  @plugin_disabled = []                   # List of disabled plugin names
+  @plugin_enabled = []                    # List of enabled plugin names (whitelist)
   @plugin_commands = {}                   # Commands added by plugins
   @validation_rules = []                  # Custom validation rules
   @completion_weights = {}                # Completion learning weights
@@ -352,7 +352,7 @@ def getstr # A custom Readline-like function
     # The actual printing og the command line
     @c.row(@row0)
     @c.clear_line
-    print @prompt
+    print @display_prompt
     @c.clear_screen_down
     row, @pos0 = @c.pos
     #@history[0] = "" if @history[0].nil?
@@ -476,11 +476,13 @@ def getstr # A custom Readline-like function
       @c.clear_line_after
     when 'WBACK' # Delete one word to the left (Ctrl-W)
       unless @pos == @pos0
-        until @history[0][@pos - 1] == " " or @pos == 0
+        # Skip over any trailing spaces first
+        while @pos > 0 && @history[0][@pos - 1] == " "
           @pos -= 1
           @history[0][@pos] = ""
         end
-        if @history[0][@pos - 1] == " "
+        # Delete the word (until we hit a space or start)
+        while @pos > 0 && @history[0][@pos - 1] != " "
           @pos -= 1
           @history[0][@pos] = ""
         end
@@ -622,7 +624,7 @@ def tab(type)
     @c_col = @pos0 + @pos
     @c.clear_line
     line_display = cmd_check(@history[0]).to_s
-    print @prompt + line_display
+    print @display_prompt + line_display
     @c.col(@c_col)
     return
   end
@@ -645,14 +647,22 @@ def tab(type)
       @tabarray = @recordings.keys
     when "plugin_args"
       # Completions for :plugins command
-      @tabarray = %w[reload info]
-      # Add plugin names for enable/disable/info
+      @tabarray = %w[reload]
+      # Add help for all available plugins
+      if Dir.exist?(@plugin_dir)
+        available = Dir.glob(@plugin_dir + '/*.rb').map { |f| File.basename(f, '.rb') }
+        @tabarray += available.map { |p| "help #{p}" }
+        @tabarray += available.map { |p| "info #{p}" }
+      end
+      # Add plugin names for enable/disable
       if @plugins.any?
         @tabarray += @plugins.map { |p| "disable #{p[:name]}" }
-        @tabarray += @plugins.map { |p| "info #{p[:name]}" }
       end
-      if @plugin_disabled.any?
-        @tabarray += @plugin_disabled.map { |p| "enable #{p}" }
+      # Show "enable" for disabled plugins (available but not enabled)
+      if Dir.exist?(@plugin_dir)
+        available = Dir.glob(@plugin_dir + '/*.rb').map { |f| File.basename(f, '.rb') }
+        disabled = available - @plugin_enabled
+        @tabarray += disabled.map { |p| "enable #{p}" } if disabled.any?
       end
     when "switch"
       cmdswitch = @pretab.split(/[|, ]/).last.to_s.strip
@@ -839,7 +849,7 @@ def tab(type)
         # Escape regex special characters in @tabstr for pattern matching
         escaped_tabstr = Regexp.escape(@tabstr)
         tabline   = display_choice.sub(/(.*)#{escaped_tabstr}(.*)/, '\1'.c(choice_color) + @tabstr.u.c(choice_color) + '\2'.c(choice_color))
-        print @prompt + line1 + tabline + line2               # Print the commandline
+        print @display_prompt + line1 + tabline + line2       # Print the commandline
         @pos   = @pretab.length.to_i + tabchoice.length.to_i  # Set the position on that commandline
         @c_col = @pos0 + @pos                                 # The cursor position must include the prompt as well
         @c.col(@c_col)                                        # Set the cursor position
@@ -1389,8 +1399,8 @@ def rshrc # Write user configuration to .rshrc (portable between machines)
   conf += "@completion_learning = #{@completion_learning}\n" unless @completion_learning
   conf.sub!(/^@completion_show_metadata.*(\n|$)/, "")
   conf += "@completion_show_metadata = #{@completion_show_metadata}\n" if @completion_show_metadata
-  conf.sub!(/^@plugin_disabled.*(\n|$)/, "")
-  conf += "@plugin_disabled = #{@plugin_disabled}\n" unless @plugin_disabled.empty?
+  conf.sub!(/^@plugin_enabled.*(\n|$)/, "")
+  conf += "@plugin_enabled = #{@plugin_enabled}\n" unless @plugin_enabled.empty?
   conf.sub!(/^@validation_rules.*(\n|$)/, "")
   conf += "@validation_rules = #{@validation_rules}\n" unless @validation_rules.empty?
 
@@ -1592,6 +1602,14 @@ def rmhistory # Delete history
   @history = []
   puts "History deleted."
 end
+def rehash # Force rebuild of executable cache
+  @exe_cache = nil
+  @exe_cache_path = nil
+  @exe_cache_time = 0
+  @exe_cache_paths = ""
+  cache_executables
+  puts "Executable cache rebuilt (#{@exe.length} commands cached)."
+end
 def nick(nick_str = nil)  # Define a new nick like this: `:nick "ls = ls --color"`
   if nick_str.nil? || nick_str.empty?
     # List all nicks
@@ -2250,8 +2268,8 @@ def load_plugins # Load all plugins from plugin directory
   plugin_files.each do |plugin_file|
     plugin_name = File.basename(plugin_file, '.rb')
 
-    # Skip if disabled
-    next if @plugin_disabled.include?(plugin_name)
+    # Only load if explicitly enabled (whitelist)
+    next unless @plugin_enabled.include?(plugin_name)
 
     begin
       # Load the plugin file
@@ -2321,22 +2339,26 @@ def call_plugin_hook(hook_name, *args) # Call a lifecycle hook for all plugins
 end
 def plugins(*args) # Plugin management command
   if args.empty?
-    # List all plugins
-    if @plugins.empty?
-      puts "\nNo plugins loaded"
+    # List all available plugins
+    available_plugins = Dir.exist?(@plugin_dir) ? Dir.glob(@plugin_dir + '/*.rb').map { |f| File.basename(f, '.rb') }.sort : []
+
+    if available_plugins.empty?
+      puts "\nNo plugins found"
       puts "Place .rb files in #{@plugin_dir}"
       return
     end
 
-    puts "\n  Loaded Plugins:".c(@c_prompt).b
-    @plugins.each do |plugin|
-      status = @plugin_disabled.include?(plugin[:name]) ? '[disabled]'.c(196) : '[enabled]'.c(@c_path)
-      puts "    #{plugin[:name].ljust(20)} #{status} (#{plugin[:class]})"
-    end
-
-    unless @plugin_disabled.empty?
-      puts "\n  Disabled Plugins:".c(@c_stamp)
-      @plugin_disabled.each { |name| puts "    #{name}" }
+    puts "\n  Available Plugins:".c(@c_prompt).b
+    available_plugins.each do |name|
+      if @plugin_enabled.include?(name)
+        status = '[enabled]'.c(@c_path)
+        plugin = @plugins.find { |p| p[:name] == name }
+        class_info = plugin ? " (#{plugin[:class]})" : ""
+      else
+        status = '[disabled]'.c(196)
+        class_info = ""
+      end
+      puts "    #{name.ljust(20)} #{status}#{class_info}"
     end
     puts
   elsif args[0] == 'reload'
@@ -2348,15 +2370,15 @@ def plugins(*args) # Plugin management command
   elsif args[0] == 'enable' && args[1]
     # Enable a plugin
     plugin_name = args[1]
-    @plugin_disabled.delete(plugin_name)
+    unless @plugin_enabled.include?(plugin_name)
+      @plugin_enabled << plugin_name
+    end
     puts "Plugin '#{plugin_name}' enabled. Use :plugins reload to load it"
     rshrc
   elsif args[0] == 'disable' && args[1]
     # Disable a plugin
     plugin_name = args[1]
-    unless @plugin_disabled.include?(plugin_name)
-      @plugin_disabled << plugin_name
-    end
+    @plugin_enabled.delete(plugin_name)
     @plugins.reject! { |p| p[:name] == plugin_name }
     puts "Plugin '#{plugin_name}' disabled"
     rshrc
@@ -2382,6 +2404,51 @@ def plugins(*args) # Plugin management command
     else
       puts "Plugin '#{plugin_name}' not found"
     end
+  elsif args[0] == 'help' && args[1]
+    # Show plugin help
+    plugin_name = args[1]
+    plugin_file = "#{@plugin_dir}/#{plugin_name}.rb"
+
+    if File.exist?(plugin_file)
+      content = File.read(plugin_file)
+
+      # Extract help block (lines starting with # at top of file)
+      help_lines = []
+      in_help = true
+      content.each_line do |line|
+        if in_help && line =~ /^#\s*(.*)$/
+          help_text = $1
+          next if help_text =~ /^-+$/ # Skip separator lines
+          help_lines << help_text
+        elsif line.strip.empty?
+          next
+        else
+          in_help = false
+          break
+        end
+      end
+
+      if help_lines.any?
+        puts "\n#{help_lines.join("\n")}\n"
+      else
+        puts "No help available for plugin '#{plugin_name}'"
+      end
+
+      # Extract and show available commands
+      commands = []
+      content.scan(/def (\w+)\(/) { |match| commands << match[0] unless match[0] == 'initialize' }
+
+      if commands.any?
+        puts "\nCommands: #{commands.join(', ')}".c(@c_nick)
+        puts
+      end
+    else
+      puts "Plugin '#{plugin_name}' not found"
+      puts "Available plugins:"
+      Dir.glob(@plugin_dir + '/*.rb').each do |file|
+        puts "  #{File.basename(file, '.rb')}"
+      end
+    end
   else
     puts "Usage:"
     puts "  :plugins              List all plugins"
@@ -2389,6 +2456,7 @@ def plugins(*args) # Plugin management command
     puts "  :plugins enable NAME  Enable a plugin"
     puts "  :plugins disable NAME Disable a plugin"
     puts "  :plugins info NAME    Show plugin details"
+    puts "  :plugins help NAME    Show plugin help/usage"
   end
 end
 def validate_command(cmd) # Syntax validation before execution
@@ -2999,7 +3067,7 @@ def load_rshrc_safe
     @session_autosave = 0 unless @session_autosave.is_a?(Integer)
     @auto_correct = false unless [@auto_correct].any? { |v| v == true || v == false }
     @slow_command_threshold = 0 unless @slow_command_threshold.is_a?(Integer)
-    @plugin_disabled = [] unless @plugin_disabled.is_a?(Array)
+    @plugin_enabled = [] unless @plugin_enabled.is_a?(Array)
     @plugins = [] unless @plugins.is_a?(Array)
     @plugin_commands = {} unless @plugin_commands.is_a?(Hash)
     @validation_rules = [] unless @validation_rules.is_a?(Array)
@@ -3154,7 +3222,7 @@ def load_defaults
   @session_autosave ||= 0
   @auto_correct ||= false
   @slow_command_threshold ||= 0
-  @plugin_disabled ||= []
+  @plugin_enabled ||= []
   @plugins ||= []
   @plugin_commands ||= {}
   @validation_rules ||= []
@@ -3293,9 +3361,10 @@ loop do
       load_plugins
       @plugins_loaded = true
     end
-    # Append plugin prompt additions (after plugins loaded)
+    # Build display prompt with plugin additions (don't modify @prompt)
     plugin_prompts = call_plugin_hook(:on_prompt)
-    @prompt += plugin_prompts.join if plugin_prompts.any?
+    @display_prompt = @prompt.dup
+    @display_prompt += plugin_prompts.join if plugin_prompts.any?
     # Auto-save session if enabled and interval elapsed
     if @session_autosave && @session_autosave > 0
       current_time = Time.now.to_i
@@ -3342,7 +3411,7 @@ loop do
     # Move cursor to end of line and print the full command before clearing
     @c.row(@row0)
     @c.clear_line
-    print @prompt + cmd_check(@cmd)
+    print @display_prompt + cmd_check(@cmd)
     print "\n"; @c.clear_screen_down
     if @cmd == "r" # Integration with rtfm (https://github.com/isene/RTFM)
       t  = Time.now
@@ -3397,7 +3466,7 @@ loop do
                               save_session load_session list_sessions delete_session rmsession
                               validate completion_stats completion_reset
                               record replay
-                              history rmhistory jobs fg bg dirs help info version]
+                              history rmhistory rehash jobs fg bg dirs help info version]
 
           # Try to call as rsh method
           if known_commands.include?(cmd_name)

metadata

@@ -1,21 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: ruby-shell
 version: !ruby/object:Gem::Version
-  version: 3.4.5
+  version: 3.4.7
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-26 00:00:00.000000000 Z
+date: 2025-10-29 00:00:00.000000000 Z
 dependencies: []
 description: 'A shell written in Ruby with extensive tab completions, aliases/nicks,
   history, syntax highlighting, theming, auto-cd, auto-opening files and more. UPDATE
-  v3.4.5: FULL LS_COLORS COMPLIANCE - Prompt and command line now use LS_COLORS with
-  pattern-based directory coloring. Configure @dir_colors like RTFM''s @topmatch for
-  visual project distinction. Plus v3.4.0: Completion learning, context-aware ranking,
-  persistent patterns across sessions!'
+  v3.4.7: Added :rehash command to manually rebuild executable cache (like zsh''s
+  rehash builtin). Plus v3.4.6: Plugin help system, 4 new plugins, plugins disabled
+  by default!'
 email: g@isene.com
 executables:
 - rsh