llm-shell 0.9.2 → 0.11.0

data/lib/llm/function.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Function
-  ##
-  # Returns true when a function is a built-in function
-  # @return [Boolean]
-  def builtin?
-    @builtin
-  end
-
-  ##
-  # Mark a function as a built-in function
-  # @return [void]
-  def builtin!
-    @builtin = true
-  end
-end

data/lib/llm/shell/command/extension.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  ##
-  # The {LLM::Shell::Command::Extension LLM::Shell::Command::Extension}
-  # module extends the `LLM` constant with methods that can provide shell
-  # commands for an active llm-shell session.
-  #
-  # @example hello command
-  #   LLM.command(:hello) do |cmd|
-  #     cmd.define do |name|
-  #       io.rewind.print("Hello #{name}")
-  #     end
-  #   end
-  module Extension
-    ##
-    # @example
-    #   LLM.command(:hello) do |cmd|
-    #     cmd.define do |name|
-    #       io.rewind.print("Hello #{name}")
-    #     end
-    #   end
-    # @param [String] name
-    #  The name of the command
-    # @yieldparam [LLM::Shell::Command] cmd
-    #  Yields an instance of LLM::Shell::Command
-    # @return [void]
-    def command(name)
-      cmd = LLM::Shell::Command.new
-      cmd.name(name)
-      yield cmd
-      commands[cmd.name] = cmd
-    end
-
-    ##
-    # @return [Hash<String, LLM::Shell::Command>]
-    def commands
-      @commands ||= {}
-    end
-  end
-  LLM.extend(Extension)
-end

data/lib/llm/shell/command.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell
-  class Command
-    require_relative "commands/utils"
-
-    ##
-    # @api private
-    class Context < Struct.new(:bot, :io)
-      def pager(...)
-        LLM::Shell.pager(...)
-      end
-    end
-
-    ##
-    # Returns the underlying command object
-    # @return [Class, #call]
-    attr_reader :object
-
-    ##
-    # Set or get the command name
-    # @param [String, nil] name
-    #  The name of the command
-    # @return [String]
-    def name(name = nil)
-      if name
-        @name = name
-      else
-        @name
-      end
-    end
-
-    ##
-    # Set or get the command description
-    # @param [String, nil] desc
-    #  The description of the command
-    # @return [String]
-    def description(desc = nil)
-      if desc
-        @description = desc
-      else
-        @description
-      end
-    end
-
-    ##
-    # Setup the command context
-    # @return [void]
-    def setup(bot, io)
-      @context = Context.new(bot, io)
-    end
-
-    ##
-    # Define the command
-    # @return [void]
-    def define(klass = nil, &b)
-      @object = klass || b
-    end
-    alias_method :register, :define
-
-    ##
-    # Call the command
-    # @reurn [void]
-    def call(*argv)
-      if @context.nil?
-        raise "context has not been setup"
-      elsif Class === @object
-        @object.new(@context).call(*argv)
-      else
-        @context.instance_exec(*argv, &@object)
-      end
-    end
-
-    ##
-    # @return [Boolean]
-    #  Returns true if this is a builtin command
-    def builtin?
-      @builtin
-    end
-
-    ##
-    # Mark this command as builtin command
-    # @return [void]
-    def builtin!
-      @builtin = true
-    end
-  end
-end

