aia 0.3.19 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 505546a036010eb8b0360f7fbfbb4c6494c311e98969c8095fa091882815aac2
-  data.tar.gz: 6f9323e50879c3b51a5ead99c29b1b41fc377dc1957283edb13e03bb30c866db
+  metadata.gz: 0542f46fbbf4d3dd960229ae8f707f89b2cbab347d763d2b8db11aa8f4e2e552
+  data.tar.gz: 6dd9b949fbdc26019c64f2ece134114b515782395bce52a71b0f5d281042071b
 SHA512:
-  metadata.gz: 23926f77a010a023fd1fbbde152f83cfacd75f003bb2e060d4e2b4ca0cd7aecac6631b0520c5e3c6d56cbde31914f158f520f15bfa239a1a72bf682c5ea79032
-  data.tar.gz: 9d76ab35f70a13a4320d9fb4ee5f3fd47e4039c95e99fc02ce858977e179d1891d44fb08cf7cfc17975e6828dbe28d01d9d778d949c371e898e847e7fa865020
+  metadata.gz: 2eefbbd2215bc82361d1335da437714760ca7c9db5237b89280dd5cdbe220da2dd14f48890ca56641758186c0a54d5cc199b22b18535fa62ed147c52bda2a77a
+  data.tar.gz: '03990e11ef3fa9960fa8c3bd8aa34f667cf9fdd10b2e37646d2c54b199ea629fb58c1cafaeeb328bff1cbda2ce219300ab3831ab95894958317bc97c2835f18f'

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
-:minor: 3
-:patch: 19
+:minor: 4
+:patch: 1
 :special: ''
 :metadata: ''

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 ## [Unreleased]
+## [0.4.1] 2023-31
+- added a chat mode
+- prompt directives now supported
+- version bumped to match the `prompt_manager` gem
+
+## [0.3.20] 2023-12-28
+- added work around to issue with multiple context files going to the `mods` backend
+- added shellwords gem to santize prompt text on the command line
+
 ## [0.3.19] 2023-12-26
 - major code refactoring.
 - supports config files \*.yml, \*.yaml and \*.toml

data/README.md

@@ -6,7 +6,7 @@ Uses the gem "prompt_manager" to manage the prompts sent to the `mods` command-l
 
 **Most Recent Change**
 
