aia 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35bff72b31591194079e96f6e1dfab9dc76db90fda1f635e962377aeb77b5662
-  data.tar.gz: 60704012ba00cca73bdb6bb344a4207df189b97b5dc2d686a53215836c5d27d5
+  metadata.gz: 872817d33ce07dce0b81526206b55de4800df41adc7b31a295c0d690f677ff58
+  data.tar.gz: f95bdf3845fec419a8b0e56a0c2075e2b1cbab79342538eeb32acb4dc255f8c1
 SHA512:
-  metadata.gz: a7b3f5bb0bee380f3863bfe80599e8898e16143587d374db27f99d27a718433d9e6869da1a8f44207016185c0b28935b5c5edbaf45d939992ad58ecd65a68fa9
-  data.tar.gz: 3f4fd8f0707e55cfc2147090d55ff4c865eba8c14bb22bb07831b3e46653530c9800a8d69f148e978bcb763a91d47ac3b58c1f2ab19e387019d6537b9446059e
+  metadata.gz: 04fc7614ec13ba847e66def37dda93cdfbe8bd0f19425083339276c7bfa5f1ecc214684d0cb9fcb479fddb7fda2cd818ac74fd5498083af3452f8df4f8442a29
+  data.tar.gz: 03d5adfdc25ac89cd29b752dd8a2af1c3d6876cad6206471ff9ae1c13e251ea8ee2b2c1038bb64f28febd3f977a375bbe03868b5b3b686a4c35b621e3216a2e1

data/.semver

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

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.5.3] 2024-01-14
+- adding ability to render markdown to the terminal using the "glow" CLI utility
+
 ## [0.5.2] 2024-01-13
 - wrap response when its going to the terminal
 

data/README.md

@@ -5,6 +5,10 @@
 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.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`
@@ -125,6 +129,9 @@ OPTIONS
        --model NAME
               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
+
        --speak
               Simple implementation. Uses the “say” command to speak the response.  Fun with
               --chat
@@ -251,6 +258,22 @@ SEE ALSO
                 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.
+
+              • 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.
+
+              • glow <https://github.com/charmbracelet/glow>
+                 Render markdown on the CLI
+
 AUTHOR
        Dewayne VanHoozer <dvanhoozer@gmail.com>
 
@@ -402,31 +425,32 @@ When this prompt is processed, `aia` will ask you for a value for the keyword "R
 
 ## External CLI Tools Used
 
-```text
-External Tools Used
--------------------
-
 To install the external CLI programs used by aia:
-  brew install fzf mods rg
+  
+  brew install fzf mods rg glow
 
 fzf
   Command-line fuzzy finder written in Go
