llm-shell 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0985d061b38dccb46cdeebd598133d17b634cf035f6b9ca688f48539df553c09'
-  data.tar.gz: fe594a519302eb963f727e967b6f5bd596d7b97a3b3cebe52b56a1a466b8faf8
+  metadata.gz: 12bc22975d67ab780255d8c35fc91d6578ddf880db5e10ae639e70d67be7b275
+  data.tar.gz: ebb7794394c964e7b6ec0e0a18b72678b857d4f22369c05cc6a799de73b6f0db
 SHA512:
-  metadata.gz: 0e59a342f4356617da679699f483babae1eba0f05cabb4c9ae72ef0993a8d5d71d6565aa508c764f5e4e41f4267159ded1685821425624c99215b3a0c5257a9d
-  data.tar.gz: 7239d794cb6dc952d61286c510347d18da9bc15115ab4c45ab2fb51a44a05a0d5e347309629da927ee7965b93f9fab870f8dcb52a909680a2dc7499ee79f9ed3
+  metadata.gz: c9b748161d32e911d952a1f326f5be0df9be043a70ceefbaccdf92e7456b5bc2dab2ac54d35e74ca1f68275fa16715f672665e248a1b0621ba030a8a072106d9
+  data.tar.gz: 6fe177aea6672502327c4b1bbfd3a4e27ebe9c1d527c93911876c3f8213a87cbe131353a6407563221b2ed44db112215a85e0a18e5c108fd66dea26fdc59e6b9

data/README.md

@@ -36,7 +36,12 @@ it in action.
 
 <details>
   <summary><b>2. Add files as conversation context</b></summary>
-  <img src="share/llm-shell/examples/files-runtime.gif">
+  <img src="share/llm-shell/examples/files.gif">
+</details>
+
+<details>
+  <summary><b>3. Advanced features: markdown, syntax highlighting</b></summary>
+  <img src="share/llm-shell/examples/codegen.gif">
 </details>
 
 ## Customization
@@ -44,15 +49,18 @@ it in action.
 #### Functions
 
 > For security and safety reasons, a user must confirm the execution of
-> all function calls before they happen and also add the function to
-> an allowlist before it will be loaded by llm-shell automatically
-> at boot time.
+> all function calls before they happen
+
+llm-shell can be extended with your own functions (also known as tool calls).
+This can be done by creating a Ruby file in the `~/.llm-shell/functions/`
+directory &ndash; with one file per function. The functions are
+loaded at boot time. The functions are shared with the LLM and the LLM
+can request their execution. The LLM is also made aware of a function's
+return value after it has been called.
+See the
+[functions/](lib/llm/shell/functions/)
+directory for more examples:
 
