aia 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15a24480e7b5958570ae21ef3e3f958cdb991a1f03cb88ebe3e8ca52a6029f9a
-  data.tar.gz: dcef2697a2d2fdec85e371421a5c16a48c70d3688ea7bb6646f001df5e795d68
+  metadata.gz: 307fe4fba0b6c2134cba097ffd9b01750eea1f3e06d6c6de5131099435caaa16
+  data.tar.gz: ac46548236f1c9162d62af9a999776d9a01ffa5cc8ff283ed9bfd774414ddc85
 SHA512:
-  metadata.gz: 97f8c423247051e31eef8b6a66fdde22fe72438097da41bb30ec53ef56508266e07f5502fa85cf8cfb63ebad22e995d7c7b4cbe55745f20e87b2b535cbd0b55c
-  data.tar.gz: c48ebed9374edc9a8dcf86b2dd592031c1bef02b60f5d61e113a9c90bf31865030231ebc267a6308ca46d71f3e864d02e44bfc93f221112102309ddf2186d563
+  metadata.gz: '09ec4085dabf70365ccc74a95126891a6075eefc57ad1a652432278b38355f55d2c503ebc6e10b52d9f77e3d7788fef0a9b1d9d6e6aa3b7d72b2cda82d337c08'
+  data.tar.gz: 84eed4f09f8d9d506887ea91cd9b810cc47e77a724c3031e43b464779e5cfcaf5f0a92cc30304bf0d6ffea0eb31e35a23dc2baabff1671cff1bca8852b7e7801

data/.version

@@ -1 +1 @@
-0.8.3
+0.8.5

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 ## [Unreleased]
 
 ## Released
+### [0.8.5] 2025-04-49
+- documentation updates
+- integrated the https://pure.md web service for inserting web pages into the context window
+   - //include http?://example.com/stuff
+   - //webpage http?://example.com/stuff
 
 ### [0.8.2] 2025-04-18
 - fixed problems with pre-loaded context and chat repl

data/README.md