-  https://github.com/junegunn/fzf
+  [https://github.com/junegunn/fzf](https://github.com/junegunn/fzf)
 
 mods
   AI on the command-line
-  https://github.com/charmbracelet/mods
+  [https://github.com/charmbracelet/mods](https://github.com/charmbracelet/mods)
 
 rg
   Search tool like grep and The Silver Searcher
-  https://github.com/BurntSushi/ripgrep
+  [https://github.com/BurntSushi/ripgrep](https://github.com/BurntSushi/ripgrep)
+
+glow
+  Render markdown on the CLI
+  [https://github.com/charmbracelet/glow](https://github.com/charmbracelet/glow)
 
 A text editor whose executable is setup in the
 system environment variable 'EDITOR' like this:
 
-export EDITOR="subl -w"
+  export EDITOR="subl -w"
+
 
-```
 
 ## Shell Completion
 

data/lib/aia/cli.rb

@@ -125,18 +125,19 @@ class AIA::Cli
       dump:       [nil,       "--dump"],
       completion: [nil,       "--completion"],
       #
+      chat?:      [false,     "--chat"],
+      debug?:     [false,     "-d --debug"],
       edit?:      [false,     "-e --edit"],
-      shell?:     [false,     "--shell"],
       erb?:       [false,     "--erb"],
-      debug?:     [false,     "-d --debug"],
-      verbose?:   [false,     "-v --verbose"],
-      version?:   [false,     "--version"],
-      help?:      [false,     "-h --help"],
       fuzzy?:     [false,     "-f --fuzzy"],
+      help?:      [false,     "-h --help"],
       markdown?:  [true,      "-m --markdown --no-markdown --md --no-md"],
-      chat?:      [false,     "--chat"],
-      terse?:     [false,     "--terse"],
+      render?:    [false,     "--render"],
+      shell?:     [false,     "--shell"],
       speak?:     [false,     "--speak"],
+      terse?:     [false,     "--terse"],
+      verbose?:   [false,     "-v --verbose"],
+      version?:   [false,     "--version"],
       #
       role:       ['',        "-r --role"],
       #

data/lib/aia/main.rb

@@ -57,6 +57,7 @@ class AIA::Main
   # Function to prompt the user with a question using reline
   def ask_question_with_reline(prompt)
     if prompt.start_with?("\n")
+      puts
       puts
       prompt = prompt[1..]
     end
@@ -111,20 +112,10 @@ class AIA::Main
                   files:          AIA.config.arguments    # FIXME: want validated context files
                 )
 
-
-    result  = backend.run
-
-    if STDOUT == AIA.config.out_file
-      result  = result.wrap(indent: 2)
-    end
-
-    # TODO: consider using glow to render markdown to
-    #       terminal `brew install glow`
-    AIA.config.out_file.write result
+    result = get_and_display_result(the_prompt)
 
     logger.prompt_result(@prompt, result)
 
-
     if AIA.config.chat?
       setup_reline_history
       speak result
@@ -133,34 +124,75 @@ class AIA::Main
   end
 
 
-  def lets_chat
+  def get_and_display_result(the_prompt_text)
+    backend.text  = the_prompt_text
+    result        = backend.run
+
+    AIA.config.out_file.write "\nResponse:\n"
+
+    if STDOUT == AIA.config.out_file
+      if AIA.config.render?
+        AIA::Glow.new(content: result).run
+      else
+        result  = result.wrap(indent: 2)
+        AIA.config.out_file.write result
+      end
+    else
+      AIA.config.out_file.write result
+      if AIA.config.render?
+        AIA::Glow.new(file_path: AIA.config.out_file).run
+      end
+    end
+
+    result
+  end
+
+
+  def log_the_follow_up(the_prompt_text, result)
+    logger.info "Follow Up:\n#{the_prompt_text}"
+    logger.info "Response:\n#{result}"
+  end
+
+
+  def add_continue_option
     if 'mods' == AIA.config.backend
-      AIA.config.extra += " -C"
+      continue_option   = " -C"
+      AIA.config.extra += continue_option unless AIA.config.extra.include?(continue_option)
     end
+  end
+
+
+  def insert_terse_phrase(a_string)
+    if AIA.config.terse?
+      a_string.prepend "Be terse in your response. "
+    end
+
+    a_string
+  end
+
+
+  def lets_chat
+    add_continue_option    
+
+    the_prompt_text = ask_question_with_reline("\nFollow Up: ")
     
-    backend.text = ask_question_with_reline("\nFollow Up: ")
-    
-    until backend.text.empty?
-      if AIA.config.terse?
-        backend.text.prepend "Be terse in your response. "
-      end
+    until the_prompt_text.empty?
+      the_prompt_text = insert_terse_phrase(the_prompt_text)
       
-      logger.info "Follow Up: #{backend.text}"
-      response = backend.run
-      
-      speak response
+      result = get_and_display_result(the_prompt_text)
+
+      log_the_follow_up(the_prompt_text, result)
+
+      speak result
+
 
-      puts "\nResponse:\n#{response.wrap(indent: 2)}"
-      logger.info "Response: #{backend.run}"
-  
       # TODO: Allow user to enter a directive; loop
       #       until answer is not a directive
       #
       # while !directive do
-      backend.text = ask_question_with_reline("\nFollow Up: ")
       
-      speak backend.text
-
+      the_prompt_text = ask_question_with_reline("\nFollow Up: ")
+      
       # execute the directive
       # end
     end

data/lib/aia/prompt.rb

@@ -151,6 +151,7 @@ class AIA::Prompt
   # Function to prompt the user with a question using reline
   def ask_question_with_reline(prompt)
     if prompt.start_with?("\n")
+      puts
       puts
       prompt = prompt[1..]
     end

data/lib/aia/tools/glow.rb

@@ -0,0 +1,90 @@
+# aia/lib/aia/tools/glow.rb
+
+require 'tempfile'
+require 'tty-screen'
+require 'shellwords'
+
+
+=begin
+
+  This class supports two use cases:
+  1) rendering markdown from an existing file
+  2) rendering markdown from a String object via a temporary file
+
+  In both cases a String object is created and returned that contains the
+  rendered version of the content so that it can be written to STDOUT
+  by the caller.
+
+=end
+
+class AIA::Glow < AIA::Tools
+
+  meta(
+    name:     'glow',
+    role:     :markdown_renderer,
+    desc:     "A markdown renderer utility",
+    url:      "https://github.com/charmbracelet/glow",
+    install:  "brew install glow",
+  )
+
+  DEFAULT_PARAMETERS = "--width #{TTY::Screen.width-2}" # Magic: -2 just because I want it
+
+  attr_accessor :content, :file_path
+
+
+  def initialize(content: nil, file_path: nil)
+    @content = content
+    @file_path = file_path
+  end
+
+
+  def build_command(file_path)
+    "#{self.class.meta[:name]} #{DEFAULT_PARAMETERS} #{Shellwords.escape(file_path)}"
+  end
+
+
+  def run
+    return unless content || file_path
+
+    if @file_path && File.exist?(@file_path)
+      command = build_command(@file_path)
+      system(command)
+    else
+      Tempfile.create(['glow', '.md']) do |file|
+        file.write(@content)
+        file.close
+        command = build_command(file.path)
+        system(command)
+      end
+    end
+  end
+end
+
+__END__
+
+$ glow --help
+
+  Render markdown on the CLI, with pizzazz!
+
+Usage:
+  glow [SOURCE|DIR] [flags]
+  glow [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  config      Edit the glow config file
+  help        Help about any command
+  stash       Stash a markdown
+
+Flags:
+  -a, --all             show system files and directories (TUI-mode only)
+      --config string   config file (default /Users/dewayne/Library/Preferences/glow/glow.yml)
+  -h, --help            help for glow
+  -l, --local           show local files only; no network (TUI-mode only)
+  -p, --pager           display with pager
+  -s, --style string    style name or JSON path (default "auto")
+  -v, --version         version for glow
+  -w, --width uint      word-wrap at width
+
+Use "glow [command] --help" for more information about a command.
+

data/man/aia.1

@@ -41,6 +41,9 @@ If dynamic prompt content using \[Do](\.\.\.) wasn\[cq]t enough here is ERB\.  E
 \fB\-\-model\fR \fINAME\fP
 Name of the LLM model to use \- default is gpt\-4\-1106\-preview
 .TP
+\fB\-\-render\fR
+Render markdown to the terminal using the external tool \[lq]glow\[rq] \- default: false
+.TP
 \fB\-\-speak\fR
 Simple implementation\. Uses the \[lq]say\[rq] command to speak the response\.  Fun with \-\-chat
 .TP
@@ -147,6 +150,21 @@ 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\.
+.IP \(bu 2
+fzf
+.UR https:\[sl]\[sl]github\.com\[sl]junegunn\[sl]fzf
+.UE
+ fzf is a general\-purpose command\-line fuzzy finder\.  It\[cq]s an interactive Unix filter for command\-line that can be used with any list; files, command history, processes, hostnames, bookmarks, git commits, etc\.
+.IP \(bu 2
+ripgrep
+.UR https:\[sl]\[sl]github\.com\[sl]BurntSushi\[sl]ripgrep
+.UE
+ 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\[sl]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\.
+.IP \(bu 2
+glow
+.UR https:\[sl]\[sl]github\.com\[sl]charmbracelet\[sl]glow
+.UE
+ Render markdown on the CLI
 .RE
 .SH AUTHOR
 .PP

data/man/aia.1.md

@@ -46,6 +46,9 @@ The aia command-line tool is an interface for interacting with an AI model backe
 `--model` *NAME*
 : 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
+
 `--speak`
 : Simple implementation. Uses the "say" command to speak the response.  Fun with --chat
 
@@ -135,6 +138,13 @@ Detail discussion on individual prompt directives is TBD.  Most likely it will b
 
 - [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.
 
+- [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.
+
+- [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. 
+
+- [glow](https://github.com/charmbracelet/glow) Render markdown on the CLI
+
+
 ## AUTHOR
 
 Dewayne VanHoozer <dvanhoozer@gmail.com>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  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: tty-spinner
+  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
@@ -164,12 +192,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "A command-line AI Assistante (aia) that provides\nparameterized prompt
-  management (via the prompt_manager gem) to\nvarious backend gen-AI processes.  aia
-  currently supports the \"mods\"\nCLI tool.  aia uses \"ripgrep\" and \"fzf\" CLI
-  utilities \nto search for and select prompt files to send to the backend gen-AI\ntool
-  along with supported context files.  Example usage: \"aia refactor my_class.rb\"
-  \nwhere \"refactor\" is the prompt ID for the file \"refactor.txt\" from your\nRPROMPTS_DIR\n"
+description: |
+  `aia` - the AI Assistant - is a command-line (CLI) tool for
+  interfacing with generative AI (gen-AI/GPT) backends.  Its designed
+  to provide developers with the ability to issue prompts, receive
+  AI-generated responses, and incorporate additional context from files
+  such as Ruby source code. It supports configuration and customization
+  for different environments, includes options for output formats like
+  markdown rendering or spoken responses, and allows dynamic content
+  generation within prompts such as shell integration and embedded
+  Ruby. With `aia`, users benefit from a simplified setup process and
+  an extendable interaction model with AI, suitable for a range of
+  command-line tasks.
 email:
 - dvanhoozer@gmail.com
 executables:
@@ -201,6 +235,7 @@ files:
 - lib/aia/tools.rb
 - lib/aia/tools/backend_common.rb
 - lib/aia/tools/editor.rb
+- lib/aia/tools/glow.rb
 - lib/aia/tools/mods.rb
 - lib/aia/tools/sgpt.rb
 - lib/aia/tools/subl.rb