-The `~/.llm-shell/tools/` directory can contain one or more
-[llmrb/llm](https://github.com/llmrb/llm) functions that the
-LLM can call once you confirm you are okay with executing the
-code locally (along with any arguments it provides). See the
-earlier demo for an example:
 
 ```ruby
 LLM.function(:system) do |fn|
@@ -60,10 +68,10 @@ LLM.function(:system) do |fn|
   fn.params do |schema|
     schema.object(command: schema.string.required)
   end
-  fn.define do |params|
+  fn.define do |command:|
     ro, wo = IO.pipe
     re, we = IO.pipe
-    Process.wait Process.spawn(params.command, out: wo, err: we)
+    Process.wait Process.spawn(command, out: wo, err: we)
     [wo,we].each(&:close)
     {stderr: re.read, stdout: ro.read}
   end
@@ -147,7 +155,6 @@ Usage: llm-shell [OPTIONS]
     -h, --host [HOST]        Optional. Sometimes required by ollama.
     -o, --port [PORT]        Optional. Sometimes required by ollama.
     -f, --files [GLOB]       Optional. Glob pattern(s) separated by a comma.
-    -t, --tools [TOOLS]      Optional. One or more tool names to load automatically.
     -r, --prompt [PROMPT]    Optional. The prompt to use.
     -v, --version            Optional. Print the version and exit
 ```

data/lib/llm/function.rb

@@ -0,0 +1,17 @@
+# 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.rb

@@ -70,5 +70,19 @@ class LLM::Shell
         @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

@@ -24,8 +24,9 @@ class LLM::Shell::Command
     def clear_screen = console.clear_screen
 
     LLM.command "clear-screen" do |cmd|
-      cmd.description "Clears the screen"
+      cmd.description "Clear the screen"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

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

@@ -41,8 +41,9 @@ class LLM::Shell::Command
     private
 
     LLM.command "dir-import" do |cmd|
-      cmd.description "Share the contents of a directory with the LLM"
+      cmd.description "Share a directory with the LLM"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

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

@@ -33,8 +33,9 @@ class LLM::Shell::Command
     private
 
     LLM.command "file-import" do |cmd|
-      cmd.description "Share one or more files with the LLM"
+      cmd.description "Share a file with the LLM"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

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

@@ -27,32 +27,40 @@ class LLM::Shell::Command
 
     def render_commands(io)
       io.print(Paint["Commands", :bold, :underline], "\n\n")
-      commands.each.with_index(1) do |command, index|
-        io.puts(command_name(command, index, :red))
-        io.puts(command_desc(command), "\n\n")
-      end
+      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")
-      if functions.empty?
-        io.print(Paint["No functions available", :yellow], "\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
-        functions.each.with_index(1) do |fn, index|
-          io.print(command_name(fn, index, :green), "\n")
-          io.print(command_desc(fn), "\n\n")
+        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 command_name(command, index, bgcolor) = [Paint[" #{index} ", :white, bgcolor, :bold], " ", Paint[command.name, :bold]].join
-    def command_desc(command) = command.description || "No description"
+    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 "Shows help"
+      cmd.description "Show the help menu"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

data/lib/llm/shell/commands/{show_history.rb → show_chat.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 class LLM::Shell::Command
-  class ShowHistory
+  class ShowChat
     require_relative "utils"
     include Utils
 
     ##
     # @param [LLM::Shell::Context] context
     #  The context of the command
-    # @return [LLM::Shell::Command::ShowHistory]
+    # @return [LLM::Shell::Command::ShowChat]
     def initialize(context)
       @context = context
     end
@@ -37,9 +37,10 @@ class LLM::Shell::Command
     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"
+    LLM.command "show-chat" do |cmd|
+      cmd.description "Show the chat"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

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

@@ -29,6 +29,7 @@ class LLM::Shell::Command
     LLM.command "system-prompt" do |cmd|
       cmd.description "Show the system prompt"
       cmd.register(self)
+      cmd.builtin!
     end
   end
 end

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

@@ -0,0 +1,22 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

data/lib/llm/shell/markdown.rb

@@ -1,71 +1,71 @@
 # frozen_string_literal: true
 
-class LLM::Shell
-  class Markdown
-    require "kramdown"
-    require "coderay"
+require "redcarpet"
+require "coderay"
 
+class LLM::Shell
+  ##
+  # @api private
+  # @see redcarpet https://github.com/vmg/redcarpet/blob/master/ext/redcarpet/markdown.h#L69-L110
+  class Markdown < Redcarpet::Render::Base
     ##
-    # @param [String] text
-    # @return [LLM::Shell::Markdown]
-    def initialize(text)
-      @document = Kramdown::Document.new preprocessor(text)
+    # Renders markdown text to a terminal-friendly format.
+    # @return [String
+    def self.render(text)
+      renderer = Redcarpet::Markdown.new(self, options)
+      renderer.render(wrap(p: text)).strip
     end
 
     ##
-    # @return [String]
-    def to_ansi
-      @document.root.children.map { |node| visit(node) }.join("\n")
+    # @api private
+    def self.wrap(p:, width: 80)
+      in_code = false
+      p.lines.map do |line|
+        if line =~ /^(\s*)(```|~~~)/
+          in_code = !in_code
+          line
+        elsif in_code || line =~ /^\s{4}/
+          line
+        else
+          line.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+        end
+      end.join.strip + "\n"
     end
 
-    private
+    ##
+    # @api private
+    def self.options
+      {
+        autolink: false, no_intra_emphasis: true,
+        fenced_code_blocks: true, lax_spacing: true,
+        strikethrough: true, superscript: true,
+        tables: true, with_toc_data: true
+      }
+    end
 
-    def visit(node)
-      case node.type
-      when :header
-        level = node.options[:level]
-        color = levels[level]
-        Paint[("#" * level) + " " + node.children.map { visit(_1) }.join, color]
-      when :p
-        node.children.map { visit(_1) }.join
-      when :ul
-        node.children.map { visit(_1) }.join("\n")
-      when :li
-        "• " + node.children.map { visit(_1) }.join
-      when :em
-        Paint[node.children.map { visit(_1) }.join, :italic]
-      when :strong
-        Paint[node.children.map { visit(_1) }.join, :bold]
-      when :br
-        "\n"
-      when :codespan, :codeblock
-        lines = node.value.each_line.to_a
-        lang  = lines[0].strip
-        code  = lines[1..].join
-        if lines.size == 1
-          Paint[node.value, :italic]
-        else
-          ["\n", Paint[">>> #{lang}", :blue, :bold],
-           "\n\n", coderay(code, lang),
-           "\n", Paint["<<< #{lang}", :blue, :bold]].join
-        end
-      when :smart_quote
-        smart_quotes[node.value]
-      when :text
-        node.value
-      else
-        node.children.map { visit(_1) }.join
-      end
+    def block_code(code, lang)
+      ["\n", Paint["#{lang}:", :blue, :bold],
+       "\n", coderay(code, lang),
+       "\n"].join
     end
 
-    def preprocessor(text)
-      text
-        .gsub(/([^\n])\n(#+ )/, "\\1\n\n\\2")
-        .gsub(/(#+ .+?)\n(?!\n)/, "\\1\n\n")
-        .gsub(/\A<think>[\n]*<\/think>(?:\n)/, "")
-        .gsub(/\A\n{2,}/, "")
+    def header(text, level)
+      color = levels.fetch(level, :white)
+      "\n" + Paint[("#" * level) + " " + text, color] + "\n"
     end
 
+    def paragraph(p) = "#{p.strip}\n\n"
+    def list(items, _type) = items
+    def list_item(item, _type) = "\n• #{item.strip}\n"
+    def emphasis(text) = Paint[text, :italic]
+    def double_emphasis(text) = Paint[text, :bold]
+    def codespan(code) = Paint[code, :yellow, :underline]
+    def block_quote(quote) = Paint[quote, :italic]
+    def normal_text(text) = text
+    def linebreak = "\n"
+
+    private
+
     def coderay(code, lang)
       CodeRay.scan(code, lang).terminal
     rescue ArgumentError
@@ -79,12 +79,5 @@ class LLM::Shell
         4 => :yellow, 5 => :red, 6 => :purple
       }
     end
-
-    def smart_quotes
-      {
-        lsquo: "'", rsquo: "'",
-        ldquo: '"', rdquo: '"'
-      }
-    end
   end
 end

data/lib/llm/shell/renderer.rb

@@ -28,20 +28,23 @@ class LLM::Shell
 
     private
 
+    attr_reader :message
+
     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
+      role    = Paint[message.role, :bold, color]
+      title   = "#{role} says: "
+      content = message.content
+      if message.tool_call?
+        body = "Tool call(s) request"
+      elsif message.tool_return?
+        body = "Tool call(s) return"
+      elsif content =~ file_pattern
+        path = content.match(file_pattern) ? Regexp.last_match[1] : nil
         body = "<file path=#{path} />"
       else
-        body  = markdown(wrap(message.content))
+        body = Markdown.render(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/version.rb

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

data/lib/llm/shell.rb

@@ -7,6 +7,7 @@ require "llm"
 require "paint"
 
 class LLM::Shell
+  require_relative "function"
   require_relative "../io/line"
   require_relative "shell/command"
   require_relative "shell/command/extension"
@@ -40,7 +41,7 @@ class LLM::Shell
   ##
   # @return [Array<String>]
   def self.tools
-    Dir[File.join(home, "tools", "*.rb")]
+    Dir[*TOOLGLOBS]
   end
 
   ##
@@ -49,6 +50,12 @@ class LLM::Shell
     Dir[File.join(home, "commands", "*.rb")]
   end
 
+  TOOLGLOBS = [
+    File.join(home, "tools", "*.rb"),
+    File.join(__dir__, "shell", "functions", "*.rb")
+  ].freeze
+  private_constant :TOOLGLOBS
+
   ##
   # @param [Hash] options
   # @return [LLM::Shell]
@@ -70,14 +77,8 @@ class LLM::Shell
   private
 
   def tools
-    LLM::Shell.tools.filter_map do |path|
-      name = File.basename(path, File.extname(path))
-      if options.tools.include?(name)
-        print Paint["llm-shell: ", :green], "load #{name} tool", "\n"
-        eval File.read(path), TOPLEVEL_BINDING, path, 1
-      else
-        print Paint["llm-shell: ", :yellow], "skip #{name} tool", "\n"
-      end
+    LLM::Shell.tools.map do |path|
+      eval File.read(path), TOPLEVEL_BINDING, path, 1
     end.grep(LLM::Function)
   end
 

data/libexec/llm-shell/shell

@@ -27,7 +27,6 @@ def option_parser
     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("-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

data/llm-shell.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   ]
   spec.require_paths = ["lib"]
   spec.executables = ["llm-shell"]
-  spec.add_dependency "llm.rb", "~> 0.10.1"
+  spec.add_dependency "llm.rb", "~> 0.11"
   spec.add_dependency "paint", "~> 2.1"
-  spec.add_dependency "kramdown", "~> 2.5"
+  spec.add_dependency "redcarpet", "~> 3.6"
   spec.add_dependency "coderay", "~> 1.1"
   spec.add_development_dependency "webmock", "~> 3.24.0"
   spec.add_development_dependency "yard", "~> 0.9.37"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm-shell
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Antar Azri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,7 @@ files:
 - bin/llm-shell
 - lib/io/line.rb
 - lib/llm-shell.rb
+- lib/llm/function.rb
 - lib/llm/shell.rb
 - lib/llm/shell/command.rb
 - lib/llm/shell/command/extension.rb
@@ -227,13 +228,15 @@ files:
 - lib/llm/shell/commands/dir_import.rb
 - lib/llm/shell/commands/file_import.rb
 - lib/llm/shell/commands/help.rb
-- lib/llm/shell/commands/show_history.rb
+- lib/llm/shell/commands/show_chat.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/functions/read_file.rb
+- lib/llm/shell/functions/write_file.rb
 - lib/llm/shell/markdown.rb
 - lib/llm/shell/options.rb
 - lib/llm/shell/renderer.rb