aia 0.5.8 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97bd3e1401d2883bca0d6ce3ab427a9fab12d3b71b2114a87fe278a0360f3693
-  data.tar.gz: 0333f04542cde2c853ccd00aff70e90b9d680960020f5187ab0b265916c24a27
+  metadata.gz: 1cd315c42710fcff586cb6159b981fd3a1ba8c85cc950985dd46b93eb9b00ef1
+  data.tar.gz: c97d4f8db6bfc74f047ad439a6ddbddcdde72cd5dce614b1341c356a71bbad92
 SHA512:
-  metadata.gz: 17395c59e8aabf7d4994236fd407beaf2231c6d05744af1fcd84ae588ad7ffcd4abd853096728ca50fb09976075b4ac920200e6732d7736d072e2d2a4071e7fb
-  data.tar.gz: f8f21824485408330c31fe99b6b77fd072e08486ccd4293df9f9a55fc464369081f901f0bf6bc8c818e2238ad17d63ce497f164cd9960967d0f55942558c55c8
+  metadata.gz: 7cb087fe893bae9bf366c8cee81d4c35f329198a3508c475cbfd077661afff794299791d41b5af6faed0580e2a22eae9559ea69d6edad2a61705b81e54d52dd1
+  data.tar.gz: d76aba8685317e19ca534202a6dcce5ac61255702abc9e5f8ffd751c2f9ff778499048ac45a5ff7a5a5ffd5222e3249e5cd51a15398f20430f010d6900a27c99

data/.better-commits.json

@@ -0,0 +1,150 @@
+{
+    "check_status": true,
+    "commit_type": {
+        "enable": true,
+        "initial_value": "feat",
+        "infer_type_from_branch": true,
+        "append_emoji_to_label": false,
+        "append_emoji_to_commit": false,
+        "options": [
+            {
+                "value": "feat",
+                "label": "feat",
+                "hint": "A new feature",
+                "emoji": "✨"
+            },
+            {
+                "value": "fix",
+                "label": "fix",
+                "hint": "A bug fix",
+                "emoji": "🐛"
+            },
+            {
+                "value": "docs",
+                "label": "docs",
+                "hint": "Documentation only changes",
+                "emoji": "📚"
+            },
+            {
+                "value": "refactor",
+                "label": "refactor",
+                "hint": "A code change that neither fixes a bug nor adds a feature",
+                "emoji": "🔨"
+            },
+            {
+                "value": "perf",
+                "label": "perf",
+                "hint": "A code change that improves performance",
+                "emoji": "🚀"
+            },
+            {
+                "value": "test",
+                "label": "test",
+                "hint": "Adding missing tests or correcting existing tests",
+                "emoji": "🚨"
+            },
+            {
+                "value": "build",
+                "label": "build",
+                "hint": "Changes that affect the build system or external dependencies",
+                "emoji": "🚧"
+            },
+            {
+                "value": "ci",
+                "label": "ci",
+                "hint": "Changes to our CI configuration files and scripts",
+                "emoji": "🤖"
+            },
+            {
+                "value": "chore",
+                "label": "chore",
+                "hint": "Other changes that do not modify src or test files",
+                "emoji": "🧹"
+            },
+            {
+                "value": "",
+                "label": "none"
+            }
+        ]
+    },
+    "commit_scope": {
+        "enable": true,
+        "custom_scope": false,
+        "initial_value": "app",
+        "options": [
+            {
+                "value": "app",
+                "label": "app"
+            },
+            {
+                "value": "shared",
+                "label": "shared"
+            },
+            {
+                "value": "server",
+                "label": "server"
+            },
+            {
+                "value": "tools",
+                "label": "tools"
+            },
+            {
+                "value": "",
+                "label": "none"
+            }
+        ]
+    },
+    "check_ticket": {
+        "infer_ticket": true,
+        "confirm_ticket": true,
+        "add_to_title": true,
+        "append_hashtag": false,
+        "title_position": "start"
+    },
+    "commit_title": {
+        "max_size": 70
+    },
+    "commit_body": {
+        "enable": true,
+        "required": false
+    },
+    "commit_footer": {
+        "enable": true,
+        "initial_value": [],
+        "options": [
+            "closes",
+            "breaking-change",
+            "deprecated",
+            "custom"
+        ]
+    },
+    "breaking_change": {
+        "add_exclamation_to_title": true
+    },
+    "confirm_commit": true,
+    "print_commit_output": true,
+    "branch_pre_commands": [],
+    "branch_post_commands": [],
+    "worktree_pre_commands": [],
+    "worktree_post_commands": [],
+    "branch_user": {
+        "enable": true,
+        "required": false,
+        "separator": "/"
+    },
+    "branch_type": {
+        "enable": true,
+        "separator": "/"
+    },
+    "branch_ticket": {
+        "enable": true,
+        "required": false,
+        "separator": "_"
+    },
+    "branch_description": {
+        "max_length": 70
+    },
+    "branch_action_default": "branch",
+    "enable_worktrees": true,
+    "overrides": {}
+}

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
 :minor: 5
