aia 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740cb6d71c83fae27f2918e76a10802d805e4172aef40154b8cea3ae6800ad65
-  data.tar.gz: 0e9aac0e6a0917b6adb04550cac137be65d7e0fa3507af89058f0a1d96aa3b58
+  metadata.gz: 8fa0d67e36209d8ac1840c94820ce58e0b6c08a6b01e47e579dfe90f04b94420
+  data.tar.gz: 382d34ab554077b0e81d3a724362b41463e5ccc88f888dbba00b1ad65ff0c528
 SHA512:
-  metadata.gz: 24f4eb6ace28c79ccf7c5465e3027dd03e25457df5c522b828775c681e51cfeab207d1c6eb9f237b3b84fa768b20f2c49b27779a8987fb1c7160f68152fe5e8f
-  data.tar.gz: 260685bca6ab7c0cc53b2fc566b997026d857d96c71b6889bcff3b85bd57bbfa526d4a8df6d0044b7c400a2b3be26669a81be77900669deffc4f318f1a7674c2
+  metadata.gz: 109f27eb85889450bd19bb78a123d02ba789bd99708cf7be20528a8da8c090a7ef68655e60f7fda31a0da12a506a38f3fcdf8c9d2b4a2ea9096006ab81c5d494
+  data.tar.gz: 4b46125f0937d74ea4fe446c343b474f7c3b7d0443def5fea9782a5eea9a7c7bf4997e866871723dc2e4fe2d4fd9db07fe7384f9a95655891efbbfac5711a40f

data/.semver

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

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.5.12] 2024-02-24
+- Happy Birthday Ruby!
+- Added --next CLI option
+- Added --pipeline CLI option
+
 ## [0.5.11] 2024-02-18
 - allow directives to return information that is inserted into the prompt text
 - added //shell command directive

data/README.md

@@ -6,18 +6,16 @@ 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.12
+> - Supports Prompt Sequencing
+> - Added --next option
+> - Added --pipeline option
+>
 > 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
->
-
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -41,6 +39,10 @@ It leverages the `prompt_manager` gem to manage prompts for the `mods` and `sgpt
       - [//shell](#shell)
     - [Backend Directive Commands](#backend-directive-commands)
     - [Using Directives in Chat Sessions](#using-directives-in-chat-sessions)
+  - [Prompt Sequences](#prompt-sequences)
+    - [--next](#--next)
+    - [--pipeline](#--pipeline)
+    - [Best Practices ??](#best-practices-)
   - [All About ROLES](#all-about-roles)
     - [The --roles_dir (AIA_ROLES_DIR)](#the---roles_dir-aia_roles_dir)
     - [The --role Option](#the---role-option)
@@ -298,6 +300,65 @@ Whe you are in a chat session, you may use a directive as a follow up prompt.  F
 The directive is executed and a new follow up prompt can be entered with a more lengthy response generated from the backend.
 
 
+## Prompt Sequences
+
+Why would you need/want to use a sequence of prompts in a batch situation.  Maybe you have a complex prompt which exceeds the token limitations of your model for input so you need to break it up into multiple parts.  Or suppose its a simple prompt but the number of tokens on the output is limited and you do not get exactly the kind of full response for which you were looking.
+
+Sometimes it takes a series of prompts to get the kind of response that you want.  The reponse from one prompt becomes a context for the next prompt.  This is easy to do within a `chat` session were you are manually entering and adjusting your prompts until you get the kind of response that you want.
+
+If you need to do this on a regular basis or within a batch you can use `aia` and the `--next` and `--pipeline` command line options.
+
+These two options specify the sequence of prompt IDs to be processed. Both options are available to be used within a prompt file using the `//config` directive.  Like all embedded directives you can take advantage of parameterization shell integration and Ruby.  I'm start to feel like TIm Tool man - more power!
+
+Consider the condition in which you have 4 prompt IDs that need to be processed in sequence.  The IDs and associated prompt file names are:
+
+| Promt ID | Prompt File |
+| -------- | ----------- |
+| one.     | one.txt     |
+| two.     | two.txt     |
+| three.   | three.txt   |
+| four.    | four.txt    |
+
+
+### --next
+
+```shell
+export AIA_OUT_FILE=temp.md 
+aia one --next two
+aia three --next four temp.md
+```
+
+or within each of the prompt files you use the config directive:
+
+```
+one.txt contains //config next two
+two.txt contains //config next three
+three.txt contains //config next four
+```
+BUT if you have more than two prompts in your sequence then consider using the --pipeline option.
+
+### --pipeline
+
+`aia one --pipeline two,three,four`
+
+or inside of the `one.txt` prompt file use this directive:
+
+`//config pipeline two,three,four`
+
+### Best Practices ??
+
+Since the response of one prompt is fed into the next prompt within the sequence instead of having all prompts write their response to the same out file, use these directives inside the associated prompt files:
+
+
+| Prompt File | Directive |
+| --- | --- |
+| one.txt | //config out_file one.md |
+| two.txt | //config out_file two.md |
+| three.txt | //config out_file three.md |
+| four.txt | //config out_file four.md |
+
+This way you can see the response that was generated for each prompt in the sequence.
+
 ## All About ROLES
 
 ### The --roles_dir (AIA_ROLES_DIR)

data/justfile

@@ -157,6 +157,11 @@ view_man_page: create_man_page
 create_man_page:
   rake man
 
+
+# Generate the Documentation
+gen_doc: create_man_page update_toc_in_readmen
+
+
 ##########################################
 
 # Tag the current commit, push it, then bump the version

data/lib/aia/cli.rb

@@ -27,9 +27,8 @@ class AIA::Cli
     load_config_file unless AIA.config.config_file.nil?
 
     convert_to_pathname_objects
-
+    error_on_invalid_option_combinations
     setup_prompt_manager
-
     execute_immediate_commands
   end
 
@@ -47,6 +46,29 @@ class AIA::Cli
   end
 
 
+  def error_on_invalid_option_combinations
+    # --chat is intended as an interactive exchange
+    if AIA.config.chat?
+      unless AIA.config.next.empty?
+        abort "ERROR: Cannot use --next with --chat"
+      end
+      unless STDOUT == AIA.config.out_file
+        abort "ERROR: Cannot use --out_file with --chat"
+      end
+      unless AIA.config.pipeline.empty?
+        abort "ERROR: Cannot use --pipeline with --chat"
+      end
+    end
+
+    # --next says which prompt to process next
+    # but --pipeline gives an entire sequence of prompts for processing
+    unless AIA.config.next.empty?
+      unless AIA.config.pipeline.empty?
+        abort "ERROR: Cannot use --pipeline with --next"
+      end
+    end
+  end
+
   def string_to_pathname(string)
     ['~/', '$HOME/'].each do |prefix|
       if string.start_with? prefix
@@ -151,6 +173,8 @@ class AIA::Cli
       verbose?:   [false,     "-v --verbose"],
       version?:   [false,     "--version"],
       #
+      next:       ['',        "-n --next"],
+      pipeline:   [[],        "--pipeline"],
       role:       ['',        "-r --role"],
       #
       config_file:[nil,                       "-c --config_file"],
@@ -263,8 +287,11 @@ class AIA::Cli
           else
             value = arguments[index + 1]
             if value.nil? || value.start_with?('-')
-              STDERR.puts "ERROR: #{option_sym} requires a parameter value"
-              exit(1)
+              abort "ERROR: #{option_sym} requires a parameter value"
+            elsif "--pipeline" == switch
+              prompt_sequence = value.split(',')
+              AIA.config[option_sym] = prompt_sequence
+              arguments.slice!(index,2)
             else
               AIA.config[option_sym] = value
               arguments.slice!(index,2)

data/lib/aia/directives.rb

@@ -60,8 +60,18 @@ class AIA::Directives
       value = parts.join
       if item.end_with?('?')
         AIA.config[item] = %w[1 y yea yes t true].include?(value.downcase)
+      elsif item.end_with?('_file')
+        if "STDOUT" == value.upcase
+          AIA.config[item] = STDOUT
+        elsif "STDERR" == value.upcase
+          AIA.config[item] = STDERR
+        else
+          AIA.config[item] = value.start_with?('/') ? 
+            Pathname.new(value) :
+            Pathname.pwd + value
+        end
       else
-        AIA.config[item] = "STDOUT" == value ? STDOUT : value
+        AIA.config[item] = value
       end
     end
 

data/lib/aia/main.rb

@@ -43,11 +43,11 @@ class AIA::Main
 
     @logger.info(AIA.config) if AIA.config.debug? || AIA.config.verbose?
 
-    @prompt = AIA::Prompt.new.prompt
-
 
     @directives_processor = AIA::Directives.new 
 
+    @prompt = AIA::Prompt.new.prompt
+
     # TODO: still should verify that the tools are ion the $PATH
     # tools.class.verify_tools
   end
@@ -71,6 +71,8 @@ class AIA::Main
   end
 
 
+  # This will be recursive with the new options
+  # --next and --pipeline
   def call
     directive_output = @directives_processor.execute_my_directives
 
@@ -124,6 +126,17 @@ class AIA::Main
       speak result
       lets_chat 
     end
+
+    return if AIA.config.next.empty? && AIA.config.pipeline.empty?
+
+    # Reset some config items to defaults
+    AIA.config.directives = []
+    AIA.config.next       = AIA.config.pipeline.shift
+    AIA.config.arguments  = [AIA.config.next, AIA.config.out_file.to_s]
+    AIA.config.next       = ""
+
+    @prompt = AIA::Prompt.new.prompt
+    call # Recurse!
   end
 
 

data/main.just

@@ -55,6 +55,11 @@ view_man_page: create_man_page
 create_man_page:
   rake man
 
+
+# Generate the Documentation
+gen_doc: create_man_page update_toc_in_readmen
+
+
 ##########################################
 
 # Tag the current commit, push it, then bump the version

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.11" AIA "User Manuals"
+.TH aia 1 "v0.5.12" AIA "User Manuals"
 .SH NAME
 .PP
 aia \- command\-line interface for an AI assistant
@@ -78,9 +78,15 @@ Log FILEPATH \- default is \[Do]HOME\[sl]\.prompts\[sl]prompts\.log
 \fB\-m\fR, \fB\-\-\[lB]no\[rB]\-markdown\fR
 Format with Markdown \- default is true
 .TP
+\fB\-n\fR, \fB\-\-next PROMPT\[ru]ID\fR
+Specifies the next prompt ID to be processed using the response for the previous prompt ID\[cq]s processing as a context within which to process the next prompt \- default is an empty string
+.TP
 \fB\-o\fR, \fB\-\-\[lB]no\[rB]\-out\[ru]file\fR \fIPATH\[ru]TO\[ru]OUTPUT\[ru]FILE\fP
 Out FILENAME \- default is \.\[sl]temp\.md
 .TP
+\fB\-\-pipeline PID1,PID2,PID3\fR
+Specifies a pipeline of prompt IDs (PID) in which the respone the first prompt is fed into the second prompt as context whose response is fed into the third as context, etc\.  It is a comma seperated list\.  There is no artificial limit to the number of prompt IDs in the pipeline \- default is an empty list
+.TP
 \fB\-p\fR, \fB\-\-prompts\[ru]dir\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
 Directory containing the prompt files \- default is \[ti]\[sl]\.prompts
 .TP
@@ -141,6 +147,28 @@ Some directives are:
 .IP \(bu 2
 \[sl]\[sl]shell shell\[ru]command
 .RE
+.SH Prompt Sequences
+.PP
+The \fB\-\-next\fR and \fB\-\-pipeline\fR command line options allow for the sequencing of prompts such that the first prompt\[cq]s response feeds into the second prompt\[cq]s context and so on\.  Suppose you had a complex sequence of prompts with IDs one, two, three and four\.  You would use the following \fBaia\fR command to process them in sequence:
+.PP
+\fBaia one \-\-pipeline two,three,four\fR
+.PP
+Notice that the value for the pipelined prompt IDs has no spaces\.  This is so that the command line parser does not mistake one of the promp IDs as a CLI option and issue an error\.
+.SS Prompt Sequences Inside of a Prompt File
+.PP
+You can also use the \fBconfig\fR directive inside of a prompt file to specify a sequence\.  Given the example above of 4 prompt IDs you could add this directive to the prompt file \fBone\.txt\fR
+.PP
+\fB\[sl]\[sl]config next two\fR
+.PP
+Then inside the prompt file \fBtwo\.txt\fR you could use this directive:
+.PP
+\fB\[sl]\[sl]config pipeline three,four\fR
+.PP
+or just
+.PP
+\fB\[sl]\[sl]config next three\fR
+.PP
+if you want to specify them one at a time\.
 .SH SEE ALSO
 .RS
 .IP \(bu 2

data/man/aia.1.md

@@ -1,4 +1,4 @@
-# aia 1 "v0.5.11" AIA "User Manuals"
+# aia 1 "v0.5.12" AIA "User Manuals"
 
 ## NAME
 
@@ -82,9 +82,15 @@ The aia command-line tool is an interface for interacting with an AI model backe
 `-m`, `--[no]-markdown`
 : Format with Markdown - default is true
 
+`-n`, `--next PROMPT_ID`
+: Specifies the next prompt ID to be processed using the response for the previous prompt ID's processing as a context within which to process the next prompt - default is an empty string
+
 `-o`, `--[no]-out_file` *PATH_TO_OUTPUT_FILE*
 : Out FILENAME - default is ./temp.md
 
+`--pipeline PID1,PID2,PID3`
+: Specifies a pipeline of prompt IDs (PID) in which the respone the first prompt is fed into the second prompt as context whose response is fed into the third as context, etc.  It is a comma seperated list.  There is no artificial limit to the number of prompt IDs in the pipeline - default is an empty list
+
 `-p`, `--prompts_dir` *PATH_TO_DIRECTORY*
 : Directory containing the prompt files - default is ~/.prompts
 
@@ -141,6 +147,30 @@ Some directives are:
 - //ruby ruby_code
 - //shell shell_command
 
+## Prompt Sequences
+
+The `--next` and `--pipeline` command line options allow for the sequencing of prompts such that the first prompt's response feeds into the second prompt's context and so on.  Suppose you had a complex sequence of prompts with IDs one, two, three and four.  You would use the following `aia` command to process them in sequence:
+
+`aia one --pipeline two,three,four`
+
+Notice that the value for the pipelined prompt IDs has no spaces.  This is so that the command line parser does not mistake one of the promp IDs as a CLI option and issue an error.
+
+### Prompt Sequences Inside of a Prompt File
+
+You can also use the `config` directive inside of a prompt file to specify a sequence.  Given the example above of 4 prompt IDs you could add this directive to the prompt file `one.txt`
+
+`//config next two`
+
+Then inside the prompt file `two.txt` you could use this directive:
+
+`//config pipeline three,four`
+
+or just
+
+`//config next three`
+
+if you want to specify them one at a time.
+
 
 ## SEE ALSO
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie