ollama-ruby 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7010b648d380dea2bb5fcfd89597af4abbb37e064905dce4e393162d9896ef5
-  data.tar.gz: ea8df217db7e0ddd70df548820c3abc73c7efa233af56ccde171dbaa087a9a92
+  metadata.gz: 6f22498af2b68b25f11d486872f46a42ad16b94244d3f0a9cb7df9e436056894
+  data.tar.gz: aa154d720f3df668020bdf39d38c7964e7081cabcfa4daec761ebb3809bfa57f
 SHA512:
-  metadata.gz: 4ac32ac4fd527aa94f11b50fe72c0d22a4d326368d2d7655d090a4af9e3fea466f478574c2c0ce2d70ef1394e7f3da8709ee5f76fdbf9672004d91850d45245d
-  data.tar.gz: cfe22940814d91e3755cfc0d83b662db4ff505ac7b00980915eeaa51f63ff3b06a8a240cd926dbcf798d27c558c20c768a6f19e99119497e220c1e8fd1fd30f9
+  metadata.gz: a32fb5d1bd7dd225c8917c8e43b43f9983eb85c971fbe01f4993f9b0131761d467a93658d2cf50ca5db1d44da6ea20ad6885aded8a5747ea259ab3d4c261c6b2
+  data.tar.gz: 067ca2f5c9c7de901732aae837dc151e023751a935952e4c0533dd50124610c367fc6149e16c096724077bb0c8f9f0781028f7dd108a32dfd4cdf1b533af9040

data/CHANGES.md

@@ -1,5 +1,22 @@
 # Changes
 
+## 2025-07-21 v1.5.0
+
+* Update `ollama_cli` script to handle client configuration via JSON and
+  clarify argument types:
+  * Added support for `-c ` option to specify client configuration as JSON
+  * Updated documentation to clarify which arguments expect JSON input
+  * Replaced direct client initialization with `configure_with` method for
+    better maintainability
+* Update documentation for `ollama_cli` script:
+  * Reorganized usage instructions for clarity
+  * Added descriptions for new options: `-c ` and `-H `
+  * Clarified which arguments expect JSON input:
+    - `-M OPTIONS`: model options in JSON format
+    - `-s SYSTEM` and `-p PROMPT`: plain text inputs
+  * Improved formatting for better readability
+* Add `ollama_browse` to Rakefile executable tasks
+
 ## 2025-07-17 v1.4.0
 
 * **New CLI Tool**: Added `bin/ollama_browse` for exploring model tags and

data/README.md

@@ -350,26 +350,22 @@ To use `ollama_cli`, simply run it from the command line and follow the usage
 instructions:
 
 ```bash
-ollama_cli [OPTIONS]
-```
+Usage: ollama_cli [OPTIONS]
+
+  -u URL         the ollama base url, $OLLAMA_URL
+  -c CLIENT      the ollama client config (JSON), $OLLAMA_CLIENT
+  -m MODEL       the ollama model to chat with, $OLLAMA_MODEL
+  -M OPTIONS     the ollama model options (JSON), $OLLAMA_MODEL_OPTIONS
+  -s SYSTEM      the system prompt as plain text, $OLLAMA_SYSTEM
+  -p PROMPT      the user prompt as plain text, $OLLAMA_PROMPT
+                 if it contains %{stdin} it is substituted by stdin input
+  -P VARIABLE    sets prompt var %{foo} to "bar" if VARIABLE is foo=bar
+  -H HANDLER     the handler to use for the response, defaults to ChatStart
+  -S             use streaming for generation
+  -T             use thinking for generation
+  -h             this help
 
