llm-shell 0.9.2 → 0.10.0

data/lib/llm/shell/repl.rb

@@ -21,11 +21,9 @@ class LLM::Shell
     # Performs initial setup
     # @return [void]
     def setup
-      LLM::Shell.commands.each { |file| require file }
-      Readline.completion_proc = Completion.to_proc
-      chat options.prompt, role: options.default.role
-      files.each { chat ["--- START: #{_1} ---", File.read(_1), "--- END: #{_1} ---"].join("\n") }
-      bot.messages.each(&:read!)
+      Reline.completion_proc = Completion.to_proc
+      chat(options.prompt, role: options.default.role).flush
+      unread.each(&:read!)
       clear_screen
     end
 
@@ -52,15 +50,13 @@ class LLM::Shell
     private
 
     def read
-      input = Readline.readline("llm> ", true) || throw(:exit, 0)
+      input = Reline.readline("llm> ", true) || throw(:exit, 0)
       words = input.split(" ")
-      if LLM.commands[words[0]]
-        cmd  = LLM.commands[words[0]]
+      if cmd = LLM::Shell.find_command(words[0])
         argv = words[1..]
-        cmd.setup(bot, io)
-        cmd.call(*argv)
+        cmd.new(bot, io).call(*argv)
       else
-        chat input.tap { clear_screen }
+        chat(input.tap { clear_screen }, tools:)
         io.rewind.print(Paint["Thinking", :bold])
         unread.tap { io.rewind }
       end
@@ -71,10 +67,12 @@ class LLM::Shell
       cancels = []
       results = []
       functions.each do |function|
+        args = function.arguments.to_json
         print Paint["system", :bold, :red], " says: ", "\n"
-        print "function: ", function.name, "\n"
-        print "arguments: ", function.arguments.to_h.size, "\n"
-        input = Readline.readline("Do you want to call it ? ", true)
+        print "function ".ljust(20), function.name, "\n"
+        print "arguments ".ljust(20), ((args.size >= 80) ? "#{args[0..79]} ...}" : args), "\n"
+        print "argument count".ljust(20), function.arguments.to_h.size, "\n\n"
+        input = Reline.readline("Should we proceed? ", true)
         puts
         if %w(y yes yep yeah ok).include?(input)
           callables << function
@@ -84,7 +82,7 @@ class LLM::Shell
       end
       results.concat callables.map(&:call)
       results.concat cancels.map(&:cancel)
-      bot.chat(results)
+      bot.chat(results).flush
     end
 
     def emit
@@ -94,12 +92,19 @@ class LLM::Shell
       end unless unread.empty?
     end
 
+    ##
+    # @return [Array<LLM::Tool>]
+    def tools
+      LLM::Shell
+        .tools
+        .select(&:enabled?)
+    end
+
     attr_reader :bot, :console, :io, :default, :options
 
     def formatter(messages) = Formatter.new(messages)
     def unread = bot.messages.unread
     def functions = bot.functions
-    def files = @options.files
     def clear_screen = console.clear_screen
     def chat(...) = bot.chat(...)
   end

data/lib/llm/shell/tool.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class LLM::Tool
+  module Patch
+    ##
+    # Returns true for an enabled tool
+    # @return [Boolean]
+    def enabled?
+      @enabled
+    end
+
+    ##
+    # Enable the tool
+    # @return [void]
+    def enable!
+      @enabled = true
+    end
+
+    ##
+    # Disable the tool
+    # @return [void]
+    def disable!
+      @enabled = false
+    end
+
+    ##
+    # @return [Boolean]
+    def builtin?
+      path, _ = instance_method(:call).source_location
+      path&.include?(LLM::Shell.root)
+    end
+  end
+
+  m = method(:inherited)
+  define_singleton_method(:inherited) do |tool|
+    LLM::Shell.tools << tool
+    m.call(tool)
+    tool.enable!
+  end
+
+  extend Patch
+end

data/lib/llm/shell/tools/read_file.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LLM::Shell::Tools
+  class ReadFile < LLM::Tool
+    name "read-file"
+    description "Read the contents of a file"
+    param :path, String, "The path to a file", required: true
+
+    def call(path:)
+      {ok: true, content: File.read(path)}
+    rescue => ex
+      {ok: false, error: {class: ex.class.to_s, message: ex.message}}
+    end
+  end
+end

