aia 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0542f46fbbf4d3dd960229ae8f707f89b2cbab347d763d2b8db11aa8f4e2e552
-  data.tar.gz: 6dd9b949fbdc26019c64f2ece134114b515782395bce52a71b0f5d281042071b
+  metadata.gz: 24e36e9066b83229df951d172cfb3fd7185cadb433fd992ab37fede8d45b8ea5
+  data.tar.gz: f7ce893975dfb29dd69d1ec0922f8ea30987f88d1d3dd69f0ca877218c6c54fc
 SHA512:
-  metadata.gz: 2eefbbd2215bc82361d1335da437714760ca7c9db5237b89280dd5cdbe220da2dd14f48890ca56641758186c0a54d5cc199b22b18535fa62ed147c52bda2a77a
-  data.tar.gz: '03990e11ef3fa9960fa8c3bd8aa34f667cf9fdd10b2e37646d2c54b199ea629fb58c1cafaeeb328bff1cbda2ce219300ab3831ab95894958317bc97c2835f18f'
+  metadata.gz: 0172e7c82b9e346d176df7691e5eb422515e25f4f7ed243cb92cd38419a4e8a18a1df9f5500ac0606c6bb30d48e88662237877aee4667aedf9cd02973a190268
+  data.tar.gz: c826c22f5b1789ffeeca7982860764527350d3b352cb428a4b1cc6ccc63025fa1c4347ed098477d8d6a0f2f63dfe8fc8187eb9570096698487bf69fe6f8903c0

data/.semver

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

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
-## [0.4.1] 2023-31
+## [0.4.2] 2023-12-31
+- added the --role CLI option to pre-pend a "role" prompt to the front of a primary prompt.
+
+## [0.4.1] 2023-12-31
 - added a chat mode
 - prompt directives now supported
 - version bumped to match the `prompt_manager` gem

data/README.md

@@ -6,6 +6,7 @@ Uses the gem "prompt_manager" to manage the prompts sent to the `mods` command-l
 
 **Most Recent Change**
 
+v0.4.2 = Added a role option to be prepended to a primary prompt.
 v0.4.1 - Added a chat mode.  Prompt directives are now supported.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