data/lib/llm/shell/commands/clear_screen.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class ClearScreen
-    require_relative "utils"
-    include Utils
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::ClearScreen]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Clears the screen
-    # @return [void]
-    def call = clear_screen
-
-    private
-
-    def console = IO.console
-    def clear_screen = console.clear_screen
-
-    LLM.command "clear-screen" do |cmd|
-      cmd.description "Clear the screen"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/dir_import.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class DirImport
-    require_relative "utils"
-    include Utils
-
-    ##
-    # Completes a path with a wildcard.
-    # @param path [String]
-    #  The path to complete.
-    # @return [Array<String>]
-    #  Returns the completed path(s)
-    def self.complete(path)
-      Dir["#{path}*"]
-    end
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::DirImport]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Recursively imports all files in a directory.
-    # @return [void]
-    def call(dir)
-      Dir.entries(dir).each do |file|
-        if file == "." || file == ".."
-          next
-        elsif File.directory? File.join(dir, file)
-          call File.join(dir, file)
-        else
-          import File.join(dir, file)
-        end
-      end
-    end
-
-    private
-
-    LLM.command "dir-import" do |cmd|
-      cmd.description "Share a directory with the LLM"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/file_import.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class FileImport
-    require_relative "utils"
-    include Utils
-
-    ##
-    # Completes a path with a wildcard.
-    # @param path [String]
-    #  The path to complete.
-    # @return [Array<String>]
-    #  Returns the completed path(s)
-    def self.complete(path)
-      Dir["#{path}*"]
-    end
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::FileImport]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Imports one or more globbed files.
-    # @return [void]
-    def call(*files)
-      Dir[*files].each { import(_1) }
-    end
-
-    private
-
-    LLM.command "file-import" do |cmd|
-      cmd.description "Share a file with the LLM"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/help.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class Help
-    require_relative "utils"
-    include Utils
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::Help]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Prints help
-    # @return [void]
-    def call
-      pager do |io|
-        render_commands(io)
-        render_functions(io)
-      end
-    end
-
-    private
-
-    def render_commands(io)
-      io.print(Paint["Commands", :bold, :underline], "\n\n")
-      io.print(Paint["Builtin", :bold], "\n\n")
-      render_group commands.select(&:builtin?), io, :cyan
-      io.print(Paint["User", :bold], "\n\n")
-      render_group commands.reject(&:builtin?), io, :cyan
-    end
-
-    def render_functions(io)
-      io.print(Paint["Functions", :bold, :underline], "\n\n")
-      io.print(Paint["Builtin", :bold], "\n\n")
-      render_group functions.select(&:builtin?), io, :blue
-      io.print(Paint["User", :bold], "\n\n")
-      render_group functions.reject(&:builtin?), io, :blue
-    end
-
-    def render_group(commands, io, bgcolor)
-      if commands.empty?
-        io.print(Paint["None available", :yellow], "\n\n")
-      else
-        commands.each.with_index(1) do |command, index|
-          io.print(name(command, index, bgcolor), "\n")
-          io.print(desc(command), "\n\n")
-        end
-      end
-    end
-
-    def commands = LLM.commands.values.sort_by(&:name)
-    def functions = LLM.functions.values.sort_by(&:name)
-    def name(command, index, bgcolor) = [Paint[" #{index} ", :white, bgcolor, :bold], " ", Paint[command.name, :bold]].join
-    def desc(command) = command.description || "No description"
-
-    LLM.command "help" do |cmd|
-      cmd.description "Show the help menu"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/show_chat.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class ShowChat
-    require_relative "utils"
-    include Utils
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::ShowChat]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Emits the full chat history to standard output
-    # @return [void]
-    def call
-      clear_screen
-      emit
-    end
-
-    private
-
-    def emit
-      pager do |io|
-        messages.each.with_index do |message, index|
-          next if index <= 1
-          io << render(message) << "\n"
-        end
-      end
-    end
-
-    def console = IO.console
-    def clear_screen = console.clear_screen
-    def messages = bot.messages
-    def render(message) = LLM::Shell::Renderer.new(message).render
-
-    LLM.command "show-chat" do |cmd|
-      cmd.description "Show the chat"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/show_version.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class ShowVersion
-    require_relative "utils"
-    include Utils
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::ShowVersion]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Shows the current llm-shell version
-    # @return [void]
-    def call
-      pager do |io|
-        io.write("llm-shell version: #{LLM::Shell::VERSION}\n")
-      end
-    end
-
-    private
-
-    LLM.command "show-version" do |cmd|
-      cmd.description "Show the llm-shell version"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/system_prompt.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  class SystemPrompt
-    require_relative "utils"
-    include Utils
-
-    ##
-    # @param [LLM::Shell::Context] context
-    #  The context of the command
-    # @return [LLM::Shell::Command::SystemPrompt]
-    def initialize(context)
-      @context = context
-    end
-
-    ##
-    # Emits the system prompt to standard output
-    # @return [void]
-    def call
-      pager do |io|
-        io.write render(bot.messages[0])
-      end
-    end
-
-    private
-
-    def render(message) = LLM::Shell::Renderer.new(message).render
-
-    LLM.command "system-prompt" do |cmd|
-      cmd.description "Show the system prompt"
-      cmd.register(self)
-      cmd.builtin!
-    end
-  end
-end

