aia 0.3.3 → 0.3.19

data/man/aia.1

@@ -0,0 +1,134 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH aia 1 "2024-01-01" AIA "User Manuals"
+.SH NAME
+.PP
+aia \- command\-line interface for an AI assistant
+.SH SYNOPSIS
+.PP
+aia \[lB]options\[rB]* PROMPT\[ru]ID \[lB]CONTEXT\[ru]FILE\[rB]* \[lB]\-\- EXTERNAL\[ru]OPTIONS\[pl]\[rB]
+.SH DESCRIPTION
+.PP
+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\.
+.SH ARGUMENTS
+.TP
+\fIPROMPT\[ru]ID\fP
+This is a required argument\.
+.TP
+\fICONTEXT\[ru]FILES\fP
+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\.
+.TP
+\fIEXTERNAL\[ru]OPTIONS\fP
+External options are optional\.  Anything that follow \[lq] \-\- \[lq] will be sent to the backend gen\-AI tool\.  For example \[lq]\-\- \-C \-m gpt4\-128k\[rq] will send the options \[lq]\-C \-m gpt4\-128k\[rq] to the backend gen\-AI tool\.  \fBaia\fR will not validate these external options before sending them to the backend gen\-AI tool\.
+.SH OPTIONS
+.TP
+\fB\-c\fR, \fB\-\-config\fR \fIPATH\[ru]TO\[ru]CONFIG\[ru]FILE\fP
+Load Config File \- default: nil
+.TP
+\fB\-\-dump\fR \fIFORMAT\fP
+.TP
+\fB\-e\fR, \fB\-\-edit\fR
+Edit the Prompt File \- default: false
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Turn On Debugging \- default: false
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Be Verbose \- default: false
+.TP
+\fB\-\-version\fR
+Print Version \- default: false
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show Usage \- default: false
+.TP
+\fB\-s\fR, \fB\-\-search\fR \fITERM\fP
+Search for prompts contain TERM \- default: nil
+.TP
+\fB\-f\fR, \-\-fuzzy\`
+Use Fuzzy Matching when searching for a prompt \- default: false
+.TP
+\fB\-\-completion\fR \fISHELL\[ru]NAME\fP
+.TP
+\fB\-o\fR, \fB\-\-\[lB]no\[rB]\-output\fR \fIPATH\[ru]TO\[ru]OUTPUT\[ru]FILE\fP
+Out FILENAME \- default: \.\[sl]temp\.md
+.TP
+\fB\-l\fR, \fB\-\-\[lB]no\[rB]\-log\fR \fIPATH\[ru]TO\[ru]LOG\[ru]FILE\fP
+Log FILEPATH \- default: \[Do]HOME\[sl]\.prompts\[sl]prompts\.log
+.TP
+\fB\-m\fR, \fB\-\-\[lB]no\[rB]\-markdown\fR
+Format with Markdown \- default: true
+.TP
+\fB\-\-model\fR \fINAME\fP
+Name of the LLM model to use \- default: gpt\-4\-1106\-preview
+.TP
+\fB\-p\fR, \fB\-\-prompts\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
+Directory containing the prompt files \- default: \[ti]\[sl]\.prompts
+.TP
+\fB\-b\fR, \fB\-\-\[lB]no\[rB]\-backend\fR \fILLM TOOL\fP
+Specify the backend prompt resolver \- default: :mods
+.SH ENVIRONMENT
+.PP
+The aia CLI uses the following environment variables:
+.RS
+.IP \(bu 2
+\fBAIA\[ru]PROMPTS\[ru]DIR\fR: Path to the directory containing prompts files \- default: \fB\[Do]HOME\[sl]\.prompts\[ru]dir\fR
+.IP \(bu 2
+\fBAIA\[ru]BACKEND\fR: The AI command\-line program used \- default: \fBmods\fR
+.IP \(bu 2
+\fBEDITOR\fR: The text editor used by the edit option \- default: edit
+.IP \(bu 2
+\fBAIA\[ru]MODEL\fR: The AI model specification \- default: \fBgpt\-4\-1106\-preview\fR
+.IP \(bu 2
+\fBAIA\[ru]OUTPUT\fR: The default filename for output \- default: \fB\.\[sl]temp\.md\fR
+.IP \(bu 2
+\fBAIA\[ru]PROMPT\[ru]LOG\fR: The default filepath for the prompts log \- default: \fB\[Do]HOME\[sl]\.prompts\[sl]\[ru]prompts\.log\fR
+.RE
+.PP
+Additionally, the program requires an OpenAI access key, which can be specified using one of the following environment variables:
+.RS
+.IP \(bu 2
+\fBOPENAI\[ru]ACCESS\[ru]TOKEN\fR
+.IP \(bu 2
+\fBOPENAI\[ru]API\[ru]KEY\fR
+.RE
+.PP
+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\.
+.PP
+To acquire an OpenAI access key, first create an account on the OpenAI platform, where further documentation is available\.
+.SH USAGE NOTES
+.PP
+\fBaia\fR 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 \fB\-\-output\fR for specifying a file or \fB\-\-no\-output\fR for disabling file output in favor of standard output\.
+.PP
+The \fB\-\-completion\fR option displays a script that enables prompt ID auto\-completion for bash, zsh, or fish shells\. It\[cq]s crucial to integrate the script into the shell\[cq]s runtime to take effect\.
+.SH SEE ALSO
+.RS
+.IP \(bu 2
+OpenAI Platform Documentation
+.UR https:\[sl]\[sl]platform\.openai\.com\[sl]docs\[sl]overview
+.UE
+ for more information on obtaining access tokens
+.UR https:\[sl]\[sl]platform\.openai\.com\[sl]account\[sl]api\-keys
+.UE
+ and working with OpenAI models\.
+.IP \(bu 2
+mods
+.UR https:\[sl]\[sl]github\.com\[sl]charmbracelet\[sl]mods
+.UE
+ for more information on \fBmods\fR \- 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
+.UR https:\[sl]\[sl]platform\.openai\.com\[sl]account\[sl]api\-keys
+.UE
+ and LocalAI
+.UR https:\[sl]\[sl]github\.com\[sl]go\-skynet\[sl]LocalAI
+.UE
+.IP \(bu 2
+sgpt
+.UR https:\[sl]\[sl]github\.com\[sl]tbckr\[sl]sgpt
+.UE
+ (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\.
+.RE
+.SH AUTHOR
+.PP
+Dewayne VanHoozer 
+.MT dvanhoozer\[at]gmail\.com
+.ME

data/man/aia.1.md

@@ -0,0 +1,107 @@
+# aia 1 "2024-01-01" AIA "User Manuals"
+
+## 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
+
+`-c`, `--config` *PATH_TO_CONFIG_FILE*
+: Load Config File - default: nil
+
+`--dump` *FORMAT*
+: Dump a Config File in [yaml | toml] to STDOUT - default: nil
+
+`-e`, `--edit`
+: Edit the Prompt File - default: false
+
+`-d`, `--debug`
+: Turn On Debugging - default: false
+
+`-v`, `--verbose`
+: Be Verbose - default: false
+
+`--version`
+: Print Version - default: false
+
+`-h`, `--help`
+: Show Usage - default: false
+
+`-s`, `--search` *TERM*
+: Search for prompts contain TERM - default: nil
+
+`-f`, --fuzzy`
+: Use Fuzzy Matching when searching for a prompt - default: false
+
+`--completion` *SHELL_NAME*
+: Show completion script for bash|zsh|fish - default: nil
+
+`-o`, `--[no]-output` *PATH_TO_OUTPUT_FILE*
+: Out FILENAME - default: ./temp.md
+
+`-l`, `--[no]-log` *PATH_TO_LOG_FILE*
+: Log FILEPATH - default: $HOME/.prompts/prompts.log
+
+`-m`, `--[no]-markdown`
+: Format with Markdown - default: true
+
+`--model` *NAME*
+: Name of the LLM model to use - default: gpt-4-1106-preview
+
+`-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:
+
+- `AIA_PROMPTS_DIR`: Path to the directory containing prompts files - default: `$HOME/.prompts_dir`
+- `AIA_BACKEND`: The AI command-line program used - default: `mods`
+- `EDITOR`: The text editor used by the edit option - default: edit
+- `AIA_MODEL`: The AI model specification - default: `gpt-4-1106-preview`
+- `AIA_OUTPUT`: The default filename for output - default: `./temp.md`
+- `AIA_PROMPT_LOG`: The default filepath for the prompts log - default: `$HOME/.prompts/_prompts.log`
+
+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 `--output` for specifying a file or `--no-output` for disabling file output in favor of standard output.
+
+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.
+
+## 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.
+
+## AUTHOR
+
+Dewayne VanHoozer <dvanhoozer@gmail.com>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.19
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-02 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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
@@ -24,6 +38,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: semver2
+  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: toml-rb
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: amazing_print
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: kramdown-man
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,37 +150,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".envrc"
+- ".semver"
 - CHANGELOG.md
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/aia
+- justfile
 - lib/aia.rb
 - lib/aia/aia_completion.bash
 - lib/aia/aia_completion.fish
 - lib/aia/aia_completion.zsh
 - lib/aia/cli.rb
-- lib/aia/configuration.rb
-- lib/aia/external.rb
-- lib/aia/external/,keep
-- lib/aia/external/.irbrc
-- lib/aia/external/ag.rb
-- lib/aia/external/bat.rb
-- lib/aia/external/fzf.rb
-- lib/aia/external/glow.rb
-- lib/aia/external/mods.rb
-- lib/aia/external/rg.rb
-- lib/aia/external/sgpt.rb
-- lib/aia/external/subl.rb
-- lib/aia/external/tool.rb
-- lib/aia/external_two.rb
+- lib/aia/config.rb
 - lib/aia/logging.rb
 - lib/aia/main.rb
 - lib/aia/prompt_processing.rb
+- lib/aia/tools.rb
+- lib/aia/tools/editor.rb
+- lib/aia/tools/mods.rb
+- lib/aia/tools/sgpt.rb
+- lib/aia/tools/subl.rb
+- 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
 homepage: https://github.com/MadBomber/aia
 licenses:
 - MIT
@@ -148,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: AI Assistant (aia) a command-line (CLI) utility

data/lib/aia/configuration.rb

@@ -1,39 +0,0 @@
-# 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

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

data/lib/aia/external/ag.rb

@@ -1,103 +0,0 @@
-# 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