@@ -16,8 +17,11 @@ v0.4.1 - Added a chat mode.  Prompt directives are now supported.
   - [Usage](#usage)
   - [System Environment Variables (envar)](#system-environment-variables-envar)
   - [Prompt Directives](#prompt-directives)
+  - [All About ROLES](#all-about-roles)
+    - [Other Ways to Insert Roles into Prompts](#other-ways-to-insert-roles-into-prompts)
   - [External CLI Tools Used](#external-cli-tools-used)
   - [Shell Completion](#shell-completion)
+  - [Ny Most Powerful Prompt](#ny-most-powerful-prompt)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -38,13 +42,14 @@ Install the command-line utilities by executing:
 
 You will also need to establish a directory in your file system where your prompt text files, last used parameters and usage log files are kept.
 
-Setup a system environment variable named "PROMPTS_DIR" that points to your prompts directory.  The default is in your HOME directory named ".prompts_dir"
+Setup a system environment variable named "AIA_PROMPTS_DIR" that points to your prompts directory.  The default is in your HOME directory named ".prompts_dir"
 
-You will also need to source the completion script.
+You may also want to install the completion script for your shell.  To get a copy of the completion script do:
 
-TODO: May want to add a `setup` function to the command-line options that will create the directory, and do something with the completion function.
+`aia --completion bash`
+
+`fish` and `zsh` are also available.
 
-TODO: don't forget to mention have access token (API keys) setup as envars for the various backend services like OpenAI... if they are still in business.
 
 ## Usage
 
@@ -133,6 +138,11 @@ OPTIONS
        -p, --prompts PATH_TO_DIRECTORY
               Directory containing the prompt files - default is ~/.prompts
 
+       -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
 
@@ -217,7 +227,6 @@ AUTHOR
        Dewayne VanHoozer <dvanhoozer@gmail.com>
 
 AIA                                       2024-01-01                                   aia(1)
-
 ```
 
 ## System Environment Variables (envar)
@@ -256,9 +265,35 @@ That prompt will enter the chat loop regardles of the presents of a "--chat" CLI
 
 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
+See the [AIA::Directives](lib/aia/directives.rb) class to see what directives are available on the fromend within `aia`.
+
+See the [AIA::Mods](lib/aia/tools/mods.rb) class to for directives that are available to the `mods` backend.
+
+See the [AIA::Sgpt](lib/aia/tools/sgpt.rb) class to for directives that are available to the `sgpt` backend.
+
+## All About ROLES
+
+`aia` provides the "-r --role" CLI option to identify a prompt ID within your prompts directory which defines the context within which the LLM is to provide its response.  The text of the role ID is pre-pended to the text of the primary prompt to form a complete prompt to be processed by the backend.
+
+For example consider:
+
+> aia -r ruby refactor my_class.rb
+
+Within the prompts directory the contents of the text file `ruby.txt` will be pre-pre-pended to the contents of the refactor.txt file to produce a complete prompt.  That complete prompt will have any parameters then directives processed before sending the prompt text to the backend.
+
+Note that "role" is just a way of saying add this prompt to the front of this other prompt.  The contents of the "role" prompt could be anything.  It does not necessarily have be an actual role.
+
+### Other Ways to Insert Roles into Prompts
+
+Since `aia` supports parameterized prompts you could make a keyword like "[ROLE]" be part of your prompt.  For example consider this prompt:
+
+```text
+As a [ROLE] tell me what you think about [SUBJECT]
+```
 
-From the verbose help text ...
+When this prompt is processed, `aia` will ask you for a value for the keyword "ROLE" and the keyword "SUBJECT" to complete the prompt.  Since `aia` maintains a history your previous answers, you could just choose something that you used in the past or answer with a completely new value.
+
+## External CLI Tools Used
 
 ```text
 External Tools Used
@@ -296,6 +331,22 @@ If you're not a fan of "born again" replace `bash` with one of the others.
 
 Copy the function to a place where it can be installed in your shell's instance.  This might be a `.profile` or `.bashrc` file, etc.
 
+## Ny Most Powerful Prompt
+
+This is just between you and me so don't go blabbing this around to everyone.  My most power prompt is in a file named `ad_hoc.txt`. It looks like this:
+
+> [WHAT NOW HUMAN]
+
+Yep.  Just a single parameter for which I can provide a value of anything that is on my mind at the time.  Its advantage is that I do not pollute my shell's command history with lots of text.
+
+Which do you think is better to have in your shell's history file?
+
+> mods "As a certified public accountant specializing in forensic audit and analysis of public company financial statements, what do you think of mine?  What is the best way to hide the millions dracma that I've skimmed?"  < financial_statement.txt
+
+> aia ad_hoc financial_statement.txt
+
+Both do the same thing; however, aia does not put the text of the prompt into the shell's history file.... of course the keyword/parameter value is saved in the prompt's JSON file and the prompt with the response are logged unless --no-log is specified; but, its not messing up the shell history!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -304,6 +355,21 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/MadBomber/aia.
 
+I've designed `aia` so that it should be easy to integrate other backend LLM processors.  If you've found one that you like, send me a pull request or a feature request.
+
+When you find problems with `aia` please note them as an issue.  This thing was written mostly by a human and you know how error prone humans are.  There should be plenty of errors to find.
+
+Also I'm interested in doing more with the prompt directives.  I'm thinking that there is a way to include dynamic content into the prompt computationally.  Maybe something like tjos wpi;d be easu tp dp:
+
+> //insert url https://www.whitehouse.gov/briefing-room/
+> //insert file path_to_file.txt
+
+or maybe incorporating the contents of system environment variables into prompts using $UPPERCASE or $(command) or ${envar_name} patterns.
+
+I've also been thinking that the REGEX used to identify a keyword within a prompt could be a configuration item.  I chose to use square brackets and uppercase in the default regex; maybe, you have a collection of prompt files that use some other regex.  Why should it be one way and not the other.
+
+Also I'm not happy with the way where I hve some command line options for external command hard coded.  I think they should be part of the configuration as well.  For example the way I'm using `rg` and `fzf` may not be the way that you want to use them.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/aia/cli.rb

@@ -136,11 +136,7 @@ class AIA::Cli
       terse?:     [false,     "--terse"],
       speak?:     [false,     "--speak"],
       #
-      # TODO: May have to process the
-      #       "~" character and replace it with HOME
-      #
-      # TODO: Consider using standard suffix of _dif and _file
-      #       to signal Pathname objects fo validation
+      role:       ['',        "-r --role"],
       #
       config_file:[nil,                       "-c --config"],
       prompts_dir:["~/.prompts",              "-p --prompts"],

data/lib/aia/prompt.rb

@@ -22,8 +22,20 @@ class AIA::Prompt
 
   # setting build: false supports unit testing.
   def initialize(build: true)
+    if AIA.config.role.empty?
+      @role = nil
+    else
+      AIA.config.arguments.prepend AIA.config.role
+      get_prompt
+      @role = @prompt.dup
+    end
+
     get_prompt
 
+    unless @role.nil?
+      @prompt.text.prepend @role.text
+    end
+
     process_prompt if build
   end
 
@@ -128,7 +140,7 @@ class AIA::Prompt
 
     puts "Parameter #{kw} ..."
 
-    if default.empty?
+    if default&.empty?
       user_prompt = "\n-=> "
     else
       user_prompt = "\n(#{default}) -=>"

data/man/aia.1

@@ -71,6 +71,9 @@ Out FILENAME \- default is \.\[sl]temp\.md
 \fB\-p\fR, \fB\-\-prompts\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
 Directory containing the prompt files \- default is \[ti]\[sl]\.prompts
 .TP
+\fB\-r\fR, \fB\-\-role\fR \fIROLE\[ru]ID\fP
+A role ID is the same as a prompt ID\.  A \[lq]role\[rq] is a specialized prompt that gets pre\-pended to another prompt\.  It\[cq]s purpose is to configure the LLM into a certain orientation within which to resolve its primary prompt\.
+.TP
 \fB\-v\fR, \fB\-\-verbose\fR
 Be Verbose \- default is false
 .SH CONFIGURATION HIERARCHY

data/man/aia.1.md

@@ -76,6 +76,9 @@ The aia command-line tool is an interface for interacting with an AI model backe
 `-p`, `--prompts` *PATH_TO_DIRECTORY*
 : Directory containing the prompt files - default is ~/.prompts
 
+`-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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -205,7 +205,6 @@ files:
 - lib/aia/tools/vim.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb
-- lib/modularization_plan.md
 - main.just
 - man/aia.1
 - man/aia.1.md

data/lib/modularization_plan.md

@@ -1,126 +0,0 @@
-## Suggested Refactoring into Modules
-
-### ConfigurationModule
-
-This module could encapsulate all the constants and environment-dependent settings.
-
-```ruby
-module Configuration
-  HOME            = Pathname.new(ENV['HOME'])
-  PROMPTS_DIR     = Pathname.new(ENV['PROMPTS_DIR'] || (HOME + ".prompts_dir"))
-  AI_CLI_PROGRAM  = "mods"
-  EDITOR          = ENV['EDITOR'] || 'edit'
-  MY_NAME         = Pathname.new(__FILE__).basename.to_s.split('.')[0]
-  MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
-  OUTPUT          = Pathname.pwd + "temp.md"
-  PROMPT_LOG      = PROMPTS_DIR  + "_prompts.log"
-  USAGE = <<~EOUSAGE
-    AI Assistant (aia)
-    ==================
-    The AI cli program being used is: #{AI_CLI_PROGRAM}
-    You can pass additional CLI options to #{AI_CLI_PROGRAM} like this:
-    "#{MY_NAME} my options -- options for #{AI_CLI_PROGRAM}"
-  EOUSAGE
-end
-```
-
-### OptionParsingModule
-
-This module could manage the parsing of command-line arguments and configuring the options for the application.
-
-```ruby
-module OptionParsing
-  def build_reader_methods
-    # ... method definition ...
-  end
-
-  def process_arguments
-    # ... method definition ...
-  end
-
-  def check_for(an_option)
-    # ... method definition ...
-  end
-
-  def process_option(option_sym, switches)
-    # ... method definition ...
-  end
-end
-```
-
-### CommandLineInterfaceModule
-
-This module would manage interactions with the command-line interface including editing of prompts and selection processes.
-
-```ruby
-module CommandLineInterface
-  def keyword_value(kw, default)
-    # ... method definition ...
-  end
-
-  def handle_multiple_prompts(found_these, while_looking_for_this)
-    # ... method definition ...
-  end
-end
-```
-
-### LoggingModule
-
-Responsible for logging the results of the command.
-
-```ruby
-module Logging
-  def write_to_log(answer)
-    # ... method definition ...
-  end
-end
-```
-
-### AICommandModule
-
-Manages the building and execution of the AI CLI command.
-
-```ruby
-module AICommand
-  def setup_cli_program
-    # ... method definition ...
-  end
-
-  def build_command
-    # ... method definition ...
-  end
-
-  def execute_and_log_command(command)
-    # ... method definition ...
-  end
-end
-```
-
-### PromptProcessingModule
-
-Handles prompt retrieval, existing check, and keyword processing.
-
-```ruby
-module PromptProcessing
-  def existing_prompt?(prompt_id)
-    # ... method definition ...
-  end
-
-  def process_prompt
-    # ... method definition ...
-  end
-
-  def replace_keywords
-    # ... method definition ...
-  end
-
-  def search_for_a_matching_prompt(prompt_id)
-    # ... method definition ...
-  end
-end
-```
-
-Each module should only contain the methods relevant to that module's purpose. After defining these modules, they can be included in the `AIA::Main` class where appropriate. Note that the method `get_prompt_id` didn't fit neatly into one of the outlined modules; it may remain in the main class or be included in a module if additional context becomes available or if it can be logically grouped with similar methods.
-
-The `__END__` block and the Readline history management could be encapsulated into a separate module for terminal interactions if that block grows in complexity or moves out of the overall class definition.
-