data/lib/llm/shell/commands/utils.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell::Command
-  module Utils
-    private
-
-    def import(file)
-      return unless File.file?(file)
-      bot.chat [
-        "<file path=\"#{file}\">",
-        File.read(file),
-        "</file>"
-      ].join("\n")
-    end
-
-    def bot = @context.bot
-    def io = @context.io
-    def pager(...) = @context.pager(...)
-    def file_pattern = /\A<file path=(.+?)>/
-  end
-end

data/lib/llm/shell/completion.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell
-  class Completion
-    ##
-    # Returns a proc suitable for Readline completion.
-    # @return [Proc]
-    def self.to_proc
-      new.to_proc
-    end
-
-    ##
-    # @return [LLM::Shell::Completion]
-    def initialize
-      @commands = LLM.commands
-    end
-
-    ##
-    # Returns a proc suitable for Readline completion.
-    # @return [Proc]
-    def to_proc
-      method(:complete).to_proc
-    end
-
-    private
-
-    def complete(input)
-      words = Readline.line_buffer.split(" ")
-      command = words[0]
-      if commands[command]
-        object = commands[command].object
-        object.respond_to?(:complete) ? object.complete(input) : []
-      else
-        commands.keys.grep(/\A#{command}/)
-      end
-    end
-
-    attr_reader :commands
-  end
-end

data/lib/llm/shell/config.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell
-  class Config
-    ##
-    # @param [String] provider
-    # @return [LLM::Shell::Config]
-    def initialize(provider)
-      @provider = provider
-    end
-
-    ##
-    # @return [Hash]
-    def merge(other)
-      to_h.merge(other)
-    end
-
-    ##
-    # @return [Hash]
-    def to_h
-      yaml[@provider] || {}
-    end
-
-    private
-
-    def yaml
-      return {} unless File.readable?(path)
-      @yaml ||= YAML.load_file(path)
-    end
-
-    def path
-      File.join LLM::Shell.home, "config.yml"
-    end
-  end
-end

data/lib/llm/shell/default.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell
-  class Default
-    def initialize(provider)
-      @provider = provider
-    end
-
-    def prompt
-      File.join(SHAREDIR, "prompts", "default.txt")
-    end
-
-    def role
-      case @provider
-      when "openai", "ollama" then :system
-      else :user
-      end
-    end
-
-    SHAREDIR = File.join(__dir__, "..", "..", "..", "share", "llm-shell")
-    private_constant :SHAREDIR
-  end
-end

data/lib/llm/shell/formatter.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-class LLM::Shell
-  class Formatter
-    FormatError = Class.new(RuntimeError)
-    include Command::Utils
-
-    def initialize(messages)
-      @messages = messages.reject(&:tool_call?)
-    end
-
-    def format!(role)
-      case role
-      when :user then format_user(messages)
-      when :assistant then format_assistant(messages)
-      else raise FormatError.new("#{role} is not known")
-      end
-    end
-
-    private
-
-    def format_user(messages)
-      messages.filter_map do |message|
-        next unless message.user?
-        next unless String === message.content
-        next unless message.content !~ file_pattern
-        render(message.tap(&:read!))
-      end.join("\n")
-    end
-
-    def format_assistant(messages)
-      messages.filter_map do |message|
-        next unless message.assistant?
-        next unless String === message.content
-        render(message.tap(&:read!))
-      end.join("\n")
-    end
-
-    attr_reader :messages
-    def render(message) = Renderer.new(message).render
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module LLM::Shell::Functions
-  class ReadFile
-    def call(path:)
-      {ok: true, content: File.read(path)}
-    rescue => ex
-      {ok: false, error: {class: ex.class.to_s, message: ex.message}}
-    end
-
-    private
-
-    LLM.function(:read_file) do |fn|
-      fn.description "Read the contents of a file"
-      fn.params do |schema|
-        schema.object(path: schema.string.required)
-      end
-      fn.register(self)
-      fn.builtin!
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module LLM::Shell::Functions
-  class WriteFile
-    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
-
-    private
-
-    LLM.function(:write_file) do |fn|
-      fn.description "Write the contents of a file"
-      fn.params do |schema|
-        schema.object(path: schema.string.required, content: schema.string.required)
-      end
-      fn.register(self)
-      fn.builtin!
-    end
-  end
-end