data/lib/llm/shell/tools/system.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LLM::Shell::Tools
+  class System < LLM::Tool
+    name "system"
+    description "Run a system command"
+    param :command, String, "The command to execute", required: true
+
+    def call(command:)
+      ro, wo = IO.pipe
+      re, we = IO.pipe
+      Process.wait Process.spawn(command, out: wo, err: we)
+      [wo, we].each(&:close)
+      {stderr: re.read, stdout: ro.read}
+    end
+  end
+end

data/lib/llm/shell/tools/write_file.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LLM::Shell::Tools
+  class WriteFile < LLM::Tool
+    name "write-file"
+    description "Write the contents of a file"
+    param :path, String, "The path to a file", required: true
+    param :content, String, "The contents of a file", required: true
+
+    def call(path:, content:)
+      {ok: true, content: File.binwrite(path, content)}
+    rescue => ex
+      {ok: false, error: {class: ex.class.to_s, message: ex.message}}
+    end
+  end
+end

data/lib/llm/shell/version.rb

@@ -4,5 +4,5 @@ module LLM
 end unless defined?(LLM)
 
 class LLM::Shell
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/llm/shell.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-require "optparse"
-require "readline"
-require "yaml"
-require "llm"
-require "paint"
+module LLM
+  $:.unshift(*Dir[File.join(__dir__, "shell", "internal", "*", "lib")])
+  require "optparse"
+  require "io/line"
+  require "paint"
+  require "reline"
+  require "coderay"
+  require "llm"
+  require "tomlrb"
+end
 
 class LLM::Shell
-  require_relative "function"
-  require_relative "../io/line"
+  require_relative "shell/tool"
   require_relative "shell/command"
-  require_relative "shell/command/extension"
   require_relative "shell/markdown"
   require_relative "shell/renderer"
   require_relative "shell/formatter"
@@ -22,48 +25,81 @@ class LLM::Shell
   require_relative "shell/version"
 
   ##
-  # Load all commands
-  Dir[File.join(__dir__, "shell", "commands", "*.rb")].each { require(_1) }
+  # Returns the lib/ directory
+  # @return [String]
+  def self.root
+    __dir__
+  end
 
   ##
-  # Opens a pager
-  # @return [void]
-  def self.pager(...)
-    IO.popen("less -FRX", "w", ...)
+  # Returns the directory where configuration files are kept
+  # @return [String]
+  def self.home_config
+    if ENV.key?("XDG_CONFIG_HOME")
+      ENV["XDG_CONFIG_HOME"]
+    else
+      File.join Dir.home, ".config"
+    end
   end
 
   ##
+  # Returns the directory where commands and tools are kept
   # @return [String]
-  def self.home
-    File.join Dir.home, ".llm-shell"
+  def self.home_data
+    if ENV.key?("XDG_DATA_HOME")
+      File.join ENV["XDG_DATA_HOME"], ".llm-shell"
+    else
+      File.join Dir.home, ".local", "share", ".llm-shell"
+    end
   end
 
   ##
-  # @return [Array<String>]
+  # @return [Array<LLM::Command>]
+  def self.commands
+    @commands ||= []
+  end
+
+  ##
+  # @return [Array<LLM::Tool>]
   def self.tools
-    Dir[*TOOLGLOBS]
+    @tools ||= []
   end
 
   ##
-  # @return [Array<String>]
-  def self.commands
-    Dir[File.join(home, "commands", "*.rb")]
+  # Returns an instance of {LLM::Command LLM::Command}, or nil.
+  # @return [LLM::Command, nil]
+  def self.find_command(name)
+    commands.find { _1.name == name }
   end
 
-  TOOLGLOBS = [
-    File.join(home, "tools", "*.rb"),
-    File.join(__dir__, "shell", "functions", "*.rb")
-  ].freeze
-  private_constant :TOOLGLOBS
+  ##
+  # @return [Regexp]
+  def self.pattern
+    /\A<file path=(.+?)>/
+  end
 
   ##
