ruby-shell 2.7.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35706aa5efb5ce661a102e1c6a5b22638a750b567f41930b683f239d42386964
-  data.tar.gz: 164ea239fc7081182c031cf002dc7e3c64696536f5795057e24ba027a899f998
+  metadata.gz: 3bfe09de4762828310479cc0535ec0942b575fc331d4f16bfc1614861cf14b8c
+  data.tar.gz: 264e440a9257eb49e7985a034fbfc8ec7a3be5fb1efc9e046d4ef7cf94116872
 SHA512:
-  metadata.gz: 952d3ba93d41715d50a6b8a4f669f8f670f3b5c403f300f24fd7a28fe9cb432a4f66b2ba747fb9ddbab6e3ec6a33ec94113c3e499ee6014a25ec6d7861266929
-  data.tar.gz: 41ea80063e2fd754acd4a449ddac1f418bb3450b10bd70a9a99432159fefbcf2002bf6964638cd03079585088974d382c0978d830eb3beb8f28936cc2bc2cf65
+  metadata.gz: bc12e932035ded646ff4459c7d3ad299582102c3d208b8ddb1b529691f8cc21d02ec3e7d7c21b4a346b716eba495540361291b5e483438b712afe9c6fb0ea381
+  data.tar.gz: bf29a4a08d04835d7275a09c9bb0970d597a72a207a68e57e42755b433613dddac4d93bcae3a0152b74f6a8093562b8f748d8f33844bb736f0fdff66da83bfeb

data/README.md

@@ -33,7 +33,22 @@ Or simply `gem install ruby-shell`.
 * All colors are themeable in .rshrc (see github link for possibilities)
 * Copy current command line to primary selection (paste w/middle button) with `Ctrl-y`
 
-## NEW in v2.7.0 - Ruby Functions ⭐
+## NEW in v2.9.0 - AI Integration ⭐
+* **AI-powered command assistance**: Get help with commands using natural language
+* **`@ <question>`**: Ask questions and get AI-generated text responses
+* **`@@ <request>`**: Describe what you want to do, and AI suggests the command
+* **Smart command suggestion**: AI suggestions appear directly on the command line, ready to execute
+* **Local AI support**: Works with Ollama for privacy-focused local AI
+* **External AI support**: Configure OpenAI or other providers via `.rshrc`
+* **Syntax highlighting**: @ and @@ commands are highlighted in blue
+
+## Enhanced Help System & Nick Management (v2.8.0)
+* **Two-column help display**: Compact, organized help that fits on one screen
+* **New `:info` command**: Shows introduction and feature overview
+* **`:nickdel` and `:gnickdel`**: Intuitive commands to delete nicks and gnicks
+* **Improved help organization**: Quick reference for keyboard shortcuts, commands, and features
+
+## Ruby Functions (v2.7.0)
 * **Define Ruby functions as shell commands**: `:defun 'weather(*args) = system("curl -s wttr.in/#{args[0] || \"oslo\"}")'`
 * **Call like any shell command**: `weather london`
 * **Full Ruby power**: Access to Ruby stdlib, file operations, JSON parsing, web requests, etc.
@@ -58,13 +73,16 @@ Special functions/integrations:
 Special commands:
 * `:nick 'll = ls -l'` to make a command alias (ll) point to a command (ls -l)
 * `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
+* `:nickdel 'name'` to delete a command nick (or use `:nick '-name'`)
+* `:gnickdel 'name'` to delete a general nick (or use `:gnick '-name'`)
 * `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
 * `:history` will list the command history, while `:rmhistory` will delete the history
 * `: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
 * `:defun?` lists all user-defined functions, `:defun '-func'` removes functions
+* `:info` shows introduction and feature overview
 * `:version` Shows the rsh version number and the last published gem file version
-* `:help` will display this help text
+* `:help` will display a compact command reference in two columns
 
 Background jobs:
 * Use `command &` to run commands in background
@@ -72,6 +90,21 @@ Background jobs:
 * Use `:fg` or `:fg job_id` to bring jobs to foreground
 * Use `Ctrl-Z` to suspend running jobs, `:bg job_id` to resume them
 
+## AI Configuration
+The AI features work out of the box with Ollama for local AI processing. To set up:
+
+### Local AI (Recommended)
+1. Install Ollama: `curl -fsSL https://ollama.com/install.sh | sh`
+2. Pull a model: `ollama pull llama3.2`
+3. That's it! Use `@ What is the capital of France?` or `@@ list files by size`
+
+### External AI (OpenAI)
+Add to your `.rshrc`:
+```ruby
+@aimodel = "gpt-4"
+@aikey = "your-api-key-here"
+```
+
 ## Moving around
 While you `cd` around to different directories, you can see the last 10 directories visited via the command `:dirs` or the convenient shortcut `#`. Entering the number in the list (like `6` and ENTER) will jump you to that directory. Entering `-` will jump you back to the previous dir (equivalent of `1`. Entering `~` will get you to your home dir. If you want to bookmark a special directory, you can do that via a general nick like this: `:gnick "x = /path/to/a/dir/"` - this would bookmark the directory to the single letter `x`.
 

data/bin/rsh

@@ -8,7 +8,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rsh
 # License:    Public domain
-@version    = "2.7.0" # Major release: Ruby functions, job control, command substitution, login shell support
+@version    = "2.9.0" # Feature release: AI integration with @ and @@ commands
 
 # MODULES, CLASSES AND EXTENSIONS
 class String # Add coloring to strings (with escaping for Readline)
@@ -109,20 +109,22 @@ begin # Initialization
   @dirs        = ["."]*10
   @jobs        = {}                       # Background jobs tracking
   @job_id      = 0                        # Job counter
+  @ai_suggestion = nil                    # Store AI command suggestion
   @last_exit   = 0                        # Last command exit status
   def pre_cmd; end                        # User-defined function to be run BEFORE command execution
   def post_cmd; end                       # User-defined function to be run AFTER  command execution
 end
 
 # HELP TEXT
-@help = <<~HELP
+@info = <<~INFO
 
   Hello #{@user}, welcome to rsh - the Ruby SHell. 
   
   rsh does not attempt to compete with the grand old shells like bash and zsh. 
   It serves the specific needs and wants of its author. If you like it, then feel free 
-  to ask for more or different features here: https://github.com/isene/rsh. Features:
-
+  to ask for more or different features here: https://github.com/isene/rsh.
+  
+  Features:
   * Aliases (called nicks in rsh) - both for commands and general nicks
   * Syntax highlighting, matching nicks, system commands and valid dirs/files
   * Tab completions for nicks, system commands, command switches and dirs/files
@@ -137,41 +139,19 @@ end
   * rsh specific commands and full set of Ruby commands available via :<command>
   * All colors are themeable in .rshrc (see github link for possibilities)
   * Copy current command line to primary selection (paste w/middle button) with `Ctrl-y`
-
-  Special functions/integrations:
-  * Use `r` to launch rtfm (https://github.com/isene/RTFM) - if you have it installed
-  * Use `f` to launch fzf (https://github.com/junegunn/fzf) - if you have it installed
-  * Use `=` followed by xrpn commands separated by commas or double-spaces (https://github.com/isene/xrpn)
-  * Use `:` followed by a Ruby expression to access the whole world of Ruby
-
-  Special commands:
-  * `:nick 'll = ls -l'` to make a command alias (ll) point to a command (ls -l)
-  * `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
-  * `:nick?` will list all command nicks and general nicks (you can edit your nicks in .rshrc)
-  * `:history` will list the command history, while `:rmhistory` will delete the history
-  * `: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
-  * `:defun?` lists all user-defined functions, `:defun '-func'` removes functions
-  * `:version` Shows the rsh version number and the last published gem file version
-  * `:help` will display this help text
-  
-  Background jobs:
-  * Use `command &` to run commands in background
-  * Use `:jobs` to list active background jobs  
-  * Use `:fg` or `:fg job_id` to bring jobs to foreground
-  * Use `Ctrl-Z` to suspend running jobs, `:bg job_id` to resume them
+  * AI integration: Use @ for text responses and @@ for command suggestions (requires ollama or OpenAI)
   
-  Ruby Functions:
-  * Define with `:defun 'myls(*args) = Dir.glob("*").each {|f| puts f}'`
-  * Call like any shell command: `myls` or `myls arg1 arg2`
-  * Functions have full access to Ruby stdlib and rsh internals
-  * Remove with `:defun '-myls'` and list with `:defun?`
+  Use `:help` for command reference.
   
+INFO
+
+@help = <<~HELP
+
 HELP
 
 # GENERIC FUNCTIONS
 def firstrun
-  puts @help
+  puts @info
   puts "Since there is no rsh configuration file (.rshrc), I will help you set it up to suit your needs.\n\n"
   puts "The prompt you see now is the very basic rsh prompt:"
   print "#{@prompt} (press ENTER)"
@@ -256,6 +236,12 @@ def getstr # A custom Readline-like function
   @pos  = 0
   chr   = ""
   @history.unshift("")
+  # Check if we have an AI suggestion to pre-fill
+  if @ai_suggestion
+    @history[0] = @ai_suggestion
+    @pos = @ai_suggestion.length
+    @ai_suggestion = nil
+  end
   @row0, p = @c.pos
   while chr != "ENTER" # Keep going with readline until user presses ENTER
     @ci   = nil
@@ -569,6 +555,14 @@ def hist_clean # Clean up @history
 end
 def cmd_check(str) # Check if each element on the readline matches commands, nicks, paths; color them
   return if str.nil?
+  
+  # Special handling for @ and @@ commands
+  if str =~ /^(@@?)\s+(.*)$/
+    prefix = $1
+    rest = $2
+    return prefix.c(4) + " " + rest  # Color @ or @@ in blue (4), rest uncolored
+  end
+  
   str.gsub(/(?:\S'[^']*'|[^ '])+/) do |el|
     if @exe.include?(el)
       el.c(@c_cmd)
@@ -610,7 +604,97 @@ end
 
 # RSH FUNCTIONS
 def help
-  puts @help
+  # Get terminal width
+  term_width = @maxcol || 80
+  col_width = 48  # Fixed width for left column
+  
+  # Helper function to strip ANSI codes for length calculation
+  def strip_ansi(str)
+    str.gsub(/\001?\e\[[0-9;]*m\002?/, '')
+  end
+  
+  left_col = []
+  right_col = []
+  
+  # Left column content
+  left_col << "KEYBOARD SHORTCUTS:".c(@c_prompt).b
+  left_col << "RIGHT/Ctrl-F    Accept suggestion"
+  left_col << "UP/DOWN         Navigate history"
+  left_col << "TAB             Tab complete"
+  left_col << "Ctrl-Y          Copy to clipboard"
+  left_col << "Ctrl-D          Exit + save .rshrc"
+  left_col << "Ctrl-E          Exit without save"
+  left_col << "Ctrl-L          Clear screen"
+  left_col << "Ctrl-Z          Suspend job"
+  left_col << "Ctrl-C/G        Clear line"
+  left_col << "Ctrl-K          Delete history item"
+  left_col << "Ctrl-U          Clear line"
+  left_col << "Ctrl-W          Delete previous word"
+  left_col << ""
+  left_col << "SPECIAL COMMANDS:".c(@c_prompt).b
+  left_col << ":nick 'll = ls -l'  Command alias"
+  left_col << ":gnick 'h = /home'  General alias"
+  left_col << ":nickdel 'name'     Delete nick"
+  left_col << ":gnickdel 'name'    Delete gnick"
+  left_col << ":nick?              List all nicks"
+  left_col << ":history            Show history"
+  left_col << ":rmhistory          Clear history"
+  left_col << ":info               About rsh"
+  left_col << ":version            Version info"
+  left_col << ":help               This help"
+  
+  # Right column content
+  right_col << "RUBY FUNCTIONS:".c(@c_prompt).b
+  right_col << ":defun 'f(x) = x*2' Define function"
+  right_col << ":defun?             List functions"
+  right_col << ":defun '-f'         Remove function"
+  right_col << "Call as: f 5        (returns 10)"
+  right_col << ""
+  right_col << "JOB CONTROL:".c(@c_prompt).b
+  right_col << "command &           Background job"
+  right_col << ":jobs               List jobs"
+  right_col << ":fg [id]            Foreground job"
+  right_col << ":bg [id]            Resume in bg"
+  right_col << ""
+  right_col << "INTEGRATIONS:".c(@c_prompt).b
+  right_col << "r                   Launch rtfm"
+  right_col << "f                   Launch fzf"
+  right_col << "= <expr>            xrpn calculator"
+  right_col << ":<ruby code>        Execute Ruby"
+  right_col << ""
+  right_col << "AI FEATURES:".c(@c_prompt).b
+  right_col << "@ <question>        AI text response"
+  right_col << "@@ <request>        AI command → prompt"
+  right_col << ""
+  right_col << "EXPANSIONS:".c(@c_prompt).b
+  right_col << "~                   Home directory"
+  right_col << "$VAR, ${VAR}        Environment var"
+  right_col << "$?                  Exit status"
+  right_col << "$(cmd), `cmd`       Command subst"
+  right_col << "{a,b,c}             Brace expansion"
+  right_col << "cmd1 && cmd2        Conditional"
+  right_col << "cmd1 || cmd2        Alternative"
+  
+  # Pad columns to same length
+  max_lines = [left_col.length, right_col.length].max
+  left_col.fill("", left_col.length...max_lines)
+  right_col.fill("", right_col.length...max_lines)
+  
+  # Print in two columns
+  puts
+  max_lines.times do |i|
+    left_text = left_col[i].to_s
+    right_text = right_col[i].to_s
+    # Calculate padding based on visible characters (without ANSI codes)
+    visible_length = strip_ansi(left_text).length
+    padding = col_width - visible_length
+    padding = 0 if padding < 0
+    puts "  #{left_text}#{' ' * padding} #{right_text}"
+  end
+  puts
+end
+def info
+  puts @info
 end
 def version
   puts "rsh version = #{@version} (latest RubyGems version is #{Gem.latest_version_for("ruby-shell").version} - https://github.com/isene/rsh)"
@@ -651,6 +735,16 @@ def nick? # Show nicks
   puts "  General nicks:".c(@c_gnick)
   @gnick.sort.each {|key, value| puts "  #{key} = #{value}"}
 end
+def nickdel(nick_name) # Delete a command nick
+  @nick.delete(nick_name)
+  rshrc
+  puts "Nick '#{nick_name}' deleted"
+end
+def gnickdel(nick_name) # Delete a general/global nick
+  @gnick.delete(nick_name)
+  rshrc
+  puts "General nick '#{nick_name}' deleted"
+end
 def dirs
   puts "Past direactories:"
   @dirs.each_with_index do |e,i|
@@ -785,6 +879,226 @@ def expand_braces(str)
   end
 end
 
+# AI INTEGRATION FUNCTIONS
+def get_ollama_model
+  begin
+    # Try to get list of available models
+    output = `ollama list 2>/dev/null`
+    return nil if output.empty? || $?.exitstatus != 0
+    
+    # Parse the output to find a suitable model
+    lines = output.split("\n")
+    return nil if lines.length < 2
+    
+    # Skip header line and get first available model
+    model_line = lines[1]
+    return nil if model_line.nil?
+    
+    # Extract model name (first column)
+    model_name = model_line.split(/\s+/)[0]
+    return model_name
+  rescue => e
+    return nil
+  end
+end
+
+def ai_query(prompt)
+  # Get AI model configuration
+  model = @aimodel || nil
+  key = @aikey || nil
+  
+  if model.nil? || model.empty?
+    # Try ollama first
+    if File.exist?("/usr/local/bin/ollama") || File.exist?("/usr/bin/ollama") || system("command -v ollama >/dev/null 2>&1")
+      begin
+        require 'json'
+        require 'net/http'
+        
+        # First, get available models
+        ollama_model = get_ollama_model()
+        return ai_setup_help unless ollama_model
+        
+        uri = URI('http://localhost:11434/api/generate')
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 30
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request.body = {
+          model: ollama_model,
+          prompt: prompt,
+          stream: false,
+          options: {
+            num_predict: 200
+          }
+        }.to_json
+        
+        response = http.request(request)
+        if response.code == '200'
+          result = JSON.parse(response.body)
+          return result['response']
+        else
+          return ai_setup_help
+        end
+      rescue => e
+        return ai_setup_help
+      end
+    else
+      return ai_setup_help
+    end
+  else
+    # Use external model
+    if model =~ /^gpt/i && key
+      begin
+        require 'json'
+        require 'net/http'
+        uri = URI('https://api.openai.com/v1/chat/completions')
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.read_timeout = 30
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request['Authorization'] = "Bearer #{key}"
+        request.body = {
+          model: model,
+          messages: [{role: 'user', content: prompt}],
+          max_tokens: 200,
+          temperature: 0.7
+        }.to_json
+        
+        response = http.request(request)
+        if response.code == '200'
+          result = JSON.parse(response.body)
+          return result['choices'][0]['message']['content']
+        else
+          return "Error: #{response.code} - #{response.body}"
+        end
+      rescue => e
+        return "Error connecting to OpenAI: #{e.message}"
+      end
+    else
+      return "Unsupported model: #{model}. Currently only ollama and OpenAI models are supported."
+    end
+  end
+end
+
+def ai_command_suggest(prompt)
+  # Get AI model configuration
+  model = @aimodel || nil
+  key = @aikey || nil
+  
+  # Modify prompt to request command output
+  cmd_prompt = "You are a Linux/Unix command line expert. Given this request: '#{prompt}', output ONLY the exact shell command that would accomplish this task. Output just the command itself with no explanation, no backticks, no markdown. For example, if asked 'list files' you would output: ls"
+  
+  if model.nil? || model.empty?
+    # Try ollama first
+    if File.exist?("/usr/local/bin/ollama") || File.exist?("/usr/bin/ollama") || system("command -v ollama >/dev/null 2>&1")
+      begin
+        require 'json'
+        require 'net/http'
+        
+        # First, get available models
+        ollama_model = get_ollama_model()
+        unless ollama_model
+          puts ai_setup_help
+          return nil
+        end
+        
+        uri = URI('http://localhost:11434/api/generate')
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 30
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request.body = {
+          model: ollama_model,
+          prompt: cmd_prompt,
+          stream: false,
+          options: {
+            num_predict: 50,
+            temperature: 0.3
+          }
+        }.to_json
+        
+        response = http.request(request)
+        if response.code == '200'
+          result = JSON.parse(response.body)
+          cmd = result['response'].strip.split("\n")[0]
+          return cmd
+        else
+          puts ai_setup_help
+          return nil
+        end
+      rescue => e
+        puts ai_setup_help
+        return nil
+      end
+    else
+      puts ai_setup_help
+      return nil
+    end
+  else
+    # Use external model
+    if model =~ /^gpt/i && key
+      begin
+        require 'json'
+        require 'net/http'
+        uri = URI('https://api.openai.com/v1/chat/completions')
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.read_timeout = 30
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request['Authorization'] = "Bearer #{key}"
+        request.body = {
+          model: model,
+          messages: [{role: 'user', content: cmd_prompt}],
+          max_tokens: 50,
+          temperature: 0.3
+        }.to_json
+        
+        response = http.request(request)
+        if response.code == '200'
+          result = JSON.parse(response.body)
+          cmd = result['choices'][0]['message']['content'].strip.split("\n")[0]
+          return cmd
+        else
+          puts "Error: #{response.code} - #{response.body}"
+          return nil
+        end
+      rescue => e
+        puts "Error connecting to OpenAI: #{e.message}"
+        return nil
+      end
+    else
+      puts "Unsupported model: #{model}. Currently only ollama and OpenAI models are supported."
+      return nil
+    end
+  end
+end
+
+def ai_setup_help
+  help_text = <<~HELP
+    
+    AI is not configured. To use AI features, you have two options:
+    
+    1. Install Ollama (recommended for local AI):
+       curl -fsSL https://ollama.com/install.sh | sh
+       ollama pull llama3.2  # or any model you prefer
+    
+    2. Configure external AI model in ~/.rshrc:
+       @aimodel = "gpt-4"
+       @aikey = "your-api-key-here"
+    
+    Once configured:
+    - Use @ for AI text responses: @ What is the GDP of Norway?
+    - Use @@ for AI command suggestions: @@ list files sorted by size
+  HELP
+  return help_text.c(@c_path)
+end
+
 # INITIAL SETUP
 begin # Load .rshrc and populate @history
   trap "SIGINT" do end
@@ -861,6 +1175,10 @@ loop do
       hi = @history[@cmd.sub(/^!(\d+)$/, '\1').to_i+1] 
       @cmd = hi if hi
     end
+    # Move cursor to end of line and print the full command before clearing
+    @c.row(@row0)
+    @c.clear_line
+    print @prompt + @cmd
     print "\n"; @c.clear_screen_down
     if @cmd == "r" # Integration with rtfm (https://github.com/isene/RTFM)
       t  = Time.now
@@ -877,6 +1195,23 @@ loop do
       @cmd.gsub!("  ", ",")
       @cmd = "echo \"#{@cmd[1...]},prx,off\" | xrpn" 
     end
+    # AI integration with @ and @@
+    if @cmd =~ /^@@\s+(.+)/ # AI command suggestion
+      prompt = $1
+      response = ai_command_suggest(prompt)
+      if response
+        # Store the suggestion for the next prompt
+        @ai_suggestion = response
+        # Also add to history for record keeping
+        @history.unshift(response)
+      end
+      next
+    elsif @cmd =~ /^@\s+(.+)/ # AI text response
+      prompt = $1
+      response = ai_query(prompt)
+      puts response if response
+      next
+    end
     if @cmd.match(/^\s*:/) # Ruby commands are prefixed with ":"
       begin
         eval(@cmd[1..-1])

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: ruby-shell
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-01 00:00:00.000000000 Z
+date: 2025-07-28 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. MAJOR
-  UPDATE v2.7.0: Ruby Functions - define custom shell commands using full Ruby power!
-  Also: job control (background jobs, Ctrl-Z suspension), command substitution, variable
-  expansion, conditional execution, login shell support, and much more.'
+  history, syntax highlighting, theming, auto-cd, auto-opening files and more. UPDATE
+  v2.9.0: AI integration! Use @ for AI text responses and @@ for AI command suggestions.
+  Works with local Ollama or external providers like OpenAI. v2.8.0: Enhanced help
+  system, :info command, and easier nick management. v2.7.0: Ruby Functions, job control,
+  command substitution, and more.'
 email: g@isene.com
 executables:
 - rsh