@@ -17,18 +17,13 @@
 AIA leverages the [prompt_manager gem](https://github.com/madbomber/prompt_manager) to manage prompts. It utilizes the [CLI tool fzf](https://github.com/junegunn/fzf) for prompt selection.
 
 **Most Recent Change**: Refer to the [Changelog](CHANGELOG.md)
+- //include directive now supports web URLs
+- //webpage insert web URL content as markdown into context
 
-**Notable Recent Changes:**
-- **Directive Processing in Chat and Prompts:** You can now use directives in chat sessions and prompt files with the syntax: `//command args`. Supported directives include:
-  - `shell`/`sh`: Execute shell commands
-  - `ruby`/`rb`: Execute Ruby code
-  - `config`/`cfg`: Display or update configuration
-  - `include`/`inc`: Include file content
-  - `next`: Specify the next prompt ID in a sequence
-  - `pipeline`: Specify a pipeline of prompt IDs to process
-  - `clear`: Clear the context (handy in a chat session)
-  - `help`: Show available directives
+**Wiki**: [Checkout the AIA Wiki](https://github.com/MadBomber/aia/wiki)
 
+**Notable Recent Changes:**
+- **Directive Processing in Chat and Prompts:** You can now use directives in chat sessions and prompt files. Use the directive **//help** to get a list of available directives.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -90,7 +85,7 @@ Install the command-line utilities by executing:
 
     brew install fzf
 
-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.
+You will also need to establish a directory in your filesystem where your prompt text files, last used parameters and usage log files are kept.
 
 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_PREFIX" points to your role prefix where you have prompts that define the different roles you want the LLM to assume when it is doing its work.  The default roles prefix is "roles".
 
@@ -104,7 +99,7 @@ aia --completion bash
 
 ## What is a Prompt ID?
 
-A prompt ID is the basename of a text file (extension *.txt) located in a prompts directory. The prompts directory is specified by the environment variable "AIA_PROMPTS_DIR". If this variable is not set, the default is in your HOME directory named ".prompts".  It can also be set on the command line with the `--prompts-dir` option.
+A prompt ID is the basename of a text file (extension *.txt) located in a prompts directory. The prompts directory is specified by the environment variable "AIA_PROMPTS_DIR". If this variable is not set, the default is in your HOME directory named ".prompts". It can also be set on the command line with the `--prompts-dir` option.
 
 This file contains the context and instructions for the LLM to follow. The prompt ID is what you use as an option on the command line to specify which prompt text file to use. Prompt files can have comments, parameters, directives and ERB blocks along with the instruction text to feed to the LLM. It can also have shell commands and use system environment variables.  Consider the following example:
 
@@ -142,16 +137,32 @@ Tell me how to do something for a $(uname -s) platform that would rename all
 of the files in the directory $MY_DIRECTORY to have a prefix of for its filename
 that is [PREFIX] and a ${SUFFIX}
 
-# directives, ERB blocks and other junk can be used
-# anywhere in the file mixing dynamic context/instructions with
-# the static stuff.
+<!--
+  directives, ERB blocks and other junk can be used
+  anywhere in the file mixing dynamic context/instructions with
+  the static stuff.
+-->
+
+  ```markdown
+  # Header 1 -- not a comment
+  ## Header 2 -- not a comment
+  ### Header 3, etc -- not a comment
+
+    ```ruby
+    # this is a comment; but it stays in the prompt
+    puts "hello world" <!-- this is also a comment; but it gets removed -->
+    ```
+  Kewl!
+  ```
 
 __END__
 
-Block comments that are not part of the context or instructions to
-the LLM.  Stuff that is just here ofr documentation.
+Everything after the "__END__" line is not part of the context or instructions to
+the LLM.
 ```
 
+Comments in a prompt text file are just there to document the prompt.  They are removed before the completed prompt is processed by the LLM.  This reduces token counts; but, more importantly it helps you remember why you structured your prompt they way you did - if you remembered to document your prompt.
+
 That is just about everything including the kitchen sink that a pre-compositional parameterized prompt file can have.  It can be an executable with a she-bang line and a special system prompt name `run` as shown in the example.  It has line comments that use the `#` symbol. It had end of file block comments that appear after the "__END__" line.  It has directive command that begin with the double slash `//` - an homage to IBM JCL.  It has shell variables in both forms.  It has shell commands. It has parameters that default to a regex that uses square brackets and all uppercase characeters to define the parameter name whose value is to be given in a Q&A session before the prompt is sent to the LLM for processing.
 
 AIA has the ability to define a workflow of prompt IDs with either the //next or //pipeline directives.

data/lib/aia/config.rb

@@ -10,15 +10,17 @@ require 'toml-rb'
 require 'erb'
 require 'optparse'
 
-
 module AIA
   class Config
-    DEFAULT_CONFIG = {
+    DEFAULT_CONFIG = OpenStruct.new({
       aia_dir:      File.join(ENV['HOME'], '.aia'),
       config_file:  File.join(ENV['HOME'], '.aia', 'config.yml'),
       out_file:     'temp.md',
       log_file:     File.join(ENV['HOME'], '.prompts', '_prompts.log'),
       prompts_dir:  File.join(ENV['HOME'], '.prompts'),
+      #
+      prompt_extname: PromptManager::Storage::FileSystemAdapter::PROMPT_EXTENSION,
+      #
       roles_prefix: 'roles',
       roles_dir:    File.join(ENV['HOME'], '.prompts', 'roles'),
       role:         '',
@@ -67,11 +69,10 @@ module AIA
 
       # Ruby libraries to require for Ruby binding
       require_libs: [],
-    }.freeze
-
+    }).freeze
 
     def self.setup
-      default_config  = OpenStruct.new(DEFAULT_CONFIG)
+      default_config  = DEFAULT_CONFIG.dup
       cli_config      = cli_options
       envar_config    = envar_options(default_config, cli_config)
 
@@ -92,6 +93,35 @@ module AIA
 
 
     def self.tailor_the_config(config)
+      remaining_args = config.remaining_args.dup
+      config.remaining_args = nil
+
+      # Is first remaining argument a prompt ID?
+      unless remaining_args.empty?
+        maybe_id      = remaining_args.first
+        maybe_id_plus = File.join(config.prompts_dir, maybe_id + config.prompt_extname)
+
+        if AIA.bad_file?(maybe_id) && AIA.good_file?(maybe_id_plus)
+          config.prompt_id =remaining_args.shift
+        end
+      end
+
+      unless remaining_args.empty?
+        bad_files = remaining_args.reject { |filename| AIA.good_file?(filename) }
+        if bad_files.any?
+          STDERR.puts "Error: The following files do not exist: #{bad_files.join(', ')}"
+          exit 1
+        end
+
+        config.context_files = remaining_args
+      end
+
+      if config.prompt_id.nil? && !config.chat && !config.fuzzy
+        STDERR.puts "Error: A prompt ID is required unless using --chat, --fuzzy, or providing context files. Use -h or --help for help."
+        exit 1
+      end
+
+
       unless config.role.empty?
         unless config.roles_prefix.empty?
           unless config.role.start_with?(config.roles_prefix)
@@ -151,7 +181,7 @@ module AIA
         STDERR.puts "Error: A prompt ID is required unless using --chat, --fuzzy, or providing context files. Use -h or --help for help."
         exit 1
       end
-      
+
       # If we're in chat mode with context files but no prompt_id, that's valid
       if config.chat && config.prompt_id.empty? && config.context_files && !config.context_files.empty?
         # This is a valid use case - no action needed
@@ -391,32 +421,13 @@ module AIA
 
       # Parse the command line arguments
       begin
-        remaining_args = opt_parser.parse(args)
+        config.remaining_args = opt_parser.parse(args)
       rescue OptionParser::InvalidOption => e
         puts e.message
         puts opt_parser
         exit 1
       end
 
-      # Handle remaining args
-      unless remaining_args.empty?
-        # If in chat mode and all args are existing files, treat them all as context files
-        if config.chat && remaining_args.all? { |arg| File.exist?(arg) }
-          config.context_files = remaining_args
-        # If first arg is empty string and we're in chat mode, treat all args as context files
-        elsif config.chat && remaining_args.first == ""
-          remaining_args.shift # Remove the empty string
-          config.context_files = remaining_args unless remaining_args.empty?
-        else
-          # First remaining arg is the prompt ID
-          config.prompt_id = remaining_args.shift
-          
-          # Remaining args are context files
-          config.context_files = remaining_args unless remaining_args.empty?
-        end
-      end
-
-
       config
     end
 

data/lib/aia/directive_processor.rb

@@ -1,7 +1,10 @@
 # lib/aia/directive_processor.rb
 
+require 'faraday'
+
 module AIA
   class DirectiveProcessor
+    PUREMD_API_KEY   = ENV.fetch('PUREMD_API_KEY', nil)
     EXCLUDED_METHODS = %w[ run initialize private? ]
     @descriptions = {}
     @aliases      = {}
@@ -100,10 +103,32 @@ module AIA
       !respond_to?(method_name) && respond_to?(method_name, true)
     end
 
+
     ################
     ## Directives ##
     ################
 
+
+    desc "webpage inserted as markdown to context using pure.md"
+    def webpage(args, context_manager=nil)
+      if PUREMD_API_KEY.nil?
+        "ERROR: PUREMD_API_KEY is required in order to include a webpage"
+      else
+        url        = `echo #{args.shift}`.strip
+        puremd_url = "https://pure.md/#{url}"
+
+        response = Faraday.get(puremd_url) do |req|
+          req.headers['x-puremd-api-token'] = PUREMD_API_KEY
+        end
+
+        if 200 == response.status
+          response.body
+        else
+          "Error: wtatus was #{r.status}\n#{ap response}"
+        end
+      end
+    end
+
     desc "Specify the next prompt ID to process after this one"
     def next(args = [])
       if args.empty?
@@ -129,6 +154,10 @@ module AIA
       # echo takes care of envars and tilde expansion
       file_path = `echo #{args.shift}`.strip
 
+      if file_path.start_with?(/http?:\/\//)
+        return webpage(args)
+      end
+
       if @included_files.include?(file_path)
         ""
       else

data/lib/aia.rb

@@ -45,6 +45,16 @@ module AIA
     @config.client = client
   end
 
+  def self.good_file?(filename)
+    File.exist?(filename) &&
+    File.readable?(filename) &&
+    !File.directory?(filename)
+  end
+
+  def self.bad_file?(filename)
+    !good_file?(filename)
+  end
+
   def self.build_flags
     @config.each_pair do |key, value|
       if [TrueClass, FalseClass].include?(value.class)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aia
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.5
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: os
   requirement: !ruby/object:Gem::Requirement
@@ -57,14 +71,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: reline
   requirement: !ruby/object:Gem::Requirement
@@ -247,17 +261,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A command-line AI Assistante (aia) that provides pre-compositional template
-  prompt management to various backend gen-AI processes such as llm, mods and sgpt
-  support processing of prompts both via remote API calls as well as keeping everything
-  local through the use of locally managed models and the LocalAI API. Complete shell
-  integration allows a prompt to access system environment variables and execut shell
-  commands as part of the prompt content.  In addition full embedded Ruby support
-  is provided given even more dynamic prompt conditional content.  It is a generalized
-  power house that rivals specialized gen-AI tools.  aia currently supports "mods"
-  and "sgpt" CLI tools.  aia uses "ripgrep" and "fzf" CLI utilities to search for
-  and select prompt files to send to the backend gen-AI tool along with supported
-  context files.
+description: |
+  Unleash the full power of AI from your terminal! AIA is a cutting-edge CLI
+  assistant for generative AI workflows, offering dynamic prompt management,
+  seamless shell and Ruby integration, interactive chat, and advanced automation.
+  Effortlessly craft, manage, and execute prompts with embedded directives,
+  history, and flexible configuration. Experience next-level productivity for
+  developers, power users, and AI enthusiasts—all from your command line.
 email:
 - dvanhoozer@gmail.com
 executables:
@@ -321,5 +331,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.8
 specification_version: 4
-summary: AI Assistant (aia) a command-line (CLI) utility
+summary: 'AI Assistant: dynamic prompts, shell & Ruby integration, and seamless chat
+  workflows.'
 test_files: []