aia 0.3.20 → 0.4.1

data/man/aia.1

@@ -22,68 +22,67 @@ This is an optional argument\.  One or more files can be added to the prompt as
 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
+\fB\-\-chat\fR
+begin a chat session with the backend after the initial prompt response;  will set \-\-no\-output so that the backend response comes to STDOUT\.
+.TP
+\fB\-\-completion\fR \fISHELL\[ru]NAME\fP
 .TP
 \fB\-\-dump\fR \fIFORMAT\fP
 .TP
-\fB\-e\fR, \fB\-\-edit\fR
-Edit the Prompt File \- default: false
+\fB\-\-model\fR \fINAME\fP
+Name of the LLM model to use \- default is gpt\-4\-1106\-preview
 .TP
-\fB\-d\fR, \fB\-\-debug\fR
-Turn On Debugging \- default: false
+\fB\-\-speak\fR
+Simple implementation\. Uses the \[lq]say\[rq] command to speak the response\.  Fun with \-\-chat
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
-Be Verbose \- default: false
+\fB\-\-terse\fR
+Add a clause to the prompt text that instructs the backend to be terse in its response\.
 .TP
 \fB\-\-version\fR
-Print Version \- default: false
+Print Version \- default is false
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-Show Usage \- default: false
+\fB\-b\fR, \fB\-\-\[lB]no\[rB]\-backend\fR \fILLM TOOL\fP
+Specify the backend prompt resolver \- default is mods
 .TP
-\fB\-s\fR, \fB\-\-search\fR \fITERM\fP
-Search for prompts contain TERM \- default: nil
+\fB\-c\fR, \fB\-\-config\fR \fIPATH\[ru]TO\[ru]CONFIG\[ru]FILE\fP
+Load Config File \- default is nil
 .TP
-\fB\-f\fR, \-\-fuzzy\`
-Use Fuzzy Matching when searching for a prompt \- default: false
+\fB\-d\fR, \fB\-\-debug\fR
+Turn On Debugging \- default is false
 .TP
-\fB\-\-completion\fR \fISHELL\[ru]NAME\fP
+\fB\-e\fR, \fB\-\-edit\fR
+Edit the Prompt File \- default is false
 .TP
-\fB\-o\fR, \fB\-\-\[lB]no\[rB]\-output\fR \fIPATH\[ru]TO\[ru]OUTPUT\[ru]FILE\fP
-Out FILENAME \- default: \.\[sl]temp\.md
+\fB\-f\fR, \-\-fuzzy\`
+Use Fuzzy Matching when searching for a prompt \- default is false
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show Usage \- default is false
 .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
+Log FILEPATH \- default is \[Do]HOME\[sl]\.prompts\[sl]prompts\.log
 .TP
 \fB\-m\fR, \fB\-\-\[lB]no\[rB]\-markdown\fR
-Format with Markdown \- default: true
+Format with Markdown \- default is true
 .TP
-\fB\-\-model\fR \fINAME\fP
-Name of the LLM model to use \- default: gpt\-4\-1106\-preview
+\fB\-o\fR, \fB\-\-\[lB]no\[rB]\-output\fR \fIPATH\[ru]TO\[ru]OUTPUT\[ru]FILE\fP
+Out FILENAME \- default is \.\[sl]temp\.md
 .TP
 \fB\-p\fR, \fB\-\-prompts\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
-Directory containing the prompt files \- default: \[ti]\[sl]\.prompts
+Directory containing the prompt files \- default is \[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
+\fB\-v\fR, \fB\-\-verbose\fR
+Be Verbose \- default is false
+.SH CONFIGURATION HIERARCHY
 .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
+System Environment Variables (envars) that are all uppercase and begin with \[lq]AIA\[ru]\[rq] can be used to over\-ride the default configuration settings\.  For example setting \[lq]export AIA\[ru]PROMPTS\[ru]DIR\[eq]\[ti]\[sl]Documents\[sl]prompts\[rq] will over\-ride the default configuration; however, a config value provided by a command line options will over\-ride an envar setting\.
+.PP
+Configuration values found in a config file will over\-ride all other values set for a config item\.
+.PP
+\[rq]\[sl]\[sl]config\[rq] directives found inside a prompt file over\-rides that config item regardless of where the value was set\.
+.PP
+For example \[lq]\[sl]\[sl]config chat? \[eq] true\[rq] 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\[ru]CHAT settings
+.SH OpenAI ACCOUNT IS REQUIRED
 .PP
 Additionally, the program requires an OpenAI access key, which can be specified using one of the following environment variables:
 .RS
@@ -98,9 +97,19 @@ Currently there is not specific standard for name of the OpenAI key\.  Some prog
 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\.
+\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 (STDPIT)\.
 .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\.
+.PP
+The \fB\-\-dump\fR options will send the current configuration to STDOUT in the format requested\.  Both YAML and TOML formats are supported\.
+.SH PROMPT DIRECTIVES
+.PP
+Within a prompt text file any line that begins with \[lq]\[sl]\[sl]\[rq] is considered a prompt directive\.  There are numerious prompt directives available\.  In the discussion above on the configuration you learned about the \[lq]\[sl]\[sl]config\[rq] directive\.
+.PP
+Detail discussion on individual prompt directives is TBD\.  Most likely it will be handled in the github wiki
+.UR https:\[sl]\[sl]github\.com\[sl]MadBomber\[sl]aia
+.UE
+\.
 .SH SEE ALSO
 .RS
 .IP \(bu 2

data/man/aia.1.md

@@ -1,9 +1,11 @@
 # 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
@@ -23,63 +25,72 @@ The aia command-line tool is an interface for interacting with an AI model backe
 
 ## OPTIONS
 
-`-c`, `--config` *PATH_TO_CONFIG_FILE*
-: Load Config File - default: nil
+`--chat`
+: begin a chat session with the backend after the initial prompt response;  will set --no-output so that the backend response comes to STDOUT.
+
+`--completion` *SHELL_NAME*
+: Show completion script for bash|zsh|fish - default is nil
 
 `--dump` *FORMAT*
-: Dump a Config File in [yaml | toml] to STDOUT - default: nil
+: Dump a Config File in [yaml | toml] to STDOUT - default is nil
 
-`-e`, `--edit`
-: Edit the Prompt File - default: false
+`--model` *NAME*
+: Name of the LLM model to use - default is gpt-4-1106-preview
 
-`-d`, `--debug`
-: Turn On Debugging - default: false
+`--speak`
+: Simple implementation. Uses the "say" command to speak the response.  Fun with --chat
 
-`-v`, `--verbose`
-: Be Verbose - default: false
+`--terse`
+: Add a clause to the prompt text that instructs the backend to be terse in its response.
 
 `--version`
-: Print Version - default: false
+: Print Version - default is false
 
-`-h`, `--help`
-: Show Usage - default: false
+`-b`, `--[no]-backend` *LLM TOOL*
+: Specify the backend prompt resolver - default is mods
 
-`-s`, `--search` *TERM*
-: Search for prompts contain TERM - default: nil
+`-c`, `--config` *PATH_TO_CONFIG_FILE*
+: Load Config File - default is nil
 
-`-f`, --fuzzy`
-: Use Fuzzy Matching when searching for a prompt - default: false
+`-d`, `--debug`
+: Turn On Debugging - default is false
 