-  # @param [Hash] options
+  # Opens a pager
+  # @return [void]
+  def self.pager(...)
+    IO.popen("less -FRX", "w", ...)
+  end
+
+  ##
+  # Load commands & tools
+  Dir[File.join(home_data, "commands", "*.rb")].each { require(_1) }
+  Dir[File.join(home_data, "tools", "*.rb")].each { require(_1) }
+  Dir[File.join(root, "shell", "commands", "*.rb")].each { require(_1) }
+  Dir[File.join(root, "shell", "tools", "*.rb")].each { require(_1) }
+
+  ##
+  # @param [Hash] opts
   # @return [LLM::Shell]
-  def initialize(options)
-    @config  = Config.new(options[:provider])
-    @options = Options.new @config.merge(options), Default.new(options[:provider])
-    @bot  = LLM::Bot.new(llm, {tools:}.merge(@options.bot))
-    @repl = REPL.new(bot: @bot, options: @options)
+  def initialize(opts)
+    @config  = Config.new(opts[:provider])
+    @options = Options.new @config.merge(opts), Default.new(opts[:provider])
+    @bot  = LLM::Bot.new(llm, options.bot)
+    @repl = REPL.new(bot:, options:)
   end
 
   ##
@@ -76,13 +112,21 @@ class LLM::Shell
 
   private
 
-  def tools
-    LLM::Shell.tools.map do |path|
-      eval File.read(path), TOPLEVEL_BINDING, path, 1
-    end.grep(LLM::Function)
+  attr_reader :options, :bot, :repl
+
+  ##
+  # @return [Method]
+  def provider
+    LLM.method(options.provider)
   end
 
-  attr_reader :options, :bot, :repl
-  def provider = LLM.method(options.provider)
-  def llm = provider.call(**options.llm)
+  ##
+  # @return [LLM::Provider]
+  def llm
+    provider.call(**options.llm)
+  end
 end
+
+module LLM
+  Command = LLM::Shell::Command
+end

data/libexec/llm-shell/shell

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../../lib/llm/shell"
-
 def main(argv)
   if argv.include?("-v") || argv.include?("--version")
     puts LLM::Shell::VERSION
@@ -26,20 +24,20 @@ def option_parser
     o.on("-m [MODEL]", "--model [MODEL]", "Optional. The name of a model.", Array)
     o.on("-h [HOST]", "--host [HOST]", "Optional. Sometimes required by ollama.", String)
     o.on("-o [PORT]", "--port [PORT]", "Optional. Sometimes required by ollama.", Integer)
-    o.on("-f [GLOB]", "--files [GLOB]", "Optional. Glob pattern(s) separated by a comma.", Array)
     o.on("-r [PROMPT]", "--prompt [PROMPT]", "Optional. The prompt to use.", String)
     o.on("-v", "--version", "Optional. Print the version and exit.")
   end
 end
 
 excode = catch(:exit) do
+  require_relative "../../lib/llm/shell"
   main(ARGV)
-  0
+  throw(:exit, 0)
 rescue => ex
   print Paint[ex.class, :red, :bold], "\n"
   print ex.message, "\n\n"
   print Paint["Backtrace", :bold], "\n"
-  print ex.backtrace[0..5].join("\n"), "\n"
-  1
+  print ex.backtrace[0..7].join("\n"), "\n"
+  throw(:exit, 1)
 end
 exit excode

data/llm-shell.gemspec

@@ -28,11 +28,7 @@ Gem::Specification.new do |spec|
   ]
   spec.require_paths = ["lib"]
   spec.executables = ["llm-shell"]
-  spec.add_dependency "llm.rb", "~> 0.13"
-  spec.add_dependency "paint", "~> 2.1"
   spec.add_dependency "redcarpet", "~> 3.6"
-  spec.add_dependency "coderay", "~> 1.1"
-  spec.add_dependency "reline", "~> 0.6"
   spec.add_development_dependency "webmock", "~> 3.24.0"
   spec.add_development_dependency "yard", "~> 0.9.37"
   spec.add_development_dependency "kramdown", "~> 2.4"