llm-shell 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89ffe0d7aacb89de310acc7012fb8b383d9c27e0059536ff9ce7ea855f604c37
-  data.tar.gz: eb1cd003da504a27f6859898c21339406536a4979cf0fea6f1d6740bb2ea9328
+  metadata.gz: '0985d061b38dccb46cdeebd598133d17b634cf035f6b9ca688f48539df553c09'
+  data.tar.gz: fe594a519302eb963f727e967b6f5bd596d7b97a3b3cebe52b56a1a466b8faf8
 SHA512:
-  metadata.gz: aa30fcd97acd567fa2c53d7c5936063e0442a3b9e8a2a4a2d721557dd704af57710f4e3d6389c0da9d9e2bf9babacb2e74f51f800f239c65a18d8da4d429f9c2
-  data.tar.gz: '0900fcbd3c39c95c3941494f93863b8a11f78a69305c4d8dce31c3a87a2391f4940b97743c3f6812e3acb185be40d85f2a3003a5d75de19cc7f94153773f380c'
+  metadata.gz: 0e59a342f4356617da679699f483babae1eba0f05cabb4c9ae72ef0993a8d5d71d6565aa508c764f5e4e41f4267159ded1685821425624c99215b3a0c5257a9d
+  data.tar.gz: 7239d794cb6dc952d61286c510347d18da9bc15115ab4c45ab2fb51a44a05a0d5e347309629da927ee7965b93f9fab870f8dcb52a909680a2dc7499ee79f9ed3

data/README.md

@@ -5,7 +5,7 @@ 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
-it in action!
+it in action.
 
 ## Features
 
@@ -30,20 +30,15 @@ it in action!
 ## Demos
 
 <details>
-  <summary><b>1. Tools: "system" function</b></summary>
+  <summary><b>1. An introduction to tool calls</b></summary>
   <img src="share/llm-shell/examples/toolcalls.gif/">
 </details>
 
 <details>
-  <summary><b>2. Files: import at runtime</b></summary>
+  <summary><b>2. Add files as conversation context</b></summary>
   <img src="share/llm-shell/examples/files-runtime.gif">
 </details>
 
-<details>
-  <summary><b>3. Files: import at boot time</b></summary>
-  <img src="share/llm-shell/examples/files-boottime.gif">
-</details>
-
 ## Customization
 
 #### Functions
@@ -79,13 +74,10 @@ 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 &ndash;
-with one file per command. The commands are loaded at boot time. See the
-[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:
+with one file per command. The commands are loaded at boot time.
+See the
+[commands/](lib/llm/shell/commands/)
+directory for more examples:
 
 ```ruby
 LLM.command "say-hello" do |cmd|
@@ -127,16 +119,12 @@ path `${HOME}/.llm-shell/config.yml` and it has the following format:
 # ~/.config/llm-shell.yml
 openai:
   key: YOURKEY
-  model: gpt-4o-mini
 gemini:
   key: YOURKEY
-  model: gemini-2.0-flash-001
 anthropic:
   key: YOURKEY
-  model: claude-3-7-sonnet-20250219
 deepseek:
   key: YOURKEY
-  model: deepseek-chat
 ollama:
   host: localhost
   model: deepseek-coder:6.7b
@@ -160,6 +148,8 @@ Usage: llm-shell [OPTIONS]
     -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
 ```
 
 ## Install

data/lib/llm/shell/command.rb

@@ -3,7 +3,14 @@
 class LLM::Shell
   class Command
     require_relative "commands/utils"
-    Context = Struct.new(:bot, :io)
+
+    ##
+    # @api private
+    class Context < Struct.new(:bot, :io)
+      def pager(...)
+        LLM::Shell.pager(...)
+      end
+    end
 
     ##
     # Returns the underlying command object

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

@@ -0,0 +1,58 @@
+# 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")
+      commands.each.with_index(1) do |command, index|
+        io.puts(command_name(command, index, :red))
+        io.puts(command_desc(command), "\n\n")
+      end
+    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")
+      else
+        functions.each.with_index(1) do |fn, index|
+          io.print(command_name(fn, index, :green), "\n")
+          io.print(command_desc(fn), "\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"
+
+    LLM.command "help" do |cmd|
+      cmd.description "Shows help"
+      cmd.register(self)
+    end
+  end
+end

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

@@ -24,7 +24,7 @@ class LLM::Shell::Command
     private
 
     def emit
-      IO.popen("less -FRX", "w") do |io|
+      pager do |io|
         messages.each.with_index do |message, index|
           next if index <= 1
           io << render(message) << "\n"

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

@@ -16,7 +16,11 @@ class LLM::Shell::Command
     ##
     # Emits the system prompt to standard output
     # @return [void]
-    def call = puts render(bot.messages.to_a[0])
+    def call
+      pager do |io|
+        io.write render(bot.messages[0])
+      end
+    end
 
     private
 

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

@@ -13,8 +13,9 @@ class LLM::Shell::Command
       ].join("\n")
     end
 
-    def file_pattern = /\A<file path=(.+?)>/
     def bot = @context.bot
     def io = @context.io
+    def pager(...) = @context.pager(...)
+    def file_pattern = /\A<file path=(.+?)>/
   end
 end

data/lib/llm/shell/markdown.rb

@@ -49,6 +49,8 @@ class LLM::Shell
            "\n\n", coderay(code, lang),
            "\n", Paint["<<< #{lang}", :blue, :bold]].join
         end