-`--completion` *SHELL_NAME*
-: Show completion script for bash|zsh|fish - default: nil
+`-e`, `--edit`
+: Edit the Prompt File - default is false
 
-`-o`, `--[no]-output` *PATH_TO_OUTPUT_FILE*
-: Out FILENAME - default: ./temp.md
+`-f`, --fuzzy`
+: Use Fuzzy Matching when searching for a prompt - default is false
+
+`-h`, `--help`
+: Show Usage - default is false
 
 `-l`, `--[no]-log` *PATH_TO_LOG_FILE*
-: Log FILEPATH - default: $HOME/.prompts/prompts.log
+: Log FILEPATH - default is $HOME/.prompts/prompts.log
 
 `-m`, `--[no]-markdown`
-: Format with Markdown - default: true
+: Format with Markdown - default is true
 
-`--model` *NAME*
-: Name of the LLM model to use - default: gpt-4-1106-preview
+`-o`, `--[no]-output` *PATH_TO_OUTPUT_FILE*
+: Out FILENAME - default is ./temp.md
 
 `-p`, `--prompts` *PATH_TO_DIRECTORY*
-: Directory containing the prompt files - default: ~/.prompts
+: Directory containing the prompt files - default is ~/.prompts
 
-`-b`, `--[no]-backend` *LLM TOOL*
-: Specify the backend prompt resolver - default: :mods
+`-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.
 
-## ENVIRONMENT  
-The aia CLI uses the following environment variables:
+Configuration values found in a config file will over-ride all other values set for a config item.
 
-- `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`
+"//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:
 
@@ -90,12 +101,22 @@ Currently there is not specific standard for name of the OpenAI key.  Some progr
 
 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.
+## 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 (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.
 
-## SEE ALSO  
+The `--dump` options will send the current configuration to STDOUT in the format requested.  Both YAML and TOML formats are supported.
+
+## 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.3.20
+  version: 0.4.1
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -26,6 +26,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: prompt_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: reline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,15 +192,16 @@ files:
 - lib/aia/aia_completion.zsh
 - lib/aia/cli.rb
 - lib/aia/config.rb
+- lib/aia/directives.rb
 - lib/aia/logging.rb
 - lib/aia/main.rb
-- lib/aia/prompt_processing.rb
+- lib/aia/prompt.rb
 - lib/aia/tools.rb
+- lib/aia/tools/backend_common.rb
 - lib/aia/tools/editor.rb
 - lib/aia/tools/mods.rb
 - lib/aia/tools/sgpt.rb
 - lib/aia/tools/subl.rb
-- lib/aia/tools/temp.md
 - lib/aia/tools/vim.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb