aia 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cd315c42710fcff586cb6159b981fd3a1ba8c85cc950985dd46b93eb9b00ef1
-  data.tar.gz: c97d4f8db6bfc74f047ad439a6ddbddcdde72cd5dce614b1341c356a71bbad92
+  metadata.gz: 740cb6d71c83fae27f2918e76a10802d805e4172aef40154b8cea3ae6800ad65
+  data.tar.gz: 0e9aac0e6a0917b6adb04550cac137be65d7e0fa3507af89058f0a1d96aa3b58
 SHA512:
-  metadata.gz: 7cb087fe893bae9bf366c8cee81d4c35f329198a3508c475cbfd077661afff794299791d41b5af6faed0580e2a22eae9559ea69d6edad2a61705b81e54d52dd1
-  data.tar.gz: d76aba8685317e19ca534202a6dcce5ac61255702abc9e5f8ffd751c2f9ff778499048ac45a5ff7a5a5ffd5222e3249e5cd51a15398f20430f010d6900a27c99
+  metadata.gz: 24f4eb6ace28c79ccf7c5465e3027dd03e25457df5c522b828775c681e51cfeab207d1c6eb9f237b3b84fa768b20f2c49b27779a8987fb1c7160f68152fe5e8f
+  data.tar.gz: 260685bca6ab7c0cc53b2fc566b997026d857d96c71b6889bcff3b85bd57bbfa526d4a8df6d0044b7c400a2b3be26669a81be77900669deffc4f318f1a7674c2

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
 :minor: 5
-:patch: 10
+:patch: 11
 :special: ''
 :metadata: ''

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.5.11] 2024-02-18
+- allow directives to return information that is inserted into the prompt text
+- added //shell command directive
+- added //ruby ruby_code directive
+- added //include path_to_file directive
+
 ## [0.5.10] 2024-02-03
 - Added --roles_dir to isolate roles from other prompts if desired
 - Changed --prompts to --prompts_dir to be consistent

data/README.md

@@ -6,16 +6,18 @@ It leverages the `prompt_manager` gem to manage prompts for the `mods` and `sgpt
 
 **Most Recent Change**: Refer to the [Changelog](CHANGELOG.md)
 
+> v0.5.11
+> - Allow directives to prepend content into the prompt text
+> - Added //include  path_to_file
+> - Added //shell    shell_command
+> - Added //ruby     ruby code
+>
 > v0.5.10
 > - Added --roles_dir
 > - Changed --prompts to --prompts_dir
 > - Fixed Issue 33
 >
-> v0.5.9
-> - When "--verbose" is used, an animation is shown while the backend is composing its response to the prompt.
-> 
-> v0.5.7
-> - Added ERB processing to config files that have the pattern any_file.ext.erb where ext is the real extension of the file.
+
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -31,8 +33,12 @@ It leverages the `prompt_manager` gem to manage prompts for the `mods` and `sgpt
   - [*E*mbedded *R*u*B*y (ERB)](#embedded-ruby-erb)
     - [Chat Session Behavior](#chat-session-behavior)
   - [Prompt Directives](#prompt-directives)
+    - [Parameter and Shell Substitution in Directives](#parameter-and-shell-substitution-in-directives)
     - [`aia` Specific Directive Commands](#aia-specific-directive-commands)
       - [//config](#config)
+      - [//include](#include)
+      - [//ruby](#ruby)
+      - [//shell](#shell)
     - [Backend Directive Commands](#backend-directive-commands)
     - [Using Directives in Chat Sessions](#using-directives-in-chat-sessions)
   - [All About ROLES](#all-about-roles)
@@ -76,298 +82,8 @@ You may also want to install the completion script for your shell.  To get a cop
 
 The usage report obtained using either `-h` or `--help` is implemented as a standard `man` page.  You can use both `--help --verbose` of `-h -v` together to get not only the `aia` man page but also the usage report from the `backend` LLM processing tool.
 
-```text
+```shell
 $ aia --help
-
-aia(1)                    User Manuals                    aia(1)
-
-NAME
-       aia - command-line interface for an AI assistant
-
-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.
-
-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.
-
-       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.
-
-OPTIONS
-       --chat begin a chat session with the backend after the
-              initial prompt response;  will set --no-out_file
-              so that the backend response comes to STDOUT.
-              After the initial prompt is processed, you will be
-              asked to provide a follow up.  Just enter whatever
-              is appropriate terminating your input with a
-              RETURN.  The backend will provide a response to
-              you follow up and ask you again if you have
-              another follow up. This back and forth chatting
-              will continue until you enter a RETURN without any
-              other content - an empty follow up prompt.  You
-              may also enter a directive to be processed after
-              which another follow up is requested.  If you have
-              the --shell and/or the --erb options set you may
-              use those tools within your follow up to provide
-              dynamic content.
-
-       --completion SHELL_NAME
-
-       --dump PATH/TO/FILE.ext
-              Dump the current configuration to a file in the
-              format denoted by the file’s extension.  Currently
-              only .yml, .yaml and .toml are acceptable file
-              extensions.  If the file exists, it will be
-              over-written without warning.
-
-       -e, --edit
-              Invokes an editor on the prompt file.  You can
-              make changes to the prompt file, save it and the
-              newly saved prompt will be processed by the
-              backend.
-
-       --shell
-              This option tells aia to replace references to
-              system environment variables in the prompt with
-              the value of the envar.  envars are like $HOME and
-              ${HOME} in this example their occurance will be
-              replaced by the value of ENV[‘HOME’].  Also the
-              dynamic shell command in the pattern $(shell
-              command) will be executed and its output replaces
-              its pattern.  It does not matter if your shell
-              uses different patters than BASH since the
-              replacement is being done within a Ruby context.
-
-       --erb  If dynamic prompt content using $(...) wasn’t
-              enough here is ERB.  Embedded RUby.  <%= ruby code
-              %> within a prompt will have its ruby code
-              executed and the results of that execution will be
-              inserted into the prompt.  I’m sure we will find a
-              way to truly misuse this capability.  Remember,
-              some say that the simple prompt is the best
-              prompt.
-
-       --model NAME
-              Name of the LLM model to use - default is
-              gpt-4-1106-preview
-
-       --render
-              Render markdown to the terminal using the external
-              tool “glow” - default: false
-
-       --speak
-              Simple implementation. Uses the “say” command to
-              speak the response.  Fun with --chat
-
-       --terse
-              Add a clause to the prompt text that instructs the
-              backend to be terse in its response.
-
-       --version
-              Print Version - default is false
-
-       -b, --[no]-backend LLM TOOL
-              Specify the backend prompt resolver - default is
-              mods
-
-       -c, --config_file PATH_TO_CONFIG_FILE
-              Load Config File. both YAML and TOML formats are
-              supported.  Also ERB is supported.  For example
-              ~/aia_config.yml.erb will be processed through ERB
-              and then through YAML.  The result will be written
-              out to ~/aia_config.yml so that you can manually
-              verify that you got what you wanted from the ERB
-              processing.
-
-       -d, --debug
-              Turn On Debugging - default is false
-
-       -e, --edit
-              Edit the Prompt File - default is false
-
-       -f, --fuzzy`
-              Use Fuzzy Matching when searching for a prompt -
-              default is false
-
-       -h, --help
-              Show Usage - default is false
-
-       -l, --[no]-log_file PATH_TO_LOG_FILE
-              Log FILEPATH - default is
-              $HOME/.prompts/prompts.log
-
-       -m, --[no]-markdown
-              Format with Markdown - default is true
-
-       -o, --[no]-out_file PATH_TO_OUTPUT_FILE
-              Out FILENAME - default is ./temp.md
-
-       -p, --prompts_dir PATH_TO_DIRECTORY
-              Directory containing the prompt files - default is
-              ~/.prompts
-
-       --roles_dir PATH_TO_DIRECTORY
-              Directory containing the personification prompt
-              files - default is ~/.prompts/roles
-
-       -r, --role ROLE_ID
-              A role ID is the same as a prompt ID.  A “role” is
-              a specialized prompt that gets pre-pended to
-              another prompt.  It’s purpose is to configure the
-              LLM into a certain orientation within which to
-              resolve its primary prompt.
-
-       -v, --verbose
-              Be Verbose - default is false
-
-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.
-
-       Configuration values found in a config file will
-       over-ride all other values set for a config item.
-
-       ”//config” directives found inside a prompt file
-       over-rides that config item regardless of where the value
-       was set.
-
-       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
-
-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.
-
-       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 --out_file for
-       specifying a file or --no-out_file 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 path/to/file.ext option will write the current
-       configuration to a file in the format requested by the
-       file’s extension.  The following extensions are
-       supported:  .yml, .yaml and .toml
-
-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>
-                 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 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.
-
-              • fzf <https://github.com/junegunn/fzf>
-                 fzf is a general-purpose command-line fuzzy
-                finder.  It’s an interactive Unix filter for
-                command-line that can be used with any list;
-                files, command history, processes, hostnames,
-                bookmarks, git commits, etc.
-
-              • ripgrep <https://github.com/BurntSushi/ripgrep>
-                 Search tool like grep and The Silver Searcher.
-                It is a line-oriented search tool that
-                recursively searches a directory tree for a
-                regex pattern. By default, ripgrep will respect
-                gitignore rules and automatically skip hidden
-                files/directories and binary files. (To disable
-                all automatic filtering by default, use rg
-                -uuu.) ripgrep has first class support on
-                Windows, macOS and Linux, with binary downloads
-                available for every release.
-
-              • glow <https://github.com/charmbracelet/glow>
-                 Render markdown on the CLI
-
-AUTHOR
-       Dewayne VanHoozer <dvanhoozer@gmail.com>
-
-AIA                          v0.5.10                      aia(1)
 ```
 
 ## Configuration Using Envars
@@ -452,9 +168,28 @@ Downstream processing directives were added to the `prompt_manager` gem used by
 
 There is no space between the "//" and the command.
 
+### Parameter and Shell Substitution in Directives 
+
+When you combine prompt directives with prompt parameters and shell envar substitutions you can get some powerful compositional prompts.
+
+Here is an example of a pure generic directive.
+
+```
+//[DIRECTIVE_NAME] [DIRECTIVE_PARAMS]
+```
+
+When the prompt runs, you will be asked to provide a value for each of the parameters.  You could answer "shell" for the directive name and "calc 22/7" if you wanted a bad approximation of PI.
+
+Try this prompt file:
+```
+//shell calc [FORMULA]
+
+What does that number mean to you?
+```
+
 ### `aia` Specific Directive Commands
 
-At this time `aia` only has one directive command `//config`
+At this time `aia` only has a few directives which are detailed below.
 
 #### //config
 
@@ -479,6 +214,64 @@ A configuration item such as `--out_file` or `--model` has an associated value o
 //config backend = mods
 ```
 
+BTW: the "=" is completely options.  Its actuall ignored as is ":=" if you were to choose that as your assignment operator.  Also the number of spaces between the item and the value is complete arbitrary.  I like to line things up so this syntax is just as valie:
+
+```
+//config model       gpt-3.5-turbo
+//config out_file    temp.md
+//config backend     mods
+//config chat?       true
+//config terse?      true
+//config model       gpt-4
+```
+
+NOTE: if you specify the same config item name more than once within the prompt file, its the last one which will be set when the prompt is finally process through the LLM.  For example in the example above `gpt-4` will be the model used.  Being first does not count in this case.
+
+#### //include
+
+Example:
+```
+//include path_to_file
+```
+
+The `path_to_file` can be either absolute or relative.  If it is relative, it is achored at the PWD.  If the `path_to_file` includes envars, the `--shell` CLI option must be used to replace the envar in the directive with its actual value.
+
+The file that is included will have any comments or directives excluded.  It is expected that the file will be a text file so that its content can be pre-pended to the existing prompt; however, if the file is a source code file (ex: file.rb) the source code will be included HOWEVER any comment line or line that starts with "//" will be excluded.
+
+TODO:  Consider adding a command line option `--include_dir` to specify the place from which relative files are to come.
+
+#### //ruby
+Example:
+```
+//ruby any_code_that_returns_an_instance_of_String
+```
+
+This directive is in addition to ERB.  At this point the `//ruby` directive is limited by the current binding which is within the `AIA::Directives#ruby` method.  As such it is not likely to see much use.
+
+However, sinces it implemented as a simple `eval(code)` then there is a potential for use like this:
+```
+//ruby load(some_ruby_file); execute_some_method
+```
+
+Each execution of a `//ruby` directive will be a fresh execution of the `AIA::Directives#ruby` method so you cannot carry local variables from one invocation to another; however, you could do something with instance variables or global variables.  You might even add something to the `AIA.config` object to be pasted on to the next invocation of the directive within the context of the same prompt.
+
+#### //shell
+Example:
+```
+//shell some_shell_command
+```
+
+It is expected that the shell command will return some text to STDOUT which will be pre-pending to the existing prompt text within the prompt file.
+
+There are no limitations on what the shell command can be.  For example if you wanted to bypass the stripping of comments and directives from a file you could do something like this:
+```
+//shell cat path_to_file
+```
+
+Which does basically the same thing as the `//include` directive, except it uses the entire content of the file.  For relative file paths the same thing applies.  The file's path will be relative to the PWD.
+
+
+
 ### Backend Directive Commands
 
 See the source code for the directives supported by the backends which at this time are configuration-based as well.
@@ -486,7 +279,7 @@ See the source code for the directives supported by the backends which at this t
 - [mods](lib/aia/tools/mods.rb)
 - [sgpt](lib/aia/tools/sgpt.rb)
 
-FOr example `mods` has a configuration item `topp` which can be set by a directive in a prompt text file directly.
+For example `mods` has a configuration item `topp` which can be set by a directive in a prompt text file directly.
 
 ```
 //topp 1.5

data/lib/aia/clause.rb

@@ -0,0 +1,7 @@
+# aia/lib/aia/clause.rb
+
+module AIA
+  module Clause
+    Terse = 'Be terse in your response.'
+  end
+end

data/lib/aia/directives.rb

@@ -14,20 +14,24 @@ class AIA::Directives
   def execute_my_directives
     return if AIA.config.directives.nil? || AIA.config.directives.empty?
     
-    not_mine = []
+    result    = ""
+    not_mine  = []
 
     AIA.config.directives.each do |entry|
       directive   = entry[0].to_sym
       parameters  = entry[1]
 
       if respond_to? directive
-        send(directive, parameters)
+        output  = send(directive, parameters)
+        result << "#{output}\n" unless output.nil?
       else
         not_mine << entry
       end
     end
 
     AIA.config.directives = not_mine
+
+    result.empty? ? nil : result
   end
 
 
@@ -60,5 +64,40 @@ class AIA::Directives
         AIA.config[item] = "STDOUT" == value ? STDOUT : value
       end
     end
+
+    nil
+  end
+
+
+  # when path_to_file is relative it will be
+  # relative to the PWD.
+  #
+  # TODO: Consider an AIA_INCLUDE_DIR --include_dir
+  # option to be used for all relative include paths
+  #
+  def include(path_to_file)
+    path = Pathname.new path_to_file
+    if path.exist? && path.readable?
+      content = path.readlines.reject do |a_line|
+        a_line.strip.start_with?(AIA::Prompt::COMMENT_SIGNAL) ||
+        a_line.strip.start_with?(AIA::Prompt::DIRECTIVE_SIGNAL)
+      end.join("\n")
+    else
+      abort "ERROR: could not include #{path_to_file}"
+    end
+
+    content
+  end
+
+
+  def shell(command)
+    `#{command}`
+  end
+
+
+  def ruby(code)
+    output = eval(code)
+
+    output.is_a?(String) ? output : nil
   end
 end

data/lib/aia/main.rb

@@ -20,11 +20,12 @@ class AIA::Main
   include AIA::DynamicContent
   include AIA::UserQuery
   
-  attr_accessor :logger, :tools, :backend
+  attr_accessor :logger, :tools, :backend, :directive_output
 
   attr_reader :spinner
 
-  def initialize(args= ARGV)    
+  def initialize(args= ARGV)
+    @directive_output = ""
     AIA::Tools.load_tools
 
     AIA::Cli.new(args)
@@ -71,7 +72,7 @@ class AIA::Main
 
 
   def call
-    @directives_processor.execute_my_directives
+    directive_output = @directives_processor.execute_my_directives
 
     if AIA.config.chat?
       AIA.config.out_file = STDOUT 
@@ -103,6 +104,8 @@ class AIA::Main
 
     the_prompt = @prompt.to_s
 
+    the_prompt.prepend(directive_output + "\n") unless directive_output.nil? || directive_output.empty?
+
     if AIA.config.terse?
       the_prompt.prepend "Be terse in your response. "
     end
@@ -186,7 +189,9 @@ class AIA::Main
       directive   = parts.shift
       parameters  = parts.join(' ')
       AIA.config.directives << [directive, parameters]
-      @directives_processor.execute_my_directives
+      directive_output = @directives_processor.execute_my_directives
+    else
+      directive_output = ""
     end
 
     result
@@ -202,7 +207,16 @@ class AIA::Main
       the_prompt_text   = render_erb(the_prompt_text) if AIA.config.erb?
       the_prompt_text   = render_env(the_prompt_text) if AIA.config.shell?
 
-      unless handle_directives(the_prompt_text)
+      if handle_directives(the_prompt_text)
+        unless directive_output.nil?
+          the_prompt_text = insert_terse_phrase(the_prompt_text)
+          the_prompt_text << directive_output 
+          result          = get_and_display_result(the_prompt_text)
+
+          log_the_follow_up(the_prompt_text, result)
+          speak result
+        end
+      else
         the_prompt_text = insert_terse_phrase(the_prompt_text)
         result          = get_and_display_result(the_prompt_text)
 

data/lib/aia/prompt.rb

@@ -23,7 +23,9 @@ class AIA::Prompt
     def to_s        = ''
   end
 
-  KW_HISTORY_MAX = 5
+  KW_HISTORY_MAX    = 5
+  COMMENT_SIGNAL    = '#'
+  DIRECTIVE_SIGNAL  = "//"
 
   attr_reader :prompt
 

data/lib/aia/tools.rb

@@ -48,5 +48,41 @@ class AIA::Tools
         require file
       end
     end
+
+
+    def validate_tools
+      raise "NotImplemented"
+    end
+
+
+    def setup_backend
+      AIA.config.tools.backend = find_and_initialize_backend
+    end
+
+
+    private
+
+    def find_and_initialize_backend
+      found = AIA::Tools.search_for(name: AIA.config.backend, role: :backend)
+      abort_no_backend_error if found.empty?
+      abort_too_many_backends_error(found) if found.size > 1
+
+      backend_klass = found.first.klass
+      abort "Backend not found: #{AIA.config.backend}" unless backend_klass
+
+      backend_klass.new(
+        text:   "",
+        files:  []
+      )
+    end
+
+    def abort_no_backend_error
+      abort "There are no :backend tools named #{AIA.config.backend}"
+    end
+
+    def abort_too_many_backends_error(found)
+      abort "There are #{found.size} :backend tools with the name #{AIA.config.backend}"
+    end
+
   end
 end

data/lib/aia.rb

@@ -20,6 +20,7 @@ tramp_require('debug_me') {
 }
 
 require 'hashie'
+require 'os'
 require 'pathname'
 require 'reline'
 require 'shellwords'
@@ -37,6 +38,7 @@ require 'prompt_manager'
 require 'prompt_manager/storage/file_system_adapter'
 
 require_relative "aia/version"
+require_relative "aia/clause"
 require_relative "aia/main"
 require_relative "core_ext/string_wrap"
 
@@ -54,6 +56,12 @@ module AIA
       
       AIA::Main.new(args).call
     end
+
+
+    def speak(what)
+      return unless AIA.config.speak?
+      system "say #{Shellwords.escape(what)}" if OS.osx?
+    end
   end
 end
 

data/man/aia.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH aia 1 "v0.5.10" AIA "User Manuals"
+.TH aia 1 "v0.5.11" AIA "User Manuals"
 .SH NAME
 .PP
 aia \- command\-line interface for an AI assistant
@@ -129,6 +129,18 @@ Detail discussion on individual prompt directives is TBD\.  Most likely it will
 .UR https:\[sl]\[sl]github\.com\[sl]MadBomber\[sl]aia
 .UE
 \.
+.PP
+Some directives are:
+.RS
+.IP \(bu 2
+\[sl]\[sl]config item value
+.IP \(bu 2
+\[sl]\[sl]include path\[ru]to\[ru]file
+.IP \(bu 2
+\[sl]\[sl]ruby ruby\[ru]code
+.IP \(bu 2
+\[sl]\[sl]shell shell\[ru]command
+.RE
 .SH SEE ALSO
 .RS
 .IP \(bu 2

data/man/aia.1.md

@@ -1,4 +1,4 @@
-# aia 1 "v0.5.10" AIA "User Manuals"
+# aia 1 "v0.5.11" AIA "User Manuals"
 
 ## NAME
 
@@ -134,6 +134,14 @@ Within a prompt text file any line that begins with "//" is considered a prompt
 
 Detail discussion on individual prompt directives is TBD.  Most likely it will be handled in the [github wiki](https://github.com/MadBomber/aia).
 
+Some directives are:
+
+- //config item value
+- //include path_to_file
+- //ruby ruby_code
+- //shell shell_command
+
+
 ## SEE ALSO
 
 - [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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: prompt_manager
   requirement: !ruby/object:Gem::Requirement
@@ -207,17 +221,17 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  `aia` - the AI Assistant - is a command-line (CLI) tool for
-  interfacing with generative AI (gen-AI/GPT) backends.  Its designed
-  to provide developers with the ability to issue prompts, receive
-  AI-generated responses, and incorporate additional context from files
-  such as Ruby source code. It supports configuration and customization
-  for different environments, includes options for output formats like
-  markdown rendering or spoken responses, and allows dynamic content
-  generation within prompts such as shell integration and embedded
-  Ruby. With `aia`, users benefit from a simplified setup process and
-  an extendable interaction model with AI, suitable for a range of
-  command-line tasks.
+  A command-line AI Assistante (aia) that provides pre-compositional
+  template prompt management to various backend gen-AI processes.
+  Complete shell integration allows a prompt to access system
+  environment variables and execut shell commands as part of the
+  prompt content.  In addition full embedded Ruby support is provided
+  given even more dynamic prompt conditional content.  It is a
+  generalized power house that rivals specialized gen-AI tools.  aia
+  currently supports "mods" and "sgpt" CLI tools.  aia uses "ripgrep"
+  and "fzf" CLI utilities to search for and select prompt files to
+  send to the backend gen-AI tool along with supported context
+  files.
 email:
 - dvanhoozer@gmail.com
 executables:
@@ -241,6 +255,7 @@ files:
 - lib/aia/aia_completion.bash
 - lib/aia/aia_completion.fish
 - lib/aia/aia_completion.zsh
+- lib/aia/clause.rb
 - lib/aia/cli.rb
 - lib/aia/config.rb
 - lib/aia/directives.rb
@@ -287,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: AI Assistant (aia) a command-line (CLI) utility