llm-shell 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efb0705b4587fa15f19e6852175f7a6dded3bc75f625a1c4ffcbca4fcce6420a
-  data.tar.gz: ce14f5402a2e855624c1a3918adb770374eeb1d940be0df2ca8cd5923569bd21
+  metadata.gz: 89ffe0d7aacb89de310acc7012fb8b383d9c27e0059536ff9ce7ea855f604c37
+  data.tar.gz: eb1cd003da504a27f6859898c21339406536a4979cf0fea6f1d6740bb2ea9328
 SHA512:
-  metadata.gz: 8ca3ed72d628a401768d096375878b1b9d020e9ced3ee146ebff9de04d0b6a96dab6057b8655a22a50ca19d19cdbbe01b7ca8347553177afba3634691646a83d
-  data.tar.gz: 95b383749b9a06bf8f56a1a50a5033592a2bb629c4343441f367ab19c09c6d9cebb5b0431a0b8429d4ccbbcec631380643bb5d8be88a970a907e0d18fffdbb46
+  metadata.gz: aa30fcd97acd567fa2c53d7c5936063e0442a3b9e8a2a4a2d721557dd704af57710f4e3d6389c0da9d9e2bf9babacb2e74f51f800f239c65a18d8da4d429f9c2
+  data.tar.gz: '0900fcbd3c39c95c3941494f93863b8a11f78a69305c4d8dce31c3a87a2391f4940b97743c3f6812e3acb185be40d85f2a3003a5d75de19cc7f94153773f380c'

data/README.md

@@ -80,10 +80,12 @@ end
 llm-shell can be extended with your own console commands. This can be
 done by creating a Ruby file in the `~/.llm-shell/commands/` directory –
 with one file per command. The commands are loaded at boot time. See the
-[file-import](lib/llm/shell/commands/file_import.rb)
-and
-[dir-import](lib/llm/shell/commands/dir_import.rb)
-commands for a realistic example:
+[file-import](lib/llm/shell/commands/file_import.rb),
+[dir-import](lib/llm/shell/commands/dir_import.rb),
+[show-history](lib/llm/shell/commands/show_history.rb),
+[clear-screen](lib/llm/shell/commands/clear_screen.rb)
+and [system-prompt](lib/llm/shell/commands/system_prompt.rb)
+commands for more realistic examples:
 
 ```ruby
 LLM.command "say-hello" do |cmd|
@@ -93,6 +95,24 @@ LLM.command "say-hello" do |cmd|
   end
 end
 ```
+
+#### Prompts
+
+> It is recommended that custom prompts instruct the LLM to emit markdown,
+> otherwise you might see unexpected results because llm-shell assumes the LLM
+> will emit markdown.
+
+The first message in a conversation is sometimes known as a "system prompt",
+and it defines the expectations and rules to be followed by an LLM throughout
+a conversation. The default prompt used by llm-shell can be found at
+[default.txt](share/llm-shell/prompts/default.txt).
+
+The prompt can be changed by adding a file to the `~/.llm-shell/prompts/` directory,
+and then choosing it at boot time with the `-r PROMPT`, `--prompt PROMPT` options.
+Generally you probably want to fork [default.txt](share/llm-shell/prompts/default.txt)
+to conserve the original prompt rules around markdown and files, then modify it to
+suit your own needs and preferences.
+
 ## Settings
 
 #### YAML

data/bin/llm-shell

@@ -18,3 +18,4 @@ rescue Interrupt
   wait
 end
 main(ARGV)
+exit $?&.exitstatus || 1

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

@@ -1,6 +1,17 @@
 # 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

data/lib/llm/shell/command.rb

@@ -2,6 +2,7 @@
 
 class LLM::Shell
   class Command
+    require_relative "commands/utils"
     Context = Struct.new(:bot, :io)
 
     ##

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

@@ -0,0 +1,31 @@
+# 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 "Clears the screen"
+      cmd.register(self)
+    end
+  end
+end

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

@@ -2,6 +2,9 @@
 
 class LLM::Shell::Command
   class DirImport
+    require_relative "utils"
+    include Utils
+
     ##
     # Completes a path with a wildcard.
     # @param path [String]
@@ -37,21 +40,9 @@ class LLM::Shell::Command
 
     private
 
-    def import(file)
-      return unless File.file?(file)
-      bot.chat [
-        "--- START: #{file} ---",
-        File.read(file),
-        "--- END: #{file} ---"
-      ].join("\n")
+    LLM.command "dir-import" do |cmd|
+      cmd.description "Share the contents of a directory with the LLM"
+      cmd.register(self)
     end
-
-    def bot = @context.bot
-    def io = @context.io
-  end
-
-  LLM.command "dir-import" do |cmd|
-    cmd.description "Share the contents of a directory with the LLM"
-    cmd.register(DirImport)
   end
 end

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

@@ -2,6 +2,9 @@
 
 class LLM::Shell::Command
   class FileImport
+    require_relative "utils"
+    include Utils
+
     ##
     # Completes a path with a wildcard.
     # @param path [String]
