llm-shell 0.9.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ec2b8025a69a836d633b92ae23c86e8e6d8c6ce42ed6d2da08194909ade1de8
-  data.tar.gz: 8a29bfddd6bfef7973483d8efca2e182d3aced3b82bf771beb73f673fc7861a2
+  metadata.gz: 893a1e0d06613c74c57690458a780c334a30f0e265a3bdfd0e2a17b93f96d8f3
+  data.tar.gz: cf2cb67da47f2817fa7c1fa52b491c3564918c228766a915d93b1c1bd2f59f9e
 SHA512:
-  metadata.gz: 6595412e81ab721f64ab2275ed087e8d01321a8d56c5d4b2566d31f1c0fa0a59c01ddd8981c6c4771c0896481586244bffa642ed8275416c8b2e93010a43956c
-  data.tar.gz: 3ad0f23e6fabc847984b750d86e4adcefb46f2f0748416bcabd91ad5664b4745acb04d80e4faf0e63cd7e2b3747d555e0fe921d961ef611f886a6ba0c34bfa0a
+  metadata.gz: 414008dcde8859de7f6189b75a883c82afc622143fe06bf1cb6a9fc8f60f113f681235224be75f1dd5aa8d62acd9bc921d32f315b2603edbdf3b5081e2033e7f
+  data.tar.gz: 2c54a22daf9ad8cb887797027d3012b482f3c782585736268a6bdd7a2eaa0ea22fde3d7ab168769d71d679520d80d9890155d5b675bfa6ef30cd3a154aa23f8d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Gleeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,169 +1,28 @@
-## About
-
-llm-shell is an extensible, developer-oriented command-line
-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.
-
-## Features
-
-#### General
-
-- 🌟 Unified interface for multiple Large Language Models (LLMs)
-- 🤝 Supports Gemini, OpenAI, Anthropic, xAI (grok), DeepSeek, LlamaCpp and Ollama
-
-#### Customize
-
-- 📤 Attach local files as conversation context
-- 🔧 Extend with your own functions and tool calls
-- 🚀 Extend with your own console commands
-
-#### Shell
-
-- 🤖 Builtin auto-complete powered by Readline
-- 🎨 Builtin syntax highlighting powered by Coderay
-- 📄 Deploys the less pager for long outputs
-- 📝 Advanced Markdown formatting and output
-
-## Demo
-
-<details>
-  <summary>Reveal demo</summary>
-  <img src="share/llm-shell/examples/demo.gif/">
-</details>
-
-<details>
-  <summary>Reveal demo</summary>
-  <img src="share/llm-shell/examples/demo.png/">
-</details>
-
-## Customization
-
-#### Functions
-
-> For security and safety reasons, a user must confirm the execution of
-> 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:
-
-
-```ruby
-LLM.function(:system) do |fn|
-  fn.description "Run a shell command"
-  fn.params do |schema|
-    schema.object(command: schema.string.required)
-  end
-  fn.define do |command:|
-    ro, wo = IO.pipe
-    re, we = IO.pipe
-    Process.wait Process.spawn(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 &ndash;
-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|
-  cmd.description "Say hello to somebody"
-  cmd.define do |name|
-    io.rewind.print "Hello #{name}!"
-  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
-
-The console client can be configured at the command line through option switches,
-or through a YAML file. The YAML file can contain the same options that could be
-specified at the command line. For cloud providers the key option is the only
-required parameter, everything else has defaults. The YAML file is read from the
-path `${HOME}/.llm-shell/config.yml` and it has the following format:
-
-```yaml
-# ~/.config/llm-shell.yml
-openai:
-  key: YOURKEY
-gemini:
-  key: YOURKEY
-anthropic:
-  key: YOURKEY
-xai:
-  key: YOURKEY
-deepseek:
-  key: YOURKEY
-ollama:
-  host: localhost
-  model: deepseek-coder:6.7b
-llamacpp:
-  host: localhost
-  model: qwen3
-tools:
-  - system
-```
-
-## Usage
-
-#### CLI
-
-```bash
-Usage: llm-shell [OPTIONS]
-    -p, --provider NAME      Required. Options: gemini, openai, anthropic, ollama or llamacpp.
-    -k, --key [KEY]          Optional. Required by gemini, openai, and anthropic.
-    -m, --model [MODEL]      Optional. The name of a model.
-    -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.
-    -r, --prompt [PROMPT]    Optional. The prompt to use.
-    -v, --version            Optional. Print the version and exit
-```
-
-## Install
-
-llm-shell can be installed via [rubygems.org](https://rubygems.org/gems/llm-shell)
-
-	gem install llm-shell
+<p align="center">
+  <a href="https://r.uby.dev">
+    <img
+      src="rubydev.svg"
+      width="400"
+      height="200"
+      border="0"
+      alt="a r.uby.dev project"
+     >
+  </a>
+</p>
+
+> [r.uby.dev](https://r.uby.dev/) project.
+
+Welcome to the canonical llm-shell repository.
+
+This repository provides a RubyGem that includes
+the [llm.rb](https://github.com/r-uby-dev/llm) runtime
+and the optional dependencies that it requires to
+run the llm.rb console.
+
+It is a convenience gem that reduces installing the
+llm.rb console to a single line: `gem install llm-shell`.
 
 ## License
 
-[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
-<br>
+MIT. <br>
 See [LICENSE](./LICENSE)

data/exe/llm-shell

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+begin
+  Process.spawn File.join(Gem.bindir, "llm.rb"), *ARGV
+  Process.wait
+rescue Interrupt
+end

data/llm-shell.gemspec

@@ -1,46 +1,36 @@
 # 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.version = "0.11.0"
+  spec.authors = ["Robert Gleeson"]
+  spec.email = ["robert@r.uby.dev"]
+
+  spec.summary = "The llm.rb console in a single RubyGem"
+  spec.description = <<~DESCRIPTION
+The llm.rb console distributed as a single RubyGem that includes the optional
+llm.rb dependencies. It is a convenience gem that reduces installing the
+llm.rb console to a single line: `gem install llm-shell`.
+DESCRIPTION
 
-  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.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
 
+  spec.homepage = "https://r.uby.dev"
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/r-uby-dev/llm-shell"
+  spec.metadata["documentation_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.files = Dir["LICENSE", "README.md", "llm-shell.gemspec", "exe/llm-shell"]
+  spec.bindir = "exe"
   spec.executables = ["llm-shell"]
-  spec.add_dependency "llm.rb", "~> 0.13"
-  spec.add_dependency "paint", "~> 2.1"
-  spec.add_dependency "redcarpet", "~> 3.6"
-  spec.add_dependency "coderay", "~> 1.1"
-  spec.add_dependency "reline", "~> 0.6"
-  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"
+
+  ##
+  # The dependencies that are required to run
+  # the llm.rb console
+  spec.add_dependency "llm.rb", "~> 15.3"
+  spec.add_dependency "test-cmd.rb", "~> 2.7"
+  spec.add_dependency "curses", "~> 1.7"
+  spec.add_dependency "kramdown", "~> 2.5"
+  spec.add_dependency "unicode-display_width", "~> 3.2"
 end

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: llm-shell
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.11.0
 platform: ruby
 authors:
-- Antar Azri
-- '0x1eef'
-bindir: bin
+- Robert Gleeson
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -16,256 +15,92 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '15.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '15.3'
 - !ruby/object:Gem::Dependency
-  name: paint
+  name: test-cmd.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: curses
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: reline
+  name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: test-cmd.rb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.40'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.40'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-description: llm-shell is an extensible, developer-oriented command-line console that
-  can interact with multiple Large Language Models (LLMs).
+        version: '3.2'
+description: |
+  The llm.rb console distributed as a single RubyGem that includes the optional
+  llm.rb dependencies. It is a convenience gem that reduces installing the
+  llm.rb console to a single line: `gem install llm-shell`.
 email:
-- azantar@proton.me
-- 0x1eef@proton.me
+- robert@r.uby.dev
 executables:
 - llm-shell
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
-- 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
-- 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_chat.rb
-- lib/llm/shell/commands/show_version.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
-- lib/llm/shell/repl.rb
-- lib/llm/shell/version.rb
-- libexec/llm-shell/shell
+- exe/llm-shell
 - llm-shell.gemspec
-- share/llm-shell/prompts/default.txt
-homepage: https://github.com/llmrb/llm-shell
+homepage: https://r.uby.dev
 licenses:
-- 0BSD
+- MIT
 metadata:
-  homepage_uri: https://github.com/llmrb/llm-shell
-  source_code_uri: https://github.com/llmrb/llm-shell
+  homepage_uri: https://r.uby.dev
+  source_code_uri: https://github.com/r-uby-dev/llm-shell
+  documentation_uri: https://r.uby.dev
 rdoc_options: []
 require_paths:
 - lib
@@ -273,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
-summary: llm-shell is an extensible, developer-oriented command-line console that
-  can interact with multiple Large Language Models (LLMs).
+summary: The llm.rb console in a single RubyGem
 test_files: []

data/bin/llm-shell

@@ -1,21 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-def wait
-  Process.wait
-rescue Interrupt
-  retry
-end
-
-def libexec
-  File.realpath File.join(__dir__, "..", "libexec", "llm-shell")
-end
-
-def main(argv)
-  Process.spawn File.join(libexec, "shell"), *ARGV[0..]
-  Process.wait
-rescue Interrupt
-  wait
-end
-main(ARGV)
-exit $?&.exitstatus || 1

data/lib/io/line.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class IO::Line
-  require "io/console"
-
-  attr_reader :io
-
-  def initialize(io)
-    @io = io
-  end
-
-  def print(*strs)
-    tap { @io.print(strs.join.gsub($/, "")) }
-  end
-
-  def end
-    tap { @io.print($/) }
-  end
-
-  def rewind
-    tap do
-      @io.erase_line(2)
-      @io.goto_column(0)
-    end
-  end
-end