-:patch: 8
+:patch: 10
 :special: ''
 :metadata: ''

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.5.10] 2024-02-03
+- Added --roles_dir to isolate roles from other prompts if desired
+- Changed --prompts to --prompts_dir to be consistent
+- Refactored common fzf usage into its own tool class
+
+## [0.5.9] 2024-02-01
+- Added a "I'm working" spinner thing when "--verbose" is used as an indication that the backend is in the process of composing its response to the prompt.
+
 ## [0.5.8] 2024-01-17
 - Changed the behavior of the --dump option.  It must now be followed by path/to/file.ext where ext is a supported config file format: yml, yaml, toml
 

data/README.md

@@ -5,23 +5,17 @@
 It leverages the `prompt_manager` gem to manage prompts for the `mods` and `sgpt` CLI utilities. It utilizes "ripgrep" for searching for prompt files.  It uses `fzf` for prompt selection based on a search term and fuzzy matching.
 
 **Most Recent Change**: Refer to the [Changelog](CHANGELOG.md)
-v0.5.7
-- Added ERB processing to config files that have the pattern any_file.ext.erb where ext is the real extension of the file.
 
-v0.5.6
-- Directives within a chat session follow up are now available
-- when the `--shell` option is set access to envars and shell scripts are availabe in a chat session follow up prompt
-- when the `--erb` option is set, access to ERB-based dynamic content is available in a chat session follow up prompt.
-
-v0.5.3
-- `--render` will render markdown formatted content to the terminal using the `glow` CLI utility.
-- fixes to some terminal UI stuff like AI response is not being wrapped to the terminal width to make for easier reading.
-- fixed the completion functions to use the correct $AIA_PROMPTS_DIR envar
-
-v0.5.0 - Breaking changes: 
-- `--config` is now `--config_file`
-- `--env` is now `--shell`
-- `--output` is now `--out_file`
+> v0.5.10
+> - Added --roles_dir
+> - Changed --prompts to --prompts_dir
+> - Fixed Issue 33
+>
+> v0.5.9
+> - When "--verbose" is used, an animation is shown while the backend is composing its response to the prompt.
+> 
+> v0.5.7
+> - Added ERB processing to config files that have the pattern any_file.ext.erb where ext is the real extension of the file.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -42,10 +36,13 @@ v0.5.0 - Breaking changes:
     - [Backend Directive Commands](#backend-directive-commands)
     - [Using Directives in Chat Sessions](#using-directives-in-chat-sessions)
   - [All About ROLES](#all-about-roles)
+    - [The --roles_dir (AIA_ROLES_DIR)](#the---roles_dir-aia_roles_dir)
+    - [The --role Option](#the---role-option)
     - [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)
   - [My Most Powerful Prompt](#my-most-powerful-prompt)
+  - [My Configuration](#my-configuration)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -66,7 +63,7 @@ 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 "AIA_PROMPTS_DIR" that points to your prompts directory.  The default is in your HOME directory named ".prompts_dir"
+Setup a system environment variable (envar) named "AIA_PROMPTS_DIR" that points to your prompts directory.  The default is in your HOME directory named ".prompts". The envar "AIA_ROLES_DIR" points to your role directory where you have prompts that define the different roles you want the LLM to assume when it is doing its work.  The default roles directory is inside the prompts directory.  Its name is "roles".
 
 You may also want to install the completion script for your shell.  To get a copy of the completion script do:
 
@@ -82,97 +79,126 @@ The usage report obtained using either `-h` or `--help` is implemented as a stan
 ```text
 $ aia --help
 
-aia(1)                                   User Manuals                                  aia(1)
+aia(1)                    User Manuals                    aia(1)
 
 NAME
        aia - command-line interface for an AI assistant
 
 SYNOPSIS
-       aia [options]* PROMPT_ID [CONTEXT_FILE]* [-- EXTERNAL_OPTIONS+]
+       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.
+       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.
+              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.
+              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
-       --chat begin a chat session with the backend after the initial prompt response;  will
-              set --no-out_file so that the backend response comes to STDOUT.  After the
-              initial prompt is processed, you will be asked to provide a follow up.  Just
-              enter whatever is appropriate terminating your input with a RETURN.  The
-              backend will provide a response to you follow up and ask you again if you have
-              another follow up. This back and forth chatting will continue until you enter a
-              RETURN without any other content - an empty follow up prompt.  You may also
-              enter a directive to be processed after which another follow up is requested.
-              If you have the --shell and/or the --erb options set you may use those tools
-              within your follow up to provide dynamic content.
+       --chat begin a chat session with the backend after the
+              initial prompt response;  will set --no-out_file
+              so that the backend response comes to STDOUT.
+              After the initial prompt is processed, you will be
+              asked to provide a follow up.  Just enter whatever
+              is appropriate terminating your input with a
+              RETURN.  The backend will provide a response to
+              you follow up and ask you again if you have
+              another follow up. This back and forth chatting
+              will continue until you enter a RETURN without any
+              other content - an empty follow up prompt.  You
+              may also enter a directive to be processed after
+              which another follow up is requested.  If you have
+              the --shell and/or the --erb options set you may
+              use those tools within your follow up to provide
+              dynamic content.
 
        --completion SHELL_NAME
 
        --dump PATH/TO/FILE.ext
-              Dump the current configuration to a file in the format denoted by the file’s
-              extension.  Currently only .yml, .yaml and .toml are acceptable file
-              extensions.  If the file exists, it will be over-written without warning.
+              Dump the current configuration to a file in the
+              format denoted by the file’s extension.  Currently
+              only .yml, .yaml and .toml are acceptable file
+              extensions.  If the file exists, it will be
+              over-written without warning.
 
        -e, --edit
-              Invokes an editor on the prompt file.  You can make changes to the prompt file,
-              save it and the newly saved prompt will be processed by the backend.
+              Invokes an editor on the prompt file.  You can
+              make changes to the prompt file, save it and the
+              newly saved prompt will be processed by the
+              backend.
 
        --shell
-              This option tells aia to replace references to system environment variables in
-              the prompt with the value of the envar.  envars are like $HOME and ${HOME} in
-              this example their occurance will be replaced by the value of ENV[‘HOME’].
-              Also the dynamic shell command in the pattern $(shell command) will be executed
-              and its output replaces its pattern.  It does not matter if your shell uses
-              different patters than BASH since the replacement is being done within a Ruby
-              context.
-
-       --erb  If dynamic prompt content using $(...) wasn’t enough here is ERB.  Embedded
-              RUby.  <%= ruby code %> within a prompt will have its ruby code executed and
-              the results of that execution will be inserted into the prompt.  I’m sure we
-              will find a way to truly misuse this capability.  Remember, some say that the
-              simple prompt is the best prompt.
+              This option tells aia to replace references to
+              system environment variables in the prompt with
+              the value of the envar.  envars are like $HOME and
+              ${HOME} in this example their occurance will be
+              replaced by the value of ENV[‘HOME’].  Also the
+              dynamic shell command in the pattern $(shell
+              command) will be executed and its output replaces
+              its pattern.  It does not matter if your shell
+              uses different patters than BASH since the
+              replacement is being done within a Ruby context.
+
+       --erb  If dynamic prompt content using $(...) wasn’t
+              enough here is ERB.  Embedded RUby.  <%= ruby code
+              %> within a prompt will have its ruby code
+              executed and the results of that execution will be
+              inserted into the prompt.  I’m sure we will find a
+              way to truly misuse this capability.  Remember,
+              some say that the simple prompt is the best
+              prompt.
 
        --model NAME
-              Name of the LLM model to use - default is gpt-4-1106-preview
+              Name of the LLM model to use - default is
+              gpt-4-1106-preview
 
        --render
-              Render markdown to the terminal using the external tool “glow” - default: false
+              Render markdown to the terminal using the external
+              tool “glow” - default: false
 
        --speak
-              Simple implementation. Uses the “say” command to speak the response.  Fun with
-              --chat
+              Simple implementation. Uses the “say” command to
+              speak the response.  Fun with --chat
 
        --terse
-              Add a clause to the prompt text that instructs the backend to be terse in its
-              response.
+              Add a clause to the prompt text that instructs the
+              backend to be terse in its response.
 
        --version
               Print Version - default is false
 
        -b, --[no]-backend LLM TOOL
-              Specify the backend prompt resolver - default is mods
+              Specify the backend prompt resolver - default is
+              mods
 
        -c, --config_file PATH_TO_CONFIG_FILE
-              Load Config File. both YAML and TOML formats are supported.  Also ERB is
-              supported.  For example ~/aia_config.yml.erb will be processed through ERB and
-              then through YAML.  The result will be written out to ~/aia_config.yml so that
-              you can manually verify that you got what you wanted from the ERB processing.
+              Load Config File. both YAML and TOML formats are
+              supported.  Also ERB is supported.  For example
+              ~/aia_config.yml.erb will be processed through ERB
+              and then through YAML.  The result will be written
+              out to ~/aia_config.yml so that you can manually
+              verify that you got what you wanted from the ERB
+              processing.
 
        -d, --debug
               Turn On Debugging - default is false
@@ -181,13 +207,15 @@ OPTIONS
               Edit the Prompt File - default is false
 
        -f, --fuzzy`
-              Use Fuzzy Matching when searching for a prompt - default is false
+              Use Fuzzy Matching when searching for a prompt -
+              default is false
 
        -h, --help
               Show Usage - default is false
 
        -l, --[no]-log_file PATH_TO_LOG_FILE
-              Log FILEPATH - default is $HOME/.prompts/prompts.log
+              Log FILEPATH - default is
+              $HOME/.prompts/prompts.log
 
        -m, --[no]-markdown
               Format with Markdown - default is true
@@ -195,107 +223,143 @@ OPTIONS
        -o, --[no]-out_file PATH_TO_OUTPUT_FILE
               Out FILENAME - default is ./temp.md
 
-       -p, --prompts PATH_TO_DIRECTORY
-              Directory containing the prompt files - default is ~/.prompts
+       -p, --prompts_dir PATH_TO_DIRECTORY
+              Directory containing the prompt files - default is
+              ~/.prompts
+
+       --roles_dir PATH_TO_DIRECTORY
+              Directory containing the personification prompt
+              files - default is ~/.prompts/roles
 
        -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.
+              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
 
 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.
-
-       Configuration values found in a config file will over-ride all other values set for a
-       config item.
-
-       ”//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
+       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.
+
+       Configuration values found in a config file will
+       over-ride all other values set for a config item.
+
+       ”//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:
+       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.
+       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.
+       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 --out_file for
-       specifying a file or --no-out_file 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
+       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 --out_file for
+       specifying a file or --no-out_file 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.
 
-       The --dump path/to/file.ext option will write the current configuration to a file in
-       the format requested by the file’s extension.  The following extensions are supported:
-       .yml, .yaml and .toml
+       The --dump path/to/file.ext option will write the current
+       configuration to a file in the format requested by the
+       file’s extension.  The following extensions are
+       supported:  .yml, .yaml and .toml
 
 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.
+       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>
+       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>
+              • 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
+                 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>
+                 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.
+                 (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.
 
               • fzf <https://github.com/junegunn/fzf>
-                 fzf is a general-purpose command-line fuzzy finder.  It’s an interactive
-                Unix filter for command-line that can be used with any list; files, command
-                history, processes, hostnames, bookmarks, git commits, etc.
+                 fzf is a general-purpose command-line fuzzy
+                finder.  It’s an interactive Unix filter for
+                command-line that can be used with any list;
+                files, command history, processes, hostnames,
+                bookmarks, git commits, etc.
 
               • ripgrep <https://github.com/BurntSushi/ripgrep>
-                 Search tool like grep and The Silver Searcher. It is a line-oriented search
-                tool that recursively searches a directory tree for a regex pattern. By
-                default, ripgrep will respect gitignore rules and automatically skip hidden
-                files/directories and binary files. (To disable all automatic filtering by
-                default, use rg -uuu.) ripgrep has first class support on Windows, macOS and
-                Linux, with binary downloads available for every release.
+                 Search tool like grep and The Silver Searcher.
+                It is a line-oriented search tool that
+                recursively searches a directory tree for a
+                regex pattern. By default, ripgrep will respect
+                gitignore rules and automatically skip hidden
+                files/directories and binary files. (To disable
+                all automatic filtering by default, use rg
+                -uuu.) ripgrep has first class support on
+                Windows, macOS and Linux, with binary downloads
+                available for every release.
 
               • glow <https://github.com/charmbracelet/glow>
                  Render markdown on the CLI
@@ -303,10 +367,9 @@ SEE ALSO
 AUTHOR
        Dewayne VanHoozer <dvanhoozer@gmail.com>
 
-AIA                                       2024-01-01                                   aia(1)
+AIA                          v0.5.10                      aia(1)
 ```
 
-
 ## Configuration Using Envars
 
 The `aia` configuration defaults can be over-ridden by system environment variables *(envars)* with the prefix "AIA_" followed by the config item name also in uppercase. All configuration items can be over-ridden in this way by an envar.  The following table show a few examples.
@@ -444,7 +507,19 @@ The directive is executed and a new follow up prompt can be entered with a more
 
 ## All About ROLES
 
-`aia` provides the `--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.
+### The --roles_dir (AIA_ROLES_DIR)
+
+There are two kinds of prompts
+1. instructional - tells the LLM what to do
+2. personification - tells the LLM who it should pretend to be when it does its transformational work.
+
+That second kind of prompt is called a role.  Sometimes the role is incorporated into the instruction.  For example "As a magician make a rabbit appear out of a hat."  To reuse the same role in multiple prompts `aia` encourages you to designate a special `roles_dir` into which you put prompts that are specific to personification - roles.
+
+The default `roles_dir` is a sub-directory of the `prompts_dir` named roles.  You can, however, put your `roles_dir` anywhere that makes sense to you.
+
+### The --role Option
+
+The `--role` option is used to identify a personification prompt within your roles 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:
 
@@ -452,17 +527,17 @@ 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.
+Within the roles directory the contents of the text file `ruby.txt` will be pre-pre-pended to the contents of the `refactor.txt` file from the prompts directory to produce a complete prompt.  That complete prompt will have any parameters followed by directives processed before sending the combined prompt text to the backend.
 
 Note that `--role` is just a way of saying add this prompt text file to the front of this other prompt text file.  The contents of the "role" prompt could be anything.  It does not necessarily have be an actual role.
 
-You might consider have a sub-directory of your `prompts_dir` name `role` in which you put the prompt files that describe the various roles that you commonly use with your prompts.  `aia` fully supports a directory tree within the `prompts_dir` as a way of organization or classification of your different prompt text files.
+`aia` fully supports a directory tree within the `prompts_dir` as a way of organization or classification of your different prompt text files.
 
 ```shell
-aia -r roles/sw_eng doc_the_methods my_class.rb
+aia -r sw_eng doc_the_methods my_class.rb
 ```
 
-In this example the prompt text file `$AIA_PROMPTS_DIR/roles/sw_eng.txt` is prepended to the prompt text file `$AIA_PROMPTS_DIR/doc_the_methods.txt`
+In this example the prompt text file `$AIA_ROLES_DIR/sw_eng.txt` is prepended to the prompt text file `$AIA_PROMPTS_DIR/doc_the_methods.txt`
 
 
 ### Other Ways to Insert Roles into Prompts
@@ -473,7 +548,7 @@ Since `aia` supports parameterized prompts you could make a keyword like "[ROLE]
 As a [ROLE] tell me what you think about [SUBJECT]
 ```
 
-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.
+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 of 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
 
@@ -538,6 +613,40 @@ 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!
 
+## My Configuration
+
+I use the `bash` shell.  In my `.bashrc` file I source another file named `.bashrc__aia` which looks like this:
+
+```shell
+# ~/.bashic_aia
+# AI Assistant
+
+# These are the defaults:
+export AIA_PROMPTS_DIR=~/.prompts
+export AIA_OUT_FILE=./temp.md
+export AIA_LOG_FILE=$AIA_PROMPTS_DIR/_prompts.log
+export AIA_BACKEND=mods
+export AIA_MODEL=gpt-4-1106-preview
+
+# Not a default.  Invokes spinner.
+export AIA_VERBOSE=true
+
+alias chat='aia chat --terse'
+
+# rest of the file is the completion function
+```
+
+Here is what my `chat` prompt file looks like:
+
+```shell
+# ~/.prompts/chat.txt
+# Desc: Start a chat session
+
+//config chat? = true
+
+[WHAT]
+```
+
 ## 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/justfile

@@ -30,7 +30,11 @@ set dotenv-load             := false
 pwd         := env_var('PWD')
 
 me          := justfile()
-home        := env_var('HOME')
+
+home          := env_var('HOME')
+downloads_dir := env_var('HOME') + "/Downloads/"
+documents_dir := env_var('HOME') + "/Documents/"
+
 backup_dir  := env_var('JUST_BACKUP_DIR')
 backup_file := trim_start_match(me, home)
 my_backup   := backup_dir + backup_file

data/lib/aia/cli.rb

@@ -154,7 +154,8 @@ class AIA::Cli
       role:       ['',        "-r --role"],
       #
       config_file:[nil,                       "-c --config_file"],
-      prompts_dir:["~/.prompts",              "-p --prompts"],
+      prompts_dir:["~/.prompts",              "-p --prompts_dir"],
+      roles_dir:  ["~/.prompts/roles",        "--roles_dir"],
       out_file:   [STDOUT,                    "-o --out_file --no-out_file"],
       log_file:   ["~/.prompts/_prompts.log", "-l --log_file --no-log_file"],
       #
@@ -230,10 +231,14 @@ class AIA::Cli
 
       EOS
       
-      show_usage
+      show_error_usage
 
       exit
     end
+  
+    # After all other arguments 
+    # are processed, check for role parameter.
+    check_for_role_parameter
   end
 
 
@@ -272,6 +277,56 @@ class AIA::Cli
     end
   end
 
+
+  def check_for_role_parameter
+    role = AIA.config.role
+    return if role.empty?
+
+    role_path = string_to_pathname(AIA.config.roles_dir) + "#{role}.txt"
+
+    unless role_path.exist?
+      puts "Role prompt '#{role}' not found. Invoking fzf to choose a role..."
+      invoke_fzf_to_choose_role
+    end
+  end
+
+
+  def invoke_fzf_to_choose_role
+    roles_path = string_to_pathname AIA.config.roles_dir
+
+    available_roles = roles_path
+                        .children
+                        .select { |f| '.txt' == f.extname}
+                        .map{|role| role.basename.to_s.gsub('.txt','')}
+    
+    fzf = AIA::Fzf.new(
+      list:       available_roles,
+      directory:  roles_path,
+      prompt:     'Select Role:',
+      extension:  '.txt'
+    )
+
+    chosen_role = fzf.run
+
+    if chosen_role.nil?
+      abort("No role selected. Exiting...")
+    else
+      AIA.config.role = chosen_role
+      puts "Role changed to '#{chosen_role}'."
+    end
+  end
+
+
+  def show_error_usage
+    puts <<~ERROR_USAGE
+
+      Usage: aia [options] PROMPT_ID [CONTEXT_FILE(s)] [-- EXTERNAL_OPTIONS]"
+      Try 'aia --help' for more information."
+    
+    ERROR_USAGE
+  end
+
+
   # aia usage is maintained in a man page
   def show_usage
     @options[:help?][0] = false 

data/lib/aia/main.rb

@@ -15,11 +15,15 @@ require_relative 'user_query'
 # of a single class.
 
 class AIA::Main
+  SPINNER_FORMAT = :bouncing_ball
+
   include AIA::DynamicContent
   include AIA::UserQuery
   
   attr_accessor :logger, :tools, :backend
 
+  attr_reader :spinner
+
   def initialize(args= ARGV)    
     AIA::Tools.load_tools
 
@@ -31,6 +35,9 @@ class AIA::Main
       ]}
     end
 
+    @spinner  = TTY::Spinner.new(":spinner :title", format: SPINNER_FORMAT)
+    spinner.update(title: "composing response ... ")
+
     @logger = AIA::Logging.new(AIA.config.log_file)
 
     @logger.info(AIA.config) if AIA.config.debug? || AIA.config.verbose?
@@ -118,9 +125,15 @@ class AIA::Main
 
 
   def get_and_display_result(the_prompt_text)
+    spinner.auto_spin if AIA.config.verbose?
+
     backend.text  = the_prompt_text
     result        = backend.run
 
+    if AIA.config.verbose?
+      spinner.success "Done." 
+    end
+
     AIA.config.out_file.write "\nResponse:\n"
 
     if STDOUT == AIA.config.out_file

data/lib/aia/prompt.rb

@@ -32,9 +32,7 @@ class AIA::Prompt
     if AIA.config.role.empty?
       @role = nil
     else
-      AIA.config.arguments.prepend AIA.config.role
-      get_prompt
-      @role = @prompt.dup
+      @role = (AIA.config.roles_dir + "#{AIA.config.role}.txt").read
     end
 
     get_prompt
@@ -42,7 +40,7 @@ class AIA::Prompt
     @prompt_text_before_role = @prompt.text.dup
 
     unless @role.nil?
-      @prompt.text.prepend @role.text
+      @prompt.text.prepend @role
     end
 
     if build
@@ -200,37 +198,18 @@ class AIA::Prompt
 
   def handle_multiple_prompts(found_these, while_looking_for_this)
     raise ArgumentError, "Argument is not an Array" unless found_these.is_a?(Array)
-    
-    # TODO: Make this a class constant for defaults; make the header content
-    #       a parameter so it can be varied.
-    fzf_options       = [
-      "--tabstop=2",  # 2 soaces for a tab
-      "--header='Prompt IDs which contain: #{while_looking_for_this}\nPress ESC to cancel.'",
-      "--header-first",
-      "--prompt='Search term: '",
-      '--delimiter :',
-      "--preview 'cat #{AIA.config.prompts_dir}/{1}.txt'",
-      "--preview-window=down:50%:wrap"
-    ].join(' ') 
-
-
-    # Create a temporary file to hold the list of strings
-    temp_file = Tempfile.new('fzf-input')
-
-    begin
-      # Write all strings to the temp file
-      temp_file.puts(found_these)
-      temp_file.close
-
-      # Execute fzf command-line utility to allow selection
-      selected = `cat #{temp_file.path} | fzf #{fzf_options}`.strip
-
-      # Check if fzf actually returned a string; if not, return nil
-      result = selected.empty? ? nil : selected
-    ensure
-      # Ensure that the tempfile is closed and unlinked
-      temp_file.unlink
-    end
+
+    # Create an instance of AIA::Fzf with appropriate parameters
+    fzf_instance = AIA::Fzf.new(
+      list:       found_these,
+      directory:  AIA.config.prompts_dir, # Assuming this is the correct directory
+      query:      while_looking_for_this,
+      subject:    'Prompt IDs',
+      prompt:     'Select one: '
+    )
+
+    # Run the fzf instance and get the selected result
+    result = fzf_instance.run
 
     exit unless result
 
@@ -238,6 +217,8 @@ class AIA::Prompt
   end
 
 
+
+
   def create_prompt(prompt_id)
     @prompt = PromptManager::Prompt.create(id: prompt_id)
     # TODO: consider a configurable prompt template

data/lib/aia/tools/fzf.rb

@@ -0,0 +1,105 @@
+# lib/aia/tools/fzf.rb
+# fzf is a general-purpose command-line fuzzy finder
+
+require 'shellwords'
+require 'tempfile'
+
+class AIA::Fzf < AIA::Tools
+
+  meta(
+    name:     'fzf',
+    role:     :search_tool,
+    desc:     "A command-line fuzzy finder",
+    url:      "https://github.com/junegunn/fzf",
+    install:  "brew install fzf",
+  )
+
+  DEFAULT_PARAMETERS = %w[
+    --tabstop=2
+    --header-first
+    --prompt='Search term: '
+    --delimiter :
+    --preview-window=down:50%:wrap
+  ]
+
+  attr_reader :list, :directory, :query, :subject, :prompt, :extension, :command
+
+  def initialize(
+      list:,          # Array of Strings (basenames of files w/o extension)
+      directory:,     # Parent directory of the list items
+      query:      '', # String, the thing be searched for
+      subject:    'Prompt IDs', # or 'Role Names'
+      prompt:     'Select one:',
+      extension:  '.txt'
+    )
+
+    @list       = list
+    @directory  = directory
+    @query      = query
+    @subject    = subject
+    @prompt     = prompt
+    @extension  = extension
+    
+    build_command
+  end
+
+
+  def build_command
+    fzf_options = DEFAULT_PARAMETERS.dup
+    fzf_options << "--header='#{subject} which contain: #{query}\\nPress ESC to cancel.'"
+    fzf_options << "--preview='cat #{directory}/{1}#{extension}'"
+    fzf_options << "--prompt=#{Shellwords.escape(prompt)}"
+    
+    fzf_command = "#{meta.name} #{fzf_options.join(' ')}"
+
+    @command = "cat #{tempfile_path} | #{fzf_command}"
+  end
+  
+
+  def run
+    puts "Executing: #{@command}"
+    selected = `#{@command}`
+    selected.strip.empty? ? nil : selected.strip
+  ensure
+    unlink_tempfile
+  end
+
+  ##############################################
+  private
+
+  def tempfile_path
+    @tempfile ||= Tempfile.new('fzf-input').tap do |file|
+      list.each { |item| file.puts item }
+      file.close
+    end
+    @tempfile.path
+  end
+
+  def unlink_tempfile
+    @tempfile&.unlink
+  end
+end
+
+
+__END__
+
+$ fzf --help
+
+USAGE
+    fzf [OPTIONS]
+
+OPTIONS
+    -x, --extended        Extended-search mode
+    -e, --exact           Enable Exact-match
+    --algo=TYPE           Fuzzy matching algorithm: [v1|v2] (default: v2)
+    +i                    Case-insensitive match (default: smart-case match)
+    +s                    Synchronous search for multi-staged filtering
+    --multi               Enable multi-select with tab/shift-tab
+
+    ... (Other options)
+
+EXAMPLES
+    find * -type f | fzf > selected
+    fzf < /path/to/file_list
+
+For full documentation, please visit https://github.com/junegunn/fzf.

data/lib/aia.rb

@@ -23,7 +23,15 @@ require 'hashie'
 require 'pathname'
 require 'reline'
 require 'shellwords'
-require 'tempfile'
+require 'tempfile'    # SMELL: is this still being used?
+
+require 'tty-spinner'
+
+unless TTY::Spinner.new.respond_to?(:log)
+  # Allows messages to be sent to the console while
+  # the spinner is still spinning.
+  require_relative './core_ext/tty-spinner_log'
+end
 
 require 'prompt_manager'
 require 'prompt_manager/storage/file_system_adapter'

data/lib/core_ext/tty-spinner_log.rb

@@ -0,0 +1,25 @@
+# aia/lib/core_ext/tty-spinner_log.rb
+#
+# The gem's README shows the log method; bit the
+# author has been spinning his wheels since 2021 on pushing a release
+# with it.  This is a stop gap.
+
+module TTY
+  class Spinner
+    # Log a message to the output
+    # This will clear the current spinner line, print the log message,
+    # and then redraw or resume the spinner on a new line.
+    #
+    # @param [String] message
+    #   the log message to print
+    #
+    # @api public
+    def log(message)
+      synchronize do
+        clear_line    # Clear the spinner
+        output.puts(message) # Log the message
+        redraw_indent # Redraw the spinner frame
+      end
+    end
+  end
+end

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 "2024-01-01" AIA "User Manuals"
+.TH aia 1 "v0.5.10" AIA "User Manuals"
 .SH NAME
 .PP
 aia \- command\-line interface for an AI assistant
@@ -81,9 +81,12 @@ Format with Markdown \- default is true
 \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\-p\fR, \fB\-\-prompts\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
+\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
+\fB\-\-roles\[ru]dir\fR \fIPATH\[ru]TO\[ru]DIRECTORY\fP
+Directory containing the personification prompt files \- default is \[ti]\[sl]\.prompts\[sl]roles
+.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

data/man/aia.1.md

@@ -1,4 +1,4 @@
-# aia 1 "2024-01-01" AIA "User Manuals"
+# aia 1 "v0.5.10" AIA "User Manuals"
 
 ## NAME
 
@@ -85,9 +85,12 @@ The aia command-line tool is an interface for interacting with an AI model backe
 `-o`, `--[no]-out_file` *PATH_TO_OUTPUT_FILE*
 : Out FILENAME - default is ./temp.md
 
-`-p`, `--prompts` *PATH_TO_DIRECTORY*
+`-p`, `--prompts_dir` *PATH_TO_DIRECTORY*
 : Directory containing the prompt files - default is ~/.prompts
 
+`--roles_dir` *PATH_TO_DIRECTORY*
+: Directory containing the personification prompt files - default is ~/.prompts/roles
+
 `-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.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.10
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -225,6 +225,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".better-commits.json"
 - ".config/tocer/configuration.yml"
 - ".envrc"
 - ".semver"
@@ -250,6 +251,7 @@ files:
 - lib/aia/tools.rb
 - lib/aia/tools/backend_common.rb
 - lib/aia/tools/editor.rb
+- lib/aia/tools/fzf.rb
 - lib/aia/tools/glow.rb
 - lib/aia/tools/mods.rb
 - lib/aia/tools/sgpt.rb
@@ -258,6 +260,7 @@ files:
 - lib/aia/user_query.rb
 - lib/aia/version.rb
 - lib/core_ext/string_wrap.rb
+- lib/core_ext/tty-spinner_log.rb
 - main.just
 - man/aia.1
 - man/aia.1.md
@@ -284,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: AI Assistant (aia) a command-line (CLI) utility