@@ -29,21 +32,9 @@ class LLM::Shell::Command
 
     private
 
-    def import(file)
-      return unless File.file?(file)
-      bot.chat [
-        "--- START: #{file} ---",
-        File.read(file),
-        "--- END: #{file} ---"
-      ].join("\n")
+    LLM.command "file-import" do |cmd|
+      cmd.description "Share one or more files with the LLM"
+      cmd.register(self)
     end
-
-    def bot = @context.bot
-    def io = @context.io
-  end
-
-  LLM.command "file-import" do |cmd|
-    cmd.description "Share one or more files with the LLM"
-    cmd.register(FileImport)
   end
 end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class LLM::Shell::Command
+  class ShowHistory
+    require_relative "utils"
+    include Utils
+
+    ##
+    # @param [LLM::Shell::Context] context
+    #  The context of the command
+    # @return [LLM::Shell::Command::ShowHistory]
+    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
+      IO.popen("less -FRX", "w") 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-history" do |cmd|
+      cmd.description "Show the full chat history"
+      cmd.register(self)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# 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 = puts render(bot.messages.to_a[0])
+
+    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)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# 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 file_pattern = /\A<file path=(.+?)>/
+    def bot = @context.bot
+    def io = @context.io
+  end
+end

data/lib/llm/shell/default.rb

@@ -7,7 +7,7 @@ class LLM::Shell
     end
 
     def prompt
-      File.read File.join(SHAREDIR, "prompts", "default.txt")
+      File.join(SHAREDIR, "prompts", "default.txt")
     end
 
     def role

data/lib/llm/shell/formatter.rb

@@ -3,7 +3,7 @@
 class LLM::Shell
   class Formatter
     FormatError = Class.new(RuntimeError)
-    FILE_REGEXP = /\A--- START: (.+?) ---/
+    include Command::Utils
 
     def initialize(messages)
       @messages = messages.reject(&:tool_call?)
@@ -19,17 +19,12 @@ class LLM::Shell
 
     private
 
-    attr_reader :messages
-
     def format_user(messages)
       messages.filter_map do |message|
         next unless message.user?
         next unless String === message.content
-        next unless message.content !~ FILE_REGEXP
-        role  = Paint[message.role, :bold, :yellow]
-        title = "#{role} says: "
-        body  = wrap(message.tap(&:read!).content)
-        [title, "\n", render(body), "\n"].join
+        next unless message.content !~ file_pattern
+        render(message.tap(&:read!))
       end.join("\n")
     end
 
@@ -37,19 +32,11 @@ class LLM::Shell
       messages.filter_map do |message|
         next unless message.assistant?
         next unless String === message.content
-        role  = Paint[message.role, :bold, :green]
-        title = "#{role} says: "
-        body  = wrap(message.tap(&:read!).content)
-        [title, "\n", render(body)].join
+        render(message.tap(&:read!))
       end.join("\n")
     end
 
-    def render(text)
-      Markdown.new(text).to_ansi
-    end
-
-    def wrap(text, width = 80)
-      text.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
-    end
+    attr_reader :messages
+    def render(message) = Renderer.new(message).render
   end
 end

data/lib/llm/shell/options.rb

@@ -15,6 +15,7 @@ class LLM::Shell
       @options  = options.transform_keys(&:to_sym)
       @provider = @options.delete(:provider)
       @tools    = @options.delete(:tools)
+      @prompt   = @options[:prompt] ? custom_prompt : default.prompt
       @files    = Dir[*@options.delete(:files) || []].reject { File.directory?(_1) }
       @bot_options = {model: @options.delete(:model)}.compact
       @default  = default
@@ -26,6 +27,13 @@ class LLM::Shell
     def llm = @options
     def bot = @bot_options
     def default = @default
-    def prompt = default.prompt
+    def prompt = File.read(@prompt)
+
+    private
+
+    def custom_prompt
+      prompt = @options.delete(:prompt)
+      File.join(LLM::Shell.home, "prompts", prompt)
+    end
   end
 end

data/lib/llm/shell/renderer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class LLM::Shell
+  class Renderer
+    RenderError = Class.new(RuntimeError)
+    include Command::Utils
+
+    ##
+    # @param [LLM::Message] message
+    #  The message to render
+    # @return [LLM::Shell::MessageRenderer]
+    #  Returns an instance of the renderer
+    def initialize(message)
+      @message = message
+    end
+
+    def render
+      if message.user?
+        render_message(message, :yellow)
+      elsif message.assistant?
+        render_message(message, :green)
+      elsif message.system?
+        render_message(message, :red)
+      else
+        raise RenderError.new("no handler for message role '#{message.role}'")
+      end
+    end
+
+    private
+
+    def render_message(message, color)
+      role  = Paint[message.role, :bold, color]
+      title = "#{role} says: "
+      if message.content =~ file_pattern
+        path = message.content.match(file_pattern) ? Regexp.last_match[1] : nil
+        body = "<file path=#{path} />"
+      else
+        body  = markdown(wrap(message.content))
+      end
+      [title, "\n", body, "\n"].join
+    end
+
+    attr_reader :message
+    def markdown(text) = Markdown.new(text).to_ansi
+    def wrap(text, width = 80) = text.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+  end
+end