-v0.3.19 - Major code refactoring.  Now supports conf giles in YAML or TOML format.  Supports system environment variable (envar) over-rides of default config values using envar's with keys that have the prefix "AIA_" followed by a config item name in all upper case.
+v0.4.1 - Added a chat mode.  Prompt directives are now supported.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -15,6 +15,7 @@ v0.3.19 - Major code refactoring.  Now supports conf giles in YAML or TOML forma
   - [Installation](#installation)
   - [Usage](#usage)
   - [System Environment Variables (envar)](#system-environment-variables-envar)
+  - [Prompt Directives](#prompt-directives)
   - [External CLI Tools Used](#external-cli-tools-used)
   - [Shell Completion](#shell-completion)
   - [Development](#development)
@@ -52,7 +53,7 @@ The usage report obtained using either `-h` or `--help` is implemented as a stan
 ```text
 $ aia --help
 
-aia(1)                           User Manuals                           aia(1)
+aia(1)                                   User Manuals                                  aia(1)
 
 NAME
        aia - command-line interface for an AI assistant
@@ -61,157 +62,167 @@ SYNOPSIS
        aia [options]* PROMPT_ID [CONTEXT_FILE]* [-- EXTERNAL_OPTIONS+]
 
 DESCRIPTION
-       The aia command-line tool is an interface for interacting with an AI
-       model backend, providing a simple way to send prompts and receive
-       responses. The CLI supports various options to customize the
-       interaction, load a configuration file, edit prompts, set debugging
-       levels, and more.
+       The aia command-line tool is an interface for interacting with an AI model backend,
+       providing a simple way to send prompts and receive responses. The CLI supports various
+       options to customize the interaction, load a configuration file, edit prompts, set
+       debugging levels, and more.
 
 ARGUMENTS
        PROMPT_ID
               This is a required argument.
 
        CONTEXT_FILES
-              This is an optional argument.  One or more files can be added to
-              the prompt as context for the backend gen-AI tool to process.
+              This is an optional argument.  One or more files can be added to the prompt as
+              context for the backend gen-AI tool to process.
 
        EXTERNAL_OPTIONS
-              External options are optional.  Anything that follow “ -- “ will
-              be sent to the backend gen-AI tool.  For example “-- -C -m
-              gpt4-128k” will send the options “-C -m gpt4-128k” to the
-              backend gen-AI tool.  aia will not validate these external
-              options before sending them to the backend gen-AI tool.
+              External options are optional.  Anything that follow “ -- “ will be sent to the
+              backend gen-AI tool.  For example “-- -C -m gpt4-128k” will send the options
+              “-C -m gpt4-128k” to the backend gen-AI tool.  aia will not validate these
+              external options before sending them to the backend gen-AI tool.
 
 OPTIONS
-       -c, --config PATH_TO_CONFIG_FILE
-              Load Config File - default: nil
+       --chat begin a chat session with the backend after the initial prompt response;  will
+              set --no-output so that the backend response comes to STDOUT.
+
+       --completion SHELL_NAME
 
        --dump FORMAT
 
-       -e, --edit
-              Edit the Prompt File - default: false
+       --model NAME
+              Name of the LLM model to use - default is gpt-4-1106-preview
 
-       -d, --debug
-              Turn On Debugging - default: false
+       --speak
+              Simple implementation. Uses the “say” command to speak the response.  Fun with
+              --chat
 
-       -v, --verbose
-              Be Verbose - default: false
+       --terse
+              Add a clause to the prompt text that instructs the backend to be terse in its
+              response.
 
        --version
-              Print Version - default: false
+              Print Version - default is false
 
-       -h, --help
-              Show Usage - default: false
+       -b, --[no]-backend LLM TOOL
+              Specify the backend prompt resolver - default is mods
 
-       -s, --search TERM
-              Search for prompts contain TERM - default: nil
+       -c, --config PATH_TO_CONFIG_FILE
+              Load Config File - default is nil
 
-       -f, --fuzzy`
-              Use Fuzzy Matching when searching for a prompt - default: false
+       -d, --debug
+              Turn On Debugging - default is false
 
-       --completion SHELL_NAME
+       -e, --edit
+              Edit the Prompt File - default is false
 
-       -o, --[no]-output PATH_TO_OUTPUT_FILE
-              Out FILENAME - default: ./temp.md
+       -f, --fuzzy`
+              Use Fuzzy Matching when searching for a prompt - default is false
+
+       -h, --help
+              Show Usage - default is false
 
        -l, --[no]-log PATH_TO_LOG_FILE
-              Log FILEPATH - default: $HOME/.prompts/prompts.log
+              Log FILEPATH - default is $HOME/.prompts/prompts.log
 
        -m, --[no]-markdown
-              Format with Markdown - default: true
+              Format with Markdown - default is true
 
-       --model NAME
-              Name of the LLM model to use - default: gpt-4-1106-preview
+       -o, --[no]-output PATH_TO_OUTPUT_FILE
+              Out FILENAME - default is ./temp.md
 
        -p, --prompts PATH_TO_DIRECTORY
-              Directory containing the prompt files - default: ~/.prompts
-
-       -b, --[no]-backend LLM TOOL
-              Specify the backend prompt resolver - default: :mods
-
-ENVIRONMENT
-       The aia CLI uses the following environment variables:
+              Directory containing the prompt files - default is ~/.prompts
 
-              • AIA_PROMPTS_DIR: Path to the directory containing prompts
-                files - default: $HOME/.prompts_dir
-
-              • AIA_BACKEND: The AI command-line program used - default: mods
+       -v, --verbose
+              Be Verbose - default is false
 
-              • EDITOR: The text editor used by the edit option - default:
-                edit
+CONFIGURATION HIERARCHY
+       System Environment Variables (envars) that are all uppercase and begin with “AIA_” can
+       be used to over-ride the default configuration settings.  For example setting “export
+       AIA_PROMPTS_DIR=~/Documents/prompts” will over-ride the default configuration;
+       however, a config value provided by a command line options will over-ride an envar
+       setting.
 
-              • AIA_MODEL: The AI model specification - default:
-                gpt-4-1106-preview
+       Configuration values found in a config file will over-ride all other values set for a
+       config item.
 
-              • AIA_OUTPUT: The default filename for output - default:
-                ./temp.md
+       ”//config” directives found inside a prompt file over-rides that config item
+       regardless of where the value was set.
 
-              • AIA_PROMPT_LOG: The default filepath for the prompts log -
-                default: $HOME/.prompts/_prompts.log
+       For example “//config chat? = true” within a prompt will setup the chat back and forth
+       chat session for that specific prompt regardless of the command line options or the
+       envar AIA_CHAT settings
 
-       Additionally, the program requires an OpenAI access key, which can be
-       specified using one of the following environment variables:
+OpenAI ACCOUNT IS REQUIRED
+       Additionally, the program requires an OpenAI access key, which can be specified using
+       one of the following environment variables:
 
               • OPENAI_ACCESS_TOKEN
 
               • OPENAI_API_KEY
 
-       Currently there is not specific standard for name of the OpenAI key.
-       Some programs use one name, while others use a different name.  Both of
-       the envars listed above mean the same thing.  If you use more than one
-       tool to access OpenAI resources, you may have to set several envars to
-       the same key value.
+       Currently there is not specific standard for name of the OpenAI key.  Some programs
+       use one name, while others use a different name.  Both of the envars listed above mean
+       the same thing.  If you use more than one tool to access OpenAI resources, you may
+       have to set several envars to the same key value.
 
-       To acquire an OpenAI access key, first create an account on the OpenAI
-       platform, where further documentation is available.
+       To acquire an OpenAI access key, first create an account on the OpenAI platform, where
+       further documentation is available.
 
 USAGE NOTES
-       aia is designed for flexibility, allowing users to pass prompt ids and
-       context files as arguments. Some options change the behavior of the
-       output, such as --output for specifying a file or --no-output for
-       disabling file output in favor of standard output.
+       aia is designed for flexibility, allowing users to pass prompt ids and context files
+       as arguments. Some options change the behavior of the output, such as --output for
+       specifying a file or --no-output for disabling file output in favor of standard output
+       (STDPIT).
+
+       The --completion option displays a script that enables prompt ID auto-completion for
+       bash, zsh, or fish shells. It’s crucial to integrate the script into the shell’s
+       runtime to take effect.
+
+       The --dump options will send the current configuration to STDOUT in the format
+       requested.  Both YAML and TOML formats are supported.
 
-       The --completion option displays a script that enables prompt ID
-       auto-completion for bash, zsh, or fish shells. It’s crucial to
-       integrate the script into the shell’s runtime to take effect.
+PROMPT DIRECTIVES
+       Within a prompt text file any line that begins with “//” is considered a prompt
+       directive.  There are numerious prompt directives available.  In the discussion above
+       on the configuration you learned about the “//config” directive.
+
+       Detail discussion on individual prompt directives is TBD.  Most likely it will be
+       handled in the github wiki <https://github.com/MadBomber/aia>
 
 SEE ALSO
 
-              • OpenAI Platform Documentation
-                <https://platform.openai.com/docs/overview>
+              • OpenAI Platform Documentation <https://platform.openai.com/docs/overview>
                  for more information on obtaining access tokens
                 <https://platform.openai.com/account/api-keys>
                  and working with OpenAI models.
 
               • mods <https://github.com/charmbracelet/mods>
-                 for more information on mods - AI for the command line, built
-                for pipelines.  LLM based AI is really good at interpreting
-                the output of commands and returning the results in CLI
-                friendly text formats like Markdown. Mods is a simple tool
-                that makes it super easy to use AI on the command line and in
+                 for more information on mods - AI for the command line, built for pipelines.
+                LLM based AI is really good at interpreting the output of commands and
+                returning the results in CLI friendly text formats like Markdown. Mods is a
+                simple tool that makes it super easy to use AI on the command line and in
                 your pipelines. Mods works with OpenAI
                 <https://platform.openai.com/account/api-keys>
                  and LocalAI <https://github.com/go-skynet/LocalAI>
 
               • sgpt <https://github.com/tbckr/sgpt>
-                 (aka shell-gpt) is a powerful command-line interface (CLI)
-                tool designed for seamless interaction with OpenAI models
-                directly from your terminal. Effortlessly run queries,
-                generate shell commands or code, create images from text, and
-                more, using simple commands. Streamline your workflow and
-                enhance productivity with this powerful and user-friendly CLI
-                tool.
+                 (aka shell-gpt) is a powerful command-line interface (CLI) tool designed for
+                seamless interaction with OpenAI models directly from your terminal.
+                Effortlessly run queries, generate shell commands or code, create images from
+                text, and more, using simple commands. Streamline your workflow and enhance
+                productivity with this powerful and user-friendly CLI tool.
 
 AUTHOR
        Dewayne VanHoozer <dvanhoozer@gmail.com>
 
-AIA                               2024-01-01                            aia(1)
+AIA                                       2024-01-01                                   aia(1)
 
 ```
 
 ## System Environment Variables (envar)
 
-The `aia` configuration defaults can be over-ridden by envars with the prefix "AIA_" followed by the config item name also in uppercase.
+The `aia` configuration defaults can be over-ridden by envars with the prefix "AIA_" followed by the config item name also in uppercase. All configuration items can be over-ridden in this way by an envar.  The following table show a few examples.
 
 | Config Item   | Default Value | envar key |
 | ------------- | ------------- | --------- |
@@ -231,6 +242,20 @@ The `aia` configuration defaults can be over-ridden by envars with the prefix "A
 
 See the `@options` hash in the `cli.rb` file for a complete list.  There are some config items that do not necessarily make sense for use as an envar over-ride.  For example if you set `export AIA_DUMP=yaml` then `aia` would dump a config file in HAML format and exit every time it is ran until you finally did `unset AIA_DUMP`
 
+In addition to these config items for `aia` the optional command line parameters for the backend prompt processing utilities (mods and sgpt) can also be set using envars with the "AIA_" prefix.  For example "export AIA_TOPP=1.0" will set the "--topp 1.0" command line option for the `mods` utility when its used as the backend processor.
+
+## Prompt Directives
+
+Downstream processing directives were added to the `prompt_manager` gem at version 0.4.1.  These directives are lines in the prompt text file that begin with "//"
+
+For example if a prompt text file has this line:
+
+> //config chat? = true
+
+That prompt will enter the chat loop regardles of the presents of a "--chat" CLI option or the setting of the envar AIA_CHAT.
+
+BTW did I mention that `aia` supports a chat mode where you can send an initial prompt to the backend and then followup the backend's reponse with additional keyboard entered questions, instructions, prompts etc.
+
 ## External CLI Tools Used
 
 From the verbose help text ...

data/lib/aia/cli.rb

@@ -117,7 +117,8 @@ class AIA::Cli
       #           Default
       # Key       Value,      switches
       arguments:  [args], # NOTE: after process, prompt_id and context_files will be left
-      extra:      [''],   # SMELL: should be nil?
+      directives: [[]],   # an empty Array as the default value
+      extra:      [''],   # 
       #
       model:      ["gpt-4-1106-preview",  "--llm --model"],
       #
@@ -130,8 +131,10 @@ class AIA::Cli
       version?:   [false,     "--version"],
       help?:      [false,     "-h --help"],
       fuzzy?:     [false,     "-f --fuzzy"],
-      search:     [nil,       "-s --search"],
       markdown?:  [true,      "-m --markdown --no-markdown --md --no-md"],
+      chat?:      [false,     "--chat"],
+      terse?:     [false,     "--terse"],
+      speak?:     [false,     "--speak"],
       #
       # TODO: May have to process the
       #       "~" character and replace it with HOME
@@ -194,13 +197,15 @@ class AIA::Cli
 
 
   def process_command_line_arguments
+    # get the options meant for the backend AI command
+    # doing this first in case there are any options that conflict
+    # between frontend and backend.
+    extract_extra_options
+
     @options.keys.each do |option|
       check_for option
     end
 
-    # get the options meant for the backend AI command
-    extract_extra_options
-
     bad_options = arguments.select{|a| a.start_with?('-')}
 
     unless bad_options.empty?

data/lib/aia/directives.rb

@@ -0,0 +1,66 @@
+# lib/aia/directives.rb
+
+require 'hashie'
+
+class AIA::Directives
+  def initialize( prompt: )
+    @prompt = prompt  # PromptManager::Prompt instance
+    AIA.config.directives = @prompt.directives
+  end
+
+
+  def execute_my_directives
+    return if AIA.config.directives.nil? || AIA.config.directives.empty?
+    
+    not_mine = []
+
+    AIA.config.directives.each do |entry|
+      directive   = entry[0].to_sym
+      parameters  = entry[1]
+
+      if respond_to? directive
+        send(directive, parameters)
+      else
+        not_mine << entry
+      end
+    end
+
+    AIA.config.directives = not_mine
+  end
+
+
+  def box(what)
+    f   = what[0]
+    bar = "#{f}"*what.size
+    puts "#{bar}\n#{what}\n#{bar}"
+  end
+
+
+  def shell(what) = puts `#{what}`
+  def ruby(what)  = eval what
+
+
+  # Allows a prompt to change its configuration environment
+  def config(what)
+    parts = what.split(' ')
+    item  = parts.shift
+    parts.shift if %w[:= =].include? parts[0]
+
+    if '<<' == parts[0]
+      parts.shift
+      value = parts.join
+      if AIA.config(item).is_a?(Array)
+        AIA.config[item] << value
+      else
+        AIA.config[item] = [ value ]
+      end
+    else
+      value = parts.join
+      if item.end_with?('?')
+        AIA.config[item] = %w[1 y yea yes t true].include?(value.downcase)
+      else
+        AIA.config[item] = "STDOUT" == value ? STDOUT : value
+      end
+    end
+  end
+end

data/lib/aia/main.rb

@@ -4,7 +4,8 @@ module AIA ; end
 
 require_relative 'config'
 require_relative 'cli'
-require_relative 'prompt_processing'
+require_relative 'directives'
+require_relative 'prompt'
 require_relative 'logging'
 require_relative 'tools'
 
@@ -12,42 +13,139 @@ require_relative 'tools'
 # of a single class.
 
 class AIA::Main
-  include AIA::PromptProcessing
 
-  attr_accessor :logger, :tools
+  attr_accessor :logger, :tools, :backend
+
+  def initialize(args= ARGV)    
+    AIA::Tools.load_tools
 
-  def initialize(args= ARGV)
     AIA::Cli.new(args)
 
     @logger = AIA::Logging.new(AIA.config.log_file)
-    @tools  = AIA::Tools.new
 
-    tools.class.verify_tools
+    @logger.info(AIA.config) if AIA.config.debug? || AIA.config.verbose?
+
+    @prompt = AIA::Prompt.new.prompt
+
+    @engine = AIA::Directives.new(prompt: @prompt)
+
+    # TODO: still should verify that the tools are ion the $PATH
+    # tools.class.verify_tools
+  end
+
+
+  def speak(what)
+    return unless AIA.config.speak?
+    # MacOS uses the say command
+    system "say #{Shellwords.escape(what)}"
+  end
+
+
+  # Function to setup the Reline history with a maximum depth
+  def setup_reline_history(max_history_size=5)
+    Reline::HISTORY.clear
+    # Reline::HISTORY.max_size = max_history_size
+  end
+
+
+  # Function to prompt the user with a question using reline
+  def ask_question_with_reline(prompt)
+    answer = Reline.readline(prompt)
+    Reline::HISTORY.push(answer) unless answer.nil? || Reline::HISTORY.to_a.include?(answer)
+    answer
+    rescue Interrupt
+      ''
   end
 
 
   def call
-    get_prompt
-    process_prompt
-    
-    # send_prompt_to_external_command
+    @engine.execute_my_directives
+
+    if AIA.config.chat?
+      AIA.config.output_file = STDOUT 
+      AIA.config.extra = "--quiet" if 'mods' == AIA.config.backend
+    end
 
     # TODO: the context_files left in the @arguments array
     #       should be verified BEFORE asking the user for a
     #       prompt keyword or process the prompt.  Do not
     #       want invalid files to make it this far.
 
-
-    mods    = AIA::Mods.new(
-                extra_options:  AIA.config.extra,
-                text:           @prompt.to_s,
-                files:          AIA.config.arguments    # FIXME: want validated context files
+    found = AIA::Tools
+              .search_for(
+                name: AIA.config.backend, 
+                role: :backend
               )
 
-    result  = mods.run
+    if found.empty?
+      abort "There are no :backend tools named #{AIA.config.backend}"
+    end
+
+    if found.size > 1
+      abort "There are #{found.size} :backend tools with the name #{AIAA.config.backend}"
+    end
+
+    backend_klass = found.first.klass
+
+    abort "backend not found: #{AIA.config.backend}" if backend_klass.nil?
+
+    the_prompt = @prompt.to_s
+
+    if AIA.config.terse?
+      the_prompt.prepend "Be terse in your response. "
+    end
+
+    @backend  = backend_klass.new(
+                  text:           the_prompt,
+                  files:          AIA.config.arguments    # FIXME: want validated context files
+                )
+
+
+    result  = backend.run
 
     AIA.config.output_file.write result
 
     logger.prompt_result(@prompt, result)
+
+
+    if AIA.config.chat?
+      setup_reline_history
+      speak result
+      lets_chat 
+    end
+  end
+
+
+  def lets_chat
+    if 'mods' == AIA.config.backend
+      AIA.config.extra += " -C"
+    end
+    
+    backend.text = ask_question_with_reline("\nFollow Up: ")
+    
+    until backend.text.empty?
+      if AIA.config.terse?
+        backend.text.prepend "Be terse in your response. "
+      end
+      
+      logger.info "Follow Up: #{backend.text}"
+      response = backend.run
+      
+      speak response
+
+      puts "\nResponse: #{response}"
+      logger.info "Response: #{backend.run}"
+  
+      # TODO: Allow user to enter a directive; loop
+      #       until answer is not a directive
+      #
+      # while !directive do
+      backend.text = ask_question_with_reline("\nFollow Up: ")
+      
+      speak backend.text
+
+      # execute the directive
+      # end
+    end
   end
 end