aia 0.0.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5737dc3f15dc0372865893efba9c8e7bb6c4c41fc335476b638cb55a5dc4ad17
-  data.tar.gz: 91545c6a73d8d6f61cbf878f35df375f3e700961d1d70b25bd3cb0aa0cc25251
+  metadata.gz: c4d68353a3458a4a3e485acbf09ec6444e63d33ddaedca66a1f48aaf38b31a96
+  data.tar.gz: b2d07bde2cb329db6f23ccda5c845b67251f00f5bdfab680406d671a32ee0b32
 SHA512:
-  metadata.gz: 7a276b2fdad405245fd29f8aba586504ad2a99cc4c8f3f570af1de58849c1ee2abda2f30c5a72fbd699db37f01b94e79711eb4833495cebeae33c9562d03033f
-  data.tar.gz: 2c570b4339d3f24b6621378481393994272a0f0317ab4edb2ae9ca79007a81b288cc09eeae0f9326f72892ce742d41e9bbfe180de3a8bb6f652a1fc808d1e62f
+  metadata.gz: d27e5190de909b14a71a52f2eea78b8d948de6cbe5c621f3b10e819404d0a9a78087c5da748598b6dfbf8af88ece61382c407d62382eadb062ad0582d5f4b8f9
+  data.tar.gz: 6cc9b0ad1d570f0cb994e06af614d4faea07b356303042fa1e1bfe03ed12a62f273824e0240b8bb2cb46a64b6f195dd715b15161a228255f3d2639fc1648e61e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] = 2023-11-23
+
+- Matching version to [prompt_manager](https://github.com/prompt_manager) This version allows for the user of history in the entery of values to prompt keywords.  KW_HISTORY_MAX is set at 5.  Changed CLI enteraction to use historical selection and editing of prior keyword values.
+
 ## [0.1.0] - 2023-11-23
 
 - Initial release

data/README.md

@@ -1,11 +1,27 @@
 # AI Assistant (AIA)
 
-**Under Development**
-
 `aia` is a command-line utility that integrates prameterized prompt management with generative AI (gen-AI) execution.
 
 Uses the gem "prompt_manager" to manage the prompts sent to the `mods` command-line utility.  Uses the command line tools "ripgrep" to search for prompts to send and "fzf" to select the prompts that match the search term.
 
+**Most Recent Change**
+
+v0.3.0 - Matching version to [prompt_manager](https://github.com/prompt_manager) This version allows for the user of history in the entery of values to prompt keywords.  KW_HISTORY_MAX is set at 5.  Changed CLI enteraction to use historical selection and editing of prior keyword values.
+
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+## Table of Contents
+
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [System Environment Variables (envars)](#system-environment-variables-envars)
+  - [External CLI Tools Used](#external-cli-tools-used)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 
 ## Installation
@@ -31,48 +47,120 @@ TODO: don't forget to mention have access token (API keys) setup as envars for t
 
 ## Usage
 
-`aia prompt_id [context_file]*`
+```text
+$ aia --help
+
+aia v0.0.5
+
+Usage:  aia [options] prompt_id [context_file]* [-- external_options+]
+
+Options
+-------
+
+Edit the Prompt File  -e --edit
+ default: false
+
+Turn On Debugging     -d --debug
+ default: false
+
+Be Verbose            -v --verbose
+ default: false
+
+Print Version         --version
+ default: false
+
+Show Usage            -h --help
+ default: false
+
+Use Fuzzy Matching    --fuzzy
+ default: false
+
+Out FILENAME          -o --output --no-output
+ default: ./temp.md
 
-`prompt_id` is the basename of the `prompt_id.txt` file that is located in the `$PROMPTS_DIR` directory.  There is also a `prompt_id.json` file saved in the same place to hold the last-used values (parameters) for the keywords (if any) found in your prompt file.
+Log FILEPATH          -l --log --no-log
+ default: $HOME/.prompts/_prompts.log
 
-TODO: consider a config file.
-TODO: consider a --no-log option to turn off logging
+Format with Markdown  -m --markdown --no-markdown --md --no-md
+ default: true
+```
 
-The `_prompts.log` file is also located in the `$PROMPTS_DIR`
+Turn on `verbose` with `help` to see more usage information that includes system environment variables and external CLI tools that are used.
 
-The default output file is `temp.md` which is written to the current directory from which `aia` was executed.
+```text
+$ aia --help --verbose
+```
 
+## System Environment Variables (envars)
+
+From the verbose help text ...
 
 ```text
-$ aia -h
-Use generative AI with saved parameterized prompts
 
-Usage: aia [options] ...
+System Environment Variables Used
+---------------------------------
+
+The OUTPUT and PROMPT_LOG envars can be overridden
+by cooresponding options on the command line.
+
+Name            Default Value
+--------------  -------------------------
+PROMPTS_DIR     $HOME/.prompts_dir
+AI_CLI_PROGRAM  mods
+EDITOR          edit
+MODS_MODEL      gpt-4-1106-preview
+OUTPUT          ./temp.md
+PROMPT_LOG      $PROMPTS_DIR/_prompts.log
+
+These two are required for access the OpenAI
+services.  The have the same value but different
+programs use different envar names.
+
+To get an OpenAI access key/token (same thing)
+you must first create an account at OpenAI.
+Here is the link:  https://platform.openai.com/docs/overview
+
+OPENAI_ACCESS_TOKEN
+OPENAI_API_KEY
+```
+
+## External CLI Tools Used
+
+From the verbose help text ...
+
+```text
+External Tools Used
+-------------------
 
-Where:
+To install the external CLI programs used by aia:
+  brew install fzf mods rg
 
-  Common Options Are:
-    -h, --help     show this message
-    -v, --verbose  enable verbose mode
-    -d, --debug    enable debug mode
-    --version      print the version: 1.2.0
+fzf
+  Command-line fuzzy finder written in Go
+  https://github.com/junegunn/fzf
 
-  Program Options Are:
-    -f, --fuzzy    Allow fuzzy matching
-    -o, --output   The output file
+mods
+  AI on the command-line
+  https://github.com/charmbracelet/mods
 
-AI Assistant (aia)
-==================
+rg
+  Search tool like grep and The Silver Searcher
+  https://github.com/BurntSushi/ripgrep
 
-The AI cli program being used is: mods
+A text editor whose executable is setup in the
+system environment variable 'EDITOR' like this:
 
-The defaul options to mods are:
-  "-m gpt-4-1106-preview --no-limit -f"
+export EDITOR="subl -w"
 
-You can pass additional CLI options to mods like this:
-  "aia my options -- options for mods"
 ```
 
+## Shell Completion
+
+One of the executables with this gem is `aia_completion.sh` which contains a completion script for hte `aia` such that you specify the first few characters of a prompt ID on the command line and the shell will complete the rest of the ID for you.  It works with the `bash` shell but do not know whether it works with the other shells.
+
+To set the completion you can execute aia_completion.sh` in your `.bashrc`  however, the PROMPTS_DIR environment variable must be set in order for prompt ID to work correctly.
+
+
 ## 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.

data/bin/aia

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
-# aia
+# bin/aia
 
 require 'aia'
-
-# Create an instance of the Main class and run the program
-AIA::Main.new.call
+AIA.run

data/lib/aia/cli.rb

@@ -0,0 +1,179 @@
+# lib/aia/cli.rb
+
+module AIA::Cli
+  def setup_cli_options(args)
+    @arguments  = args
+    # TODO: consider a fixed config file: ~/,aia
+    @options    = {
+      #           Value
+      edit?:      [false, "-e --edit",    "Edit the Prompt File"],
+      debug?:     [false, "-d --debug",   "Turn On Debugging"],
+      verbose?:   [false, "-v --verbose", "Be Verbose"],
+      version?:   [false, "--version",    "Print Version"],
+      help?:      [false, "-h --help",    "Show Usage"],
+      fuzzy?:     [false, "--fuzzy",      "Use Fuzzy Matching"],
+      # TODO: Consider dropping output in favor of always
+      #       going to STDOUT so user can redirect or pipe somewhere else
+      output:     [OUTPUT,"-o --output --no-output",  "Out FILENAME"],
+      log:        [PROMPT_LOG,"-l --log --no-log", "Log FILEPATH"],
+      markdown?:  [true,  "-m --markdown --no-markdown --md --no-md", "Format with Markdown"],
+      backend:    [:mods, "-b --be --backend --no-backend", "Specify the backend prompt resolver"],
+    }
+    
+    # Array(String)
+    @extra_options = [] # intended for the backend AI processor
+
+    build_reader_methods # for the @options keys      
+    process_arguments
+  end
+
+
+  def usage
+    usage =   "\n#{MY_NAME} v#{AIA::VERSION}\n\n"
+    usage +=  "Usage:  #{MY_NAME} [options] prompt_id [context_file]* [-- external_options+]\n\n"
+    usage +=  usage_options
+    usage += "\n"
+    usage += usage_notes if verbose?
+    
+    usage
+  end
+ 
+
+  def usage_options
+    options = [
+      "Options",
+      "-------",
+      ""
+    ]
+
+    max_size = @options.values.map{|o| o[2].size}.max + 2
+
+    @options.values.each do |o|
+      pad_size = max_size - o[2].size
+      options << o[2] + (" "*pad_size) + o[1]
+
+      default = o[0]
+      default = "./" + default.basename.to_s if o[1].include?('output')
+      default = default.is_a?(Pathname) ? "$HOME/" + default.relative_path_from(HOME).to_s : default
+
+      options << " default: #{default}\n"
+    end
+
+    options.join("\n")
+  end
+
+
+  def usage_notes
+    <<~EOS
+      #{usage_envars}
+      #{AIA::ExternalCommands::HELP}
+    EOS
+  end
+
+
+  def usage_envars
+    <<~EOS
+      System Environment Variables Used
+      ---------------------------------
+
+      The OUTPUT and PROMPT_LOG envars can be overridden
+      by cooresponding options on the command line.
+
+      Name            Default Value
+      --------------  -------------------------
+      PROMPTS_DIR     $HOME/.prompts_dir
+      AI_CLI_PROGRAM  mods
+      EDITOR          edit
+      MODS_MODEL      gpt-4-1106-preview
+      OUTPUT          ./temp.md
+      PROMPT_LOG      $PROMPTS_DIR/_prompts.log
+
+      These two are required for access the OpenAI
+      services.  The have the same value but different
+      programs use different envar names.
+
+      To get an OpenAI access key/token (same thing)
+      you must first create an account at OpenAI.
+      Here is the link:  https://platform.openai.com/docs/overview
+
+      OPENAI_ACCESS_TOKEN
+      OPENAI_API_KEY
+
+    EOS
+  end
+
+
+  def build_reader_methods
+    @options.keys.each do |key|
+      define_singleton_method(key) do
+        @options[key][0]
+      end
+    end
+  end
+
+
+  def process_arguments
+    @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?
+      puts <<~EOS
+
+        ERROR: Unknown options: #{bad_options.join(' ')}
+
+      EOS
+      
+      show_usage
+
+      exit
+    end
+  end
+
+
+  def check_for(option_sym)
+    boolean = option_sym.to_s.end_with?('?')
+    switches = @options[option_sym][1].split
+
+    switches.each do |switch|
+      if @arguments.include?(switch)
+        index = @arguments.index(switch)
+
+        if boolean
+          @options[option_sym][0] = switch.include?('-no-') ? false : true
+          @arguments.slice!(index,1)
+        else
+          if switch.include?('-no-')
+            @options[option_sym][0] = nil
+            @arguments.slice!(index,1)
+          else
+            @options[option_sym][0] = @arguments[index + 1]
+            @arguments.slice!(index,2)
+          end
+        end
+        
+        break
+      end
+    end
+  end
+
+
+
+  def show_usage
+    @options[:help?][0] = false 
+    puts usage
+    exit
+  end
+  alias_method :show_help, :show_usage
+
+
+  def show_version
+    puts AIA::VERSION
+    exit
+  end
+end

data/lib/aia/configuration.rb

@@ -0,0 +1,44 @@
+# lib/aia/configuration.rb
+
+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         = "aia"
+MODS_MODEL      = ENV['MODS_MODEL'] || 'gpt-4-1106-preview'
+OUTPUT          = Pathname.pwd + "temp.md"
+PROMPT_LOG      = PROMPTS_DIR  + "_prompts.log"
+
+
+module AIA::Configuration
+  def setup_configuration
+    @prompt     = nil
+
+    PromptManager::Prompt.storage_adapter = 
+      PromptManager::Storage::FileSystemAdapter.config do |config|
+        config.prompts_dir        = PROMPTS_DIR
+        config.prompt_extension   = '.txt'
+        config.params_extension   = '.json'
+        config.search_proc        = nil
+        # TODO: add the rgfzz script for search_proc
+      end.new
+  end
+
+
+  # Get the additional CLI arguments intended for the
+  # backend gen-AI processor.
+  def extract_extra_options
+    extra_index = @arguments.index('--')
+    if extra_index.nil?
+      @extra_options = []
+    else
+      @extra_options = @arguments.slice!(extra_index..-1)[1..]
+    end
+  end
+
+
+
+
+
+end

data/lib/aia/external/.irbrc

@@ -0,0 +1,11 @@
+
+
+
+module AIA
+  module External
+  end
+end
+
+require_relative 'tool'
+include AIA
+include External

data/lib/aia/external/ag.rb

@@ -0,0 +1,103 @@
+# lib/aia/external/ag.rb
+
+class AIA::External::Ag < AIA::External::Tool
+  def initialize
+    super
+    @role = :search
+    @desc = "the_silver_searcher Code-search similar to ack"
+    @url  = "https://github.com/ggreer/the_silver_searcher"
+  end
+end
+
+__END__
+
+Usage: ag [FILE-TYPE] [OPTIONS] PATTERN [PATH]
+
+  Recursively search for PATTERN in PATH.
+  Like grep or ack, but faster.
+
+Example:
+  ag -i foo /bar/
+
+Output Options:
+     --ackmate            Print results in AckMate-parseable format
+  -A --after [LINES]      Print lines after match (Default: 2)
+  -B --before [LINES]     Print lines before match (Default: 2)
+     --[no]break          Print newlines between matches in different files
+                          (Enabled by default)
+  -c --count              Only print the number of matches in each file.
+                          (This often differs from the number of matching lines)
+     --[no]color          Print color codes in results (Enabled by default)
+     --color-line-number  Color codes for line numbers (Default: 1;33)
+     --color-match        Color codes for result match numbers (Default: 30;43)
+     --color-path         Color codes for path names (Default: 1;32)
+     --column             Print column numbers in results
+     --[no]filename       Print file names (Enabled unless searching a single file)
+  -H --[no]heading        Print file names before each file's matches
+                          (Enabled by default)
+  -C --context [LINES]    Print lines before and after matches (Default: 2)
+     --[no]group          Same as --[no]break --[no]heading
+  -g --filename-pattern PATTERN
+                          Print filenames matching PATTERN
+  -l --files-with-matches Only print filenames that contain matches
+                          (don't print the matching lines)
+  -L --files-without-matches
+                          Only print filenames that don't contain matches
+     --print-all-files    Print headings for all files searched, even those that
+                          don't contain matches
+     --[no]numbers        Print line numbers. Default is to omit line numbers
+                          when searching streams
+  -o --only-matching      Prints only the matching part of the lines
+     --print-long-lines   Print matches on very long lines (Default: >2k characters)
+     --passthrough        When searching a stream, print all lines even if they
+                          don't match
+     --silent             Suppress all log messages, including errors
+     --stats              Print stats (files scanned, time taken, etc.)
+     --stats-only         Print stats and nothing else.
+                          (Same as --count when searching a single file)
+     --vimgrep            Print results like vim's :vimgrep /pattern/g would
+                          (it reports every match on the line)
+  -0 --null --print0      Separate filenames with null (for 'xargs -0')
+
+Search Options:
+  -a --all-types          Search all files (doesn't include hidden files
+                          or patterns from ignore files)
+  -D --debug              Ridiculous debugging (probably not useful)
+     --depth NUM          Search up to NUM directories deep (Default: 25)
+  -f --follow             Follow symlinks
+  -F --fixed-strings      Alias for --literal for compatibility with grep
+  -G --file-search-regex  PATTERN Limit search to filenames matching PATTERN
+     --hidden             Search hidden files (obeys .*ignore files)
+  -i --ignore-case        Match case insensitively
+     --ignore PATTERN     Ignore files/directories matching PATTERN
+                          (literal file/directory names also allowed)
+     --ignore-dir NAME    Alias for --ignore for compatibility with ack.
+  -m --max-count NUM      Skip the rest of a file after NUM matches (Default: 10,000)
+     --one-device         Don't follow links to other devices.
+  -p --path-to-ignore STRING
+                          Use .ignore file at STRING
+  -Q --literal            Don't parse PATTERN as a regular expression
+  -s --case-sensitive     Match case sensitively
+  -S --smart-case         Match case insensitively unless PATTERN contains
+                          uppercase characters (Enabled by default)
+     --search-binary      Search binary files for matches
+  -t --all-text           Search all text files (doesn't include hidden files)
+  -u --unrestricted       Search all files (ignore .ignore, .gitignore, etc.;
+                          searches binary and hidden files as well)
+  -U --skip-vcs-ignores   Ignore VCS ignore files
+                          (.gitignore, .hgignore; still obey .ignore)
+  -v --invert-match
+  -w --word-regexp        Only match whole words
+  -W --width NUM          Truncate match lines after NUM characters
+  -z --search-zip         Search contents of compressed (e.g., gzip) files
+
+File Types:
+The search can be restricted to certain types of files. Example:
+  ag --html needle
+  - Searches for 'needle' in files with suffix .htm, .html, .shtml or .xhtml.
+
+For a list of supported file types run:
+  ag --list-file-types
+
+ag was originally created by Geoff Greer. More information (and the latest release)
+can be found at http://geoff.greer.fm/ag