llm-shell 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629a62d1b7f2fb7c4de9149c1af8e640c1ff08ccbef3a581d006cd99d331e4e2
-  data.tar.gz: 9e8808cba408a0474a938b7de8df00e1b72032635b00928bdd0a7a78f57d1521
+  metadata.gz: 2dfeeceab3ca11d0c832f8114b903d83791e237fabf4bb2dd0ce4d840be0e1ee
+  data.tar.gz: 119072ae06110415da13cee558ce8cdfe6613b4ad0198e91d207b91235824e5d
 SHA512:
-  metadata.gz: 4552e7ef324acf1f800c42cffc5fe7812e581389f1a544a447c6963611011d66c4a3e19ec2fb1d5f142fbf822b8dd8a0264ed8de6a40427113b597541d099170
-  data.tar.gz: 8c453dfd38ff0c2f94707ab460a47afeba52efeccc808ff68c5a9c1007040855104e1954548222367459eca4a6245a174b78cd9f034baa8f301d2451a78b0288
+  metadata.gz: 391dbf0bc2937545a475aaade248ebdfe495fd88c61ecd4691623220276f35dca1d438b55dbaf20826e30e554013493ca98044d40816396a45f9f3d5e89d678a
+  data.tar.gz: 63f8201b0aebd0e260788df46b90e96afdd4442f1b27bf9d4e025a6c6b6c6ca2d2338b6140fd69d616cc121cd8fa91bd1e71b3d9043e143af78a0494041ea563

data/README.md

@@ -1,7 +1,7 @@
 ## About
 
 llm-shell is an extensible, developer-oriented command-line
-utility that can interact with multiple Large Language Models
+console that can interact with multiple Large Language Models
 (LLMs). It serves as both a demo of the [llmrb/llm](https://github.com/llmrb/llm)
 library and a tool to help improve the library through real-world
 usage and feedback. Jump to the [Demos](#demos) section to see
@@ -9,12 +9,22 @@ it in action!
 
 ## Features
 
+#### General
+
 - 🌟 Unified interface for multiple Large Language Models (LLMs)
 - 🤝 Supports Gemini, OpenAI, Anthropic, LlamaCpp and Ollama
+
+#### Customize
+
 - 📤 Attach local files as conversation context
 - 🔧 Extend with your own functions and tool calls
-- 📝 Advanced Markdown formatting and output
+- 🚀 Extend with your own console commands
+
+#### Shell
+
+- 🤖 Builtin auto-complete powered by Readline
 - 📄 Deploys the less pager for long outputs
+- 📝 Advanced Markdown formatting and output
 
 ## Demos
 
@@ -37,22 +47,16 @@ 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.
+
 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.
-
-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. See below for more details on how this can be done.
-
-An LLM function generally looks like this, and it can be dropped
-into the `~/.llm-shell/tools/` directory. This function is the one
-from the demo earlier, and I saved it as `~/.llm-shell/tools/system.rb`.
-The function's return value is relayed back to the LLM.
-
+earlier demo for an example:
 
 ```ruby
 LLM.function(:system) do |fn|
@@ -61,11 +65,30 @@ LLM.function(:system) do |fn|
     schema.object(command: schema.string.required)
   end
   fn.define do |params|
-    `#{params.command}`
+    ro, wo = IO.pipe
+    re, we = IO.pipe
+    Process.wait Process.spawn(params.command, out: wo, err: we)
+    [wo,we].each(&:close)
+    {stderr: re.read, stdout: ro.read}
   end
 end
 ```
 
+#### Commands
+
+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
+[import-file](lib/llm/shell/commands/import_file.rb)
+command for a realistic example:
+
+```ruby
+LLM.command "say-hello" do |cmd|
+  cmd.define do |name|
+    io.rewind.print "Hello #{name}!"
+  end
+end
+```
 ## Settings
 
 #### YAML

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

@@ -4,17 +4,19 @@ class LLM::Shell::Command
   module Extension
     ##
     # @example
-    #   LLM.command do |cmd|
-    #     cmd.name "hello"
+    #   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
+    def command(name)
       cmd = LLM::Shell::Command.new
+      cmd.name(name) if name
       yield cmd
       commands[cmd.name] = cmd
     end

data/lib/llm/shell/command.rb

@@ -4,6 +4,11 @@ class LLM::Shell
   class Command
     Context = Struct.new(:bot, :io)
 
+    ##
+    # Returns the underlying command object
+    # @return [Class, #call]
+    attr_reader :object
+
     ##
     # Set or get the command name
     # @param [String, nil] name
@@ -27,7 +32,7 @@ class LLM::Shell
     # Define the command
     # @return [void]
     def define(klass = nil, &b)
-      @runner = klass || b
+      @object = klass || b
     end
     alias_method :register, :define
 
@@ -37,10 +42,10 @@ class LLM::Shell
     def call(*argv)
       if @context.nil?
         raise "context has not been setup"
-      elsif Class === @runner
-        @runner.new(@context).call(*argv)
+      elsif Class === @object
+        @object.new(@context).call(*argv)
       else
-        @context.instance_exec(*argv, &@runner)
+        @context.instance_exec(*argv, &@object)
       end
     end
   end

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

@@ -2,6 +2,16 @@
 
 class LLM::Shell::Command
   class ImportFile
+    ##
+    # 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
+
     def initialize(context)
       @context = context
     end
@@ -24,8 +34,7 @@ class LLM::Shell::Command
     def io = @context.io
   end
 
-  LLM.command do |command|
-    command.name "import-file"
-    command.register ImportFile
+  LLM.command "import-file" do |cmd|
+    cmd.register ImportFile
   end
 end

data/lib/llm/shell/completion.rb

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

@@ -21,6 +21,8 @@ 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 { bot.chat ["--- START: #{_1} ---", File.read(_1), "--- END: #{_1} ---"].join("\n") }
       bot.messages.each(&:read!)

data/lib/llm/shell/version.rb

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

data/lib/llm/shell.rb

@@ -16,6 +16,7 @@ class LLM::Shell
   require_relative "shell/options"
   require_relative "shell/repl"
   require_relative "shell/config"
+  require_relative "shell/completion"
   require_relative "shell/version"
 
   ##
@@ -34,6 +35,12 @@ class LLM::Shell
     Dir[File.join(home, "tools", "*.rb")]
   end
 
+  ##
+  # @return [Array<String>]
+  def self.commands
+    Dir[File.join(home, "commands", "*.rb")]
+  end
+
   ##
   # @param [Hash] options
   # @return [LLM::Shell]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Antar Azri
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: llm.rb
@@ -193,7 +193,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
-description: llm-shell is an extensible, developer-oriented command-line utility that
+description: llm-shell is an extensible, developer-oriented command-line console that
   can interact with multiple Large Language Models (LLMs).
 email:
 - azantar@proton.me
@@ -211,6 +211,7 @@ files:
 - lib/llm/shell/command.rb
 - lib/llm/shell/command/extension.rb
 - lib/llm/shell/commands/import_file.rb
+- lib/llm/shell/completion.rb
 - lib/llm/shell/config.rb
 - lib/llm/shell/default.rb
 - lib/llm/shell/formatter.rb
@@ -244,6 +245,6 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: llm-shell is an extensible, developer-oriented command-line utility that
+summary: llm-shell is an extensible, developer-oriented command-line console that
   can interact with multiple Large Language Models (LLMs).
 test_files: []