feat: add raw query option and allow other customisations

Author: stakach

README.md

@@ -24,7 +24,10 @@ You'll then need to configure a LLM, currently only OpenAPI is implemented. You
 ```shell
 vi ~/.bashrc
 # then add your OpenAPI Key
-# export OPENAI_API_KEY=sk-123456
+export OPENAI_API_KEY=sk-123456
+
+# optionally you can specify your preferred model
+export LLM_MODEL=gpt-3.5-turbo
 ```
 
 ## Usage
@@ -37,6 +40,16 @@ llm the description of the command you want to run
 llm I want to do this then do this. Then do this
 ```
 
+Execute a query and have the response returned on the command line
+
+```shell
+llm -q are there any warm blooded reptiles?
+```
+
+you can specify your model preference using `-m gpt-3.5-turbo` (as will default to `gpt-4` if you have API access to it)
+
+If you would like to verbose details use the `-v` flag
+
 ## Contributing
 
 1. Fork it (<https://github.com/stakach/llm-cli/fork>)

src/llm-cli.cr

@@ -1,8 +1,37 @@
 require "spinner"
 require "colorize"
 require "./llm-cli/*"
+require "option_parser"
+
+# check for any runtime flags
+args = ARGV.dup
+verbose = false
+is_query = false
+model = ENV["LLM_MODEL"]? || ""
+
+# Command line options
+OptionParser.parse(args) do |parser|
+  parser.on("-m MODEL", "--model=MODEL", "specify a LLM model to use") do |llm_model|
+    model = llm_model
+  end
+
+  parser.on("-q", "--query", "Just ask a question of the LLM and return the response") do
+    is_query = true
+  end
+
+  parser.on("-v", "--verbose", "Output all the request and response data") do
+    verbose = true
+  end
+
+  parser.on("-h", "--help", "Show this help") do
+    puts parser
+    exit 0
+  end
+end
 
 # init the service
+shell = LLM::CLI::Shell.new
+spin = Spin.new
 chat = begin
   LLM::CLI::Chat.service
 rescue error : LLM::CLI::Chat::Error
@@ -16,30 +45,61 @@ rescue error : LLM::CLI::Chat::Error
   end
   exit 1
 end
-shell = LLM::CLI::Shell.new
+
+chat.model_preference = model
+puts "> Model Selected: #{chat.model_id}".colorize(:red) if verbose
+
+# we want to ask some questions via the command line
+if is_query && (question = args.join("").presence)
+  begin
+    messages = [LLM::CLI::Chat::Message.new(LLM::CLI::Chat::Role::User, question)]
+    loop do
+      spin.start
+      response = chat.chat messages
+      messages << response
+      spin.stop
+
+      puts "\n#{response.content}\n".colorize(:green)
+
+      question = shell.get_input("reply? ").strip
+      exit 0 unless question.presence
+      messages << LLM::CLI::Chat::Message.new(LLM::CLI::Chat::Role::User, question)
+    end
+  rescue error
+    spin.stop
+    puts error.inspect_with_backtrace.colorize(:red)
+    exit 2
+  end
+end
+
 prompt = LLM::CLI::Prompt.new({
   "No user assistance, command ordering is important",
   "You are running on #{shell.operating_system}",
-  "Commands to be executed on the following shell: #{File.basename shell.selected}",
+  "The current shell is: #{File.basename shell.selected}",
   "Wrap unknown command parameters in <brackets>",
   "you might need to change directory before executing subsequent commands",
+  "a single command might solve multiple goals, be creative",
 })
 
 # grab the users request
-request = ARGV.dup.join(" ").presence
+request = args.join(" ").presence
 unless request
   puts "No command description provided".colorize(:red)
   exit 1
 end
 prompt.add_goal request
 
-spin = Spin.new
+prompt_message = prompt.generate
+puts "> Requesting:\n#{prompt_message}\n".colorize(:red) if verbose
+
 begin
   spin.start
   # query the configured LLM
-  response = chat.send prompt.generate
+  response = chat.send prompt_message
   spin.stop
 
+  puts "> Raw response:\n#{response}\n".colorize(:red) if verbose
+
   # process the response
   begin
     cmds = LLM::CLI::Prompt::Response.from_json response

src/llm-cli/chat.cr

@@ -28,6 +28,9 @@ abstract class LLM::CLI::Chat
     help: String)
 
   abstract def chat(message : Array(Message)) : Message
+  abstract def model_id : String
+
+  property model_preference : String = ""
 
   def send(message : String) : String
     chat([Message.new(:user, message)]).content

src/llm-cli/chat/gpt.cr

@@ -42,10 +42,12 @@ class LLM::CLI::OpenAI::GPT < LLM::CLI::Chat
   getter model_id : String do
     response = client.get("/v1/models")
     models = List(Model).from_json(response.body).data.map(&.id)
-    preferred = {"gpt-4", "gpt-3.5-turbo"}
+    preferred = {model_preference, "gpt-4", "gpt-3.5-turbo"}
 
     found = preferred.last
     preferred.each do |model|
+      next unless model.presence
+
       if models.includes?(model)
         found = model
         break