+      when :smart_quote
+        smart_quotes[node.value]
       when :text
         node.value
       else
@@ -56,13 +58,6 @@ class LLM::Shell
       end
     end
 
-    def levels
-      {
-        1 => :green, 2 => :blue, 3 => :green,
-        4 => :yellow, 5 => :red, 6 => :purple
-      }
-    end
-
     def preprocessor(text)
       text
         .gsub(/([^\n])\n(#+ )/, "\\1\n\n\\2")
@@ -77,5 +72,19 @@ class LLM::Shell
       lang = "text"
       retry
     end
+
+    def levels
+      {
+        1 => :green, 2 => :blue, 3 => :green,
+        4 => :yellow, 5 => :red, 6 => :purple
+      }
+    end
+
+    def smart_quotes
+      {
+        lsquo: "'", rsquo: "'",
+        ldquo: '"', rdquo: '"'
+      }
+    end
   end
 end

data/lib/llm/shell/repl.rb

@@ -85,9 +85,9 @@ class LLM::Shell
     end
 
     def emit
-      IO.popen("less -FRX", "w") do
-        _1.write formatter(unread).format!(:user), "\n"
-        _1.write formatter(unread).format!(:assistant), "\n"
+      LLM::Shell.pager do |io|
+        io.write formatter(unread).format!(:user), "\n"
+        io.write formatter(unread).format!(:assistant), "\n"
       end unless unread.empty?
     end
 

data/lib/llm/shell/version.rb

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

data/lib/llm/shell.rb

@@ -24,6 +24,13 @@ class LLM::Shell
   # Load all commands
   Dir[File.join(__dir__, "shell", "commands", "*.rb")].each { require(_1) }
 
+  ##
+  # Opens a pager
+  # @return [void]
+  def self.pager(...)
+    IO.popen("less -FRX", "w", ...)
+  end
+
   ##
   # @return [String]
   def self.home

data/llm-shell.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/llm/shell/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "llm-shell"
+  spec.version = LLM::Shell::VERSION
+  spec.authors = ["Antar Azri", "0x1eef"]
+  spec.email = ["azantar@proton.me", "0x1eef@proton.me"]
+
+  spec.summary = "llm-shell is an extensible, developer-oriented " \
+                 "command-line console that can interact with multiple " \
+                 "Large Language Models (LLMs)."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/llmrb/llm-shell"
+  spec.license = "0BSD"
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir[
+    "README.md", "LICENSE",
+    "lib/*.rb", "lib/**/*.rb",
+    "libexec/*", "libexec/**/*",
+    "share/llm-shell/prompts/*",
+    "bin/*", "llm-shell.gemspec"
+  ]
+  spec.require_paths = ["lib"]
+  spec.executables = ["llm-shell"]
+  spec.add_dependency "llm.rb", "~> 0.10.1"
+  spec.add_dependency "paint", "~> 2.1"
+  spec.add_dependency "kramdown", "~> 2.5"
+  spec.add_dependency "coderay", "~> 1.1"
+  spec.add_development_dependency "webmock", "~> 3.24.0"
+  spec.add_development_dependency "yard", "~> 0.9.37"
+  spec.add_development_dependency "kramdown", "~> 2.4"
+  spec.add_development_dependency "webrick", "~> 1.8"
+  spec.add_development_dependency "test-cmd.rb", "~> 0.12.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "standard", "~> 1.40"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "dotenv", "~> 2.8"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm-shell
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Antar Azri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,7 @@ files:
 - 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/help.rb
 - lib/llm/shell/commands/show_history.rb
 - lib/llm/shell/commands/system_prompt.rb
 - lib/llm/shell/commands/utils.rb
@@ -239,6 +240,7 @@ files:
 - lib/llm/shell/repl.rb
 - lib/llm/shell/version.rb
 - libexec/llm-shell/shell
+- llm-shell.gemspec
 - share/llm-shell/prompts/default.txt
 homepage: https://github.com/llmrb/llm-shell
 licenses:
@@ -260,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 specification_version: 4
 summary: llm-shell is an extensible, developer-oriented command-line console that
   can interact with multiple Large Language Models (LLMs).