data/lib/llm/shell/repl.rb

@@ -24,7 +24,7 @@ class LLM::Shell
       LLM::Shell.commands.each { |file| require file }
       Readline.completion_proc = Completion.to_proc
       chat options.prompt, role: options.default.role
-      files.each { bot.chat ["--- START: #{_1} ---", File.read(_1), "--- END: #{_1} ---"].join("\n") }
+      files.each { chat ["--- START: #{_1} ---", File.read(_1), "--- END: #{_1} ---"].join("\n") }
       bot.messages.each(&:read!)
       clear_screen
     end
@@ -37,7 +37,7 @@ class LLM::Shell
         read
         eval
         emit
-      rescue LLM::Error::ResponseError => ex
+      rescue LLM::ResponseError => ex
         print Paint[ex.response.class, :red], "\n"
         print ex.response.body, "\n"
       rescue => ex
@@ -51,16 +51,6 @@ class LLM::Shell
 
     private
 
-    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 read
       input = Readline.readline("llm> ", true) || throw(:exit, 0)
       words = input.split(" ")
@@ -85,11 +75,11 @@ class LLM::Shell
         input = $stdin.gets.chomp.downcase
         puts
         if %w(y yes yep yeah ok).include?(input)
-          bot.chat function.call
+          chat function.call
           unread.tap { io.rewind }
         else
-          bot.chat function.cancel
-          bot.chat "I decided to not run the function this time. Maybe next time."
+          chat function.cancel
+          chat "I decided to not run the function this time. Maybe next time."
         end
       end
     end
@@ -98,14 +88,16 @@ class LLM::Shell
       IO.popen("less -FRX", "w") do
         _1.write formatter(unread).format!(:user), "\n"
         _1.write formatter(unread).format!(:assistant), "\n"
-      end
+      end unless unread.empty?
     end
 
-    def chat(...)
-      case options.provider
-      when :openai then bot.respond(...)
-      else bot.chat(...)
-      end
-    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
 end

data/lib/llm/shell/version.rb

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

data/lib/llm/shell.rb

@@ -11,6 +11,7 @@ class LLM::Shell
   require_relative "shell/command"
   require_relative "shell/command/extension"
   require_relative "shell/markdown"
+  require_relative "shell/renderer"
   require_relative "shell/formatter"
   require_relative "shell/default"
   require_relative "shell/options"

data/libexec/llm-shell/shell

@@ -28,12 +28,19 @@ def option_parser
     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("-t [TOOLS]", "--tools [TOOLS]", "Optional. One or more tool names to load automatically.", 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) {
+excode = catch(:exit) do
   main(ARGV)
   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
+end
 exit excode

data/share/llm-shell/prompts/default.txt

@@ -1,27 +1,21 @@
-/no_think
+## Task
 
-## General
+Your task is to provide helpful assistance to the user.
 
-You are a helpful assistant.
-Answer the user's questions as best as you can.
+## Context
 
-The user's environment is a terminal.
-Provide short and concise answers that are suitable for a terminal.
-Do not provide long answers.
+The user is talking to you from a terminal-based application.
 
-## Files
+## Inputs
 
-One or more files *MIGHT* be provided at the start of the conversation.
-One file will be provided per message, *IF* any files are provided at all.
-*IF* a file is provided, it will be in this format:
+The user might send you the content of file(s) from their filesystem.
+When the user sends you a file, it will be in this format:
 
---- START: /path/to/file ---
-<contents>
---- END: /path/to/file ---
+<file path="/path/to/file">
+  CONTENT
+</file>
 
-Otherwise, no files will be provided and you shouldn't mention them.
-On receipt of one or more files, you will respond with: Got it. And with nothing else.
+## Outputs
 
-## Format
-
-Respond in markdown.
+Always respond in markdown.
+When the user sends a file, reply with "Got it" and nothing else.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm-shell
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Antar Azri
@@ -223,14 +223,19 @@ files:
 - lib/llm/shell.rb
 - lib/llm/shell/command.rb
 - lib/llm/shell/command/extension.rb
+- lib/llm/shell/commands/clear_screen.rb
 - lib/llm/shell/commands/dir_import.rb
 - lib/llm/shell/commands/file_import.rb
+- lib/llm/shell/commands/show_history.rb
+- lib/llm/shell/commands/system_prompt.rb
+- lib/llm/shell/commands/utils.rb
 - lib/llm/shell/completion.rb
 - lib/llm/shell/config.rb
 - lib/llm/shell/default.rb
 - lib/llm/shell/formatter.rb
 - lib/llm/shell/markdown.rb
 - lib/llm/shell/options.rb
+- lib/llm/shell/renderer.rb
 - lib/llm/shell/repl.rb
 - lib/llm/shell/version.rb
 - libexec/llm-shell/shell