-The available options are:
-
-* `-u URL`: The Ollama base URL. Can be set as an environment variable
-  `OLLAMA_URL`.
-* `-m MODEL`: The Ollama model to chat with. Defaults to `llama3.1` if not
-  specified.
-* `-M OPTIONS`: The Ollama model options to use. Can be set as an environment
-  variable `OLLAMA_MODEL_OPTIONS`.
-* `-s SYSTEM`: The system prompt to use as a file. Can be set as an environment
-  variable `OLLAMA_SYSTEM`.
-* `-p PROMPT`: The user prompt to use as a file. If it contains `%{stdin}`, it
-  will be substituted with the standard input. If not given, stdin will be used
-  as the prompt.
-* `-P VARIABLE`: Sets a prompt variable, e.g. `foo=bar`. Can be used multiple
-  times.
-* `-H HANDLER`: The handler to use for the response. Defaults to `Print`.
-* `-S`: Use streaming for generation.
+```
 
 #### Environment Variables
 
@@ -377,10 +373,11 @@ The following environment variables can be set to customize the behavior of
 `ollama_cli`:
 
 * `OLLAMA_URL`: The Ollama base URL.
+* `OLLAMA_CLIENT`: The client config (JSON).
 * `OLLAMA_MODEL`: The Ollama model to chat with.
-* `OLLAMA_MODEL_OPTIONS`: The Ollama model options to use.
-* `OLLAMA_SYSTEM`: The system prompt to use as a file.
-* `OLLAMA_PROMPT`: The user prompt to use as a file.
+* `OLLAMA_MODEL_OPTIONS`: The Ollama model options (JSON).
+* `OLLAMA_SYSTEM`: The system prompt to use as plain text.
+* `OLLAMA_PROMPT`: The user prompt to use as plain text.
 
 #### Debug Mode
 

data/Rakefile

@@ -19,7 +19,7 @@ GemHadar do
      '.rspec', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
   readme      'README.md'
 
-  executables << 'ollama_console' << 'ollama_update' << 'ollama_cli'
+  executables << 'ollama_console' << 'ollama_update' << 'ollama_cli' << 'ollama_browse'
 
   required_ruby_version  '~> 3.1'
 

data/bin/ollama_cli

@@ -68,10 +68,11 @@ def usage
     Usage: #{File.basename($0)} [OPTIONS]
 
       -u URL         the ollama base url, $OLLAMA_URL
+      -c CLIENT      the ollama client config (JSON), $OLLAMA_CLIENT
       -m MODEL       the ollama model to chat with, $OLLAMA_MODEL
-      -M OPTIONS     the ollama model options to use, $OLLAMA_MODEL_OPTIONS
-      -s SYSTEM      the system prompt to use as a file, $OLLAMA_SYSTEM
-      -p PROMPT      the user prompt to use as a file, $OLLAMA_PROMPT
+      -M OPTIONS     the ollama model options (JSON), $OLLAMA_MODEL_OPTIONS
+      -s SYSTEM      the system prompt as plain text, $OLLAMA_SYSTEM
+      -p PROMPT      the user prompt as plain text, $OLLAMA_PROMPT
                      if it contains %{stdin} it is substituted by stdin input
       -P VARIABLE    sets prompt var %{foo} to "bar" if VARIABLE is foo=bar
       -H HANDLER     the handler to use for the response, defaults to ChatStart
@@ -83,11 +84,15 @@ def usage
   exit 0
 end
 
-opts = go 'u:m:M:s:p:P:H:STh', defaults: { ?H => 'ChatStart', ?M => '{}' }
+opts = go 'u:m:M:s:p:P:H:c:STh', defaults: { ?H => 'ChatStart', ?M => '{}' }
 
 opts[?h] and usage
 
-base_url = opts[?u] || ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
+base_url  = opts[?u] || ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
+client_config = Client::Config[
+  { base_url: } |
+  JSON(get_file_argument(opts[?c], default: ENV['OLLAMA_CLIENT']).full? || '{}')
+]
 model    = opts[?m] || ENV.fetch('OLLAMA_MODEL', 'llama3.1')
 options  = Ollama::Options.from_hash(JSON(
   get_file_argument(opts[?M], default: ENV['OLLAMA_MODEL_OPTIONS'])
@@ -127,7 +132,7 @@ handler = case
             handler
           end
 
-Client.new(base_url:, read_timeout: 120).generate(
+Client.configure_with(client_config).generate(
   model:,
   system:,
   prompt:,

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.4.0'
+  VERSION         = '1.5.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama-ruby.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 1.4.0 ruby lib
+# stub: ollama-ruby 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.4.0".freeze
+  s.version = "1.5.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.date = "1980-01-02"
   s.description = "Library that allows interacting with the Ollama API".freeze
   s.email = "flori@ping.de".freeze
-  s.executables = ["ollama_console".freeze, "ollama_update".freeze, "ollama_cli".freeze]
+  s.executables = ["ollama_console".freeze, "ollama_update".freeze, "ollama_cli".freeze, "ollama_browse".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/configuration/config.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/commands/version.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/json_loader.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/version.rb".freeze]
   s.files = [".yardopts".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ollama_browse".freeze, "bin/ollama_cli".freeze, "bin/ollama_console".freeze, "bin/ollama_update".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/configuration/config.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/commands/version.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/json_loader.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/version.rb".freeze, "ollama-ruby.gemspec".freeze, "spec/assets/client.json".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/options.json".freeze, "spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
   s.homepage = "https://github.com/flori/ollama-ruby".freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Florian Frank
@@ -214,6 +214,7 @@ dependencies:
 description: Library that allows interacting with the Ollama API
 email: flori@ping.de
 executables:
+- ollama_browse
 - ollama_cli
 - ollama_console
 - ollama_update