aigency 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dc4124a357fd322bcbcd526f42cafc247b5f70e2a367db8bdec26dc2cd5af75
-  data.tar.gz: 8cea262865e5e6ffd4b9c1d7efc71b688814363a446684a71ae671bcbe9b316c
+  metadata.gz: 4fce24d7da34c83fac5e0d3ce82d8bb79c31bede2b99ddfacec3b7efa4d157e3
+  data.tar.gz: 1a36424698a8a9b4bba0a0a0cf6a14e9b4cf8318a40a166893be3e093c909f9e
 SHA512:
-  metadata.gz: a989b935e3554e6cbb081130910b0e81a2c0146507d81ca527024d1f356c419dc8be026d2846ee85fb8233a767a4eef0b2337d1facad1d99b840214042283972
-  data.tar.gz: c545ffd5bba322f455931ee5658cfb0c8b72d22d4da07a231214968160d17d109791ae1293ee9564532171327dec405508edb05915173e12c64744a8dbf22216
+  metadata.gz: 9ce7989e062eb10afbb767d3e61f297ddf521f0b7c5fe0459c8021428843e6b05069db1ae88afbda7c29ab4ea0ca9f9f277b7472393f085f87dc5b36866cd786
+  data.tar.gz: 9a7a1efaad6467200964715b3db7920b52cc1cc39c7292fd8a52a2b4d4d023b16502ea511ee6824664970fecbdab19b2529dd95a2a5d0a8dfc49f9c53a5e062d

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 0.4.0 - October 21, 2026
+- Config file directory
+- Add openssh to sandbox
+- Sandbox configuration
+- Tempdir tools
+- Aigent plugin
+- Proxy environment variables
+- apk update && apk upgrade
+- Plugins add rake files
+- Aigent setup in README
+- Rearrange sandbox scaffold
+- Add bin/aigent to aigent directory
+- Fix grep spec for BusyBox
+- CurrentTime tool
+- Dockerfile packages and mise setup
+- Instructions subcommand
+- Aigent#stream errors write to error.log
+- Aigent stream command
+- Remove adduser recommendation
+- Clarify Docker requirement
+- Plugin shells
+- Tempdir file size management
+- CopyTempdirFile tool
+- Aigent plugin setup
+- Update chat calls for RubyLLM 2.0
+- Use the chat completions protocol
+
 ## 0.3.0 - October 9, 2026
 - New plugin architecture
 - Workspace and Sandbox plugins

data/README.md

@@ -2,10 +2,10 @@
 
 A framework for creating AI agents with RubyLLM.
 
-## Requierments
+## Requirements
 
 - Ruby 3.2+
-- Docker 29+
+- Docker 29+ (required for sandbox)
 
 (Note: Aigency is not tested on Windows. Some features are known to be Windows-incompatible.)
 
@@ -27,28 +27,20 @@ gem 'aigency'
 
 ### Creating a New Aigent
 
-The recommended way to create an aigent is to give it a dedicated system user.
-
-```bash
-useradd aigent_user
-sudo su - aigent_user
-```
-
-Once you're logged in as the aigent user, create the aigent directory:
-
 ```bash
 aigency enlist
 cd aigent
 bundle install
 rake setup
+cp .env.example .env
 ```
 
-The bare minimum configuration you need to do is setting `openai_api_base` and `openai_api_key` in `config/aigent.yml`.
+The bare minimum configuration you need to do is setting `OPENAI_API_BASE` and `OPENAI_API_KEY` in `.env`.
 
-Test the aigent with the `rake say` task.
+Test the aigent with the `say` command.
 
 ```bash
-rake say["How many fibers are intertwined in a shredded wheat biscuit?"]
+bin/aigent say "How many fibers are intertwined in a shredded wheat biscuit?"
 ```
 
-See the aigent's README (scaffold/README.md in this codebase) for more information.
+See the aigent's README for more information (`README.md` in your aigent directory or `scaffold/enlist/README.md` in this codebase).

data/lib/aigency/aigent/current_time.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Aigency
+  class Aigent
+    class CurrentTime < Aigency::Tool
+      description 'Get the current time'
+
+      parameters do
+        any_of :format, description: "Date/time format" do
+          string enum: %w[iso8601 unix]
+          'iso8601'
+        end
+      end
+
+      def execute(format: 'iso8601')
+        aigent.log.puts "[Aigent::CurrentTime] #{format}"
+        now = DateTime.now
+        case format
+        when 'iso8601'
+          { success: true, current_time: now.iso8601 }
+        when 'unix'
+          { success: true, current_time: now.to_time.to_i }
+        else
+          { success: false, error: "Invalid format: #{format}" }
+        end
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/aigent/shell.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Aigency
+  class Aigent
+    # Commands that can be executed in aigent directories.
+    #
+    class Shell < Thor
+      include Delegator
+
+      desc "say PROMPT", "Send a prompt to the aigent"
+      def say(prompt)
+        aigent.stream prompt
+      end
+
+      desc "load FILE", "Load a prompt from a file"
+      def load(file)
+        aigent.load filename
+      end
+
+      desc "setup", "Initialize aigent plugins"
+      def setup
+        aigent.setup
+      end
+
+      desc "tools", "Get a list of available tools"
+      def tools
+        puts aigent.tools.map(&:to_s).sort
+      end
+
+      desc "status", "Get the aigent's current status"
+      def status
+        puts "Name: #{aigent.config('aigent')['name']}"
+        puts "Busy: #{aigent.busy?}"
+        if aigent.busy?
+          puts "Process: #{File.read(aigent.data('lock'))}"
+        end
+      end
+
+      desc "instructions", "List base instructions"
+      long_desc <<~DESC
+        Show all instructions that will be given to the aigent before the user
+        prompt. They typically include the IDENTITY.md file and any prompts injected
+        by installed plugins.
+      DESC
+      def instructions
+        puts aigent.instructions
+      end
+
+      desc "stream", "Tail the currently active chat stream"
+      option :follow, type: :boolean, aliases: :f, desc: "Follow the stream (tail -f)"
+      option :lines, type: :numeric, aliases: :n, desc: "Number of lines (tail -n)", default: 10
+      long_desc <<~DESC
+        This is useful for monitoring non-interactive chat streams, e.g., chat sessions
+        that were started by cron jobs or rake tasks. It runs `tail` on the current chat
+        file in the aigent's data/chats folder.
+      DESC
+      def stream
+        if aigent.busy?
+          file = Dir.glob(aigent.data('chats', '*.txt')).max { |file| File.mtime(file).to_i }
+          cmd = ['tail', file, '-n', options[:lines].to_s]
+          cmd.push '-f' if options[:follow]
+          puts "(#{file})"
+          exec *cmd
+        else
+          puts "No active chat stream."
+        end
+      end
+
+      desc "kill", "Kill a blocking process"
+      long_desc <<~DESC
+        Kill the process that owns an exclusive lock on the aigent's data/lock file.
+      DESC
+      def kill
+        if aigent.busy?
+          pid = File.read(aigent.data('lock')).to_i
+          puts "Killing process #{pid}"
+          Process.kill 'TERM', pid
+        else
+          puts "No blocking process exists."
+        end
+      end
+
+      class << self
+        def mounted? = false
+
+        def start(args = ARGV, config = {})
+          return super if mounted?
+          build('.').start(args, config)
+        end
+
+        def build(directory)
+          Class.new(self) do
+            def self.mounted? = true
+            Aigent.new(directory).plugins.each do |plugin|
+              next unless plugin.shell
+              if all_commands.key?(plugin.name)
+                raise "Plugin '#{plugin.name}' cannot register CLI command '#{plugin.name}': already taken"
+              end
+              register(plugin.shell, plugin.name, "#{plugin.name} [SUBCOMMAND ...ARGS]", "#{plugin.name} plugin commands")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aigency/aigent.rb

@@ -6,13 +6,15 @@ require 'set'
 
 module Aigency
   class Aigent
+    require 'aigency/aigent/current_time'
+    require 'aigency/aigent/shell'
+
     # @return [IO]
     attr_reader :log
 
     def initialize(directory)
       @base_directory = File.absolute_path(directory)
       @log = $stdout
-      load_requires
     end
 
     # @return [String]
@@ -42,10 +44,10 @@ module Aigency
     # @param except [Array<Class<Tool>>] Tools to exclude from this chat
     # @return [RubyLLM::Chat]
     def brief(*extra, except: [])
-      chat = rubyllm_context.chat(provider: :openai)
-      (tools - except).each { |klass| chat.with_tool(klass.new(self)) }
-      chat.with_instructions(build_instructions(extra), append: true)
-      chat.with_params(max_tokens: max_tokens)
+      chat = rubyllm_context.chat(provider: :openai, protocol: :chat_completions)
+      (tools - except).each { |klass| chat.with_tools(klass.new(self)) }
+      chat.with_instructions(build_instructions(extra).join, append: true)
+      chat.with_provider_options(max_tokens: max_tokens)
     end
 
     # Prompt a chat with a file.
@@ -69,16 +71,17 @@ module Aigency
     def stream text, *extra, attach: [], except: [], out: $stdout
       original_log = @log
       @log = out
-      response = brief(*extra, except: except).ask text, with: attach do |chunk|
-        @log.print chunk.thinking&.text
-        @log.print chunk.content
-      end
+      response = brief(*extra, except: except).ask text, with: attach #do |chunk|
+        # @log.print chunk.thinking&.text
+      #end
+      @log.puts response.content
       @log.puts "Input tokens:    #{response.tokens.input}"
       @log.puts "Output tokens:   #{response.tokens.output}"
       response
     rescue StandardError => e
-      @log.puts "[#{e.class}] #{e.message}"
-      @log.puts e.backtrace
+      message = "[#{e.class}] #{e.message}\n" + e.backtrace.map { |line| "    #{line}\n" }.join
+      @log.puts message
+      File.write data('log', 'error.log'), "#{DateTime.now.iso8601} #{message}", mode: 'a'
     ensure
       @log = original_log
     end
@@ -98,7 +101,7 @@ module Aigency
 
     # Run code in an exclusive lock
     #
-    def lock(&block)
+    def block(&block)
       File.open(data('lock'), 'w') do |file|
         file.flock(File::LOCK_EX)
         file.write(Process.pid)
@@ -106,6 +109,8 @@ module Aigency
         block&.call
       end
     end
+    alias lock block
+    alias flock block
 
     # Run code if an exclusive lock is available or skip if a lock exists
     #
@@ -130,33 +135,27 @@ module Aigency
     end
     alias busy? locked?
 
+    # @return [String]
     def instructions
-      @instructions ||= build_instructions([])
+      @instructions ||= build_instructions([]).join("\n\n")
     end
 
     # @return [Array<Plugin>]
     def plugins
       config('aigent').fetch('plugins', [])
+                      .unshift('aigent')
+                      .uniq
                       .map { |name| Plugin.registry[name] }
     end
 
     def tools
-      plugins.flat_map(&:tools)
+      plugins.flat_map(&:tools).uniq
     end
 
     private
 
     # @param plugin [Plugin]
     def boot(plugin)
-      unless plugin.config.empty?
-        config_file = File.absolute_path("#{plugin.name}.yml", directory)
-        if File.exist?(config_file)
-          log.puts "File #{plugin.name}.yml exists, skipping"
-        else
-          log.puts "Creating #{plugin.name}.yml"
-          File.write config_file, plugin.config
-        end
-      end
       plugin.directories.each do |dir|
         absolute = File.absolute_path(dir, directory)
         if File.directory?(absolute)
@@ -166,6 +165,15 @@ module Aigency
           FileUtils.mkdir_p absolute
         end
       end
+      unless plugin.config.empty?
+        config_file = File.absolute_path(File.join('config', "#{plugin.name}.yml"), directory)
+        if File.exist?(config_file)
+          log.puts "File config/#{plugin.name}.yml exists, skipping"
+        else
+          log.puts "Creating config/#{plugin.name}.yml"
+          File.write config_file, plugin.config
+        end
+      end
       plugin.files.each do |file, content|
         absolute = File.absolute_path(file, directory)
         if File.exist?(absolute)
@@ -211,11 +219,10 @@ module Aigency
       @base_instructions ||= identity_file? ? File.read(identity_file) : "You are a helpful AI assistant."
     end
 
+    # @return [Array<String>]
     def build_instructions(extra)
-      [base_instructions].concat tool_prompts
-                         .push "Today's date is #{DateTime.now.strftime('%B %e, %Y')}."
-                         .concat extra
-                         .join("\n\n")
+      [base_instructions].concat(tool_prompts)
+                         .concat(extra)
     end
 
     def tool_prompts
@@ -225,14 +232,6 @@ module Aigency
              .compact
     end
 
-    def load_requires
-      read_requires.each { |name| require name }
-    end
-
-    def read_requires
-      config('aigent')['require'] || []
-    end
-
     def max_tokens
       @max_tokens ||= (config('aigent')['max_tokens'] || -1).to_i
     end
@@ -243,5 +242,23 @@ module Aigency
         config.openai_api_key = config('aigent')['openai_api_key']
       end
     end
+
+    Plugin.register Plugin.new(
+      'aigent',
+      tools: [CurrentTime],
+      directories: ['config', 'data/chats', 'data/log'],
+      rakefile: File.join(GEM_PATH, 'scaffold', 'aigent', 'aigent.rake'),
+      config: <<~FILE
+        name: Aigent
+        openai_api_base: ${OPENAI_API_BASE}
+        openai_api_key: ${OPENAI_API_KEY}
+        # max_tokens: 65536
+        plugins:
+          # You should only need either a workspace or a sandbox, not both. If you
+          # enable one, it's recommended that you disable the other.
+          # - sandbox
+          - workspace
+      FILE
+    )
   end
 end

data/lib/aigency/delegator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Delegator
+    module_function
+
+    def aigent
+      @aigent ||= Aigent.new(Dir.pwd)
+    end
+  end
+end

data/lib/aigency/plugin/shell.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Aigency
+  class Plugin
+    class Shell < Thor
+      include Delegator
+    end
+  end
+end

data/lib/aigency/plugin.rb

@@ -2,20 +2,24 @@
 
 module Aigency
   class Plugin
-    attr_reader :name, :config, :tools, :directories, :files
+    require 'aigency/plugin/shell'
+
+    attr_reader :name, :config, :tools, :directories, :files, :rakefile, :shell
 
     # @param name [String]
     # @param tools [Array<Class<Tool>>]
     # @param config [String]
     # @param directories [Array<String>]
     # @param files [Hash{String => String}]
-    def initialize name, tools: [], config: '', directories: [], files: {}
+    def initialize name, tools: [], config: '', directories: [], files: {}, rakefile: nil, shell: nil
       raise "A plugin named '#{name}' already exists" if self.class.registry.key?(name)
       @name = name
       @config = config
       @tools = tools
       @directories = directories
       @files = files
+      @rakefile = rakefile
+      @shell = shell
       self.class.registry[name] = self
     end
 

data/lib/aigency/rake.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Rake
+    def self.define(directory = '.')
+      aigent = Aigent.new(directory)
+      aigent.plugins
+            .map(&:rakefile)
+            .compact
+            .each { |rakefile| ::Rake.load_rakefile(rakefile) }
+    end
+  end
+end

data/lib/aigency/sandbox/exec.rb

@@ -5,9 +5,9 @@ require 'open3'
 module Aigency
   module Sandbox
     class Exec < Aigency::Tool
-      desc 'Run a shell command in your sandbox'
+      description 'Run a shell command in your sandbox'
 
-      params do
+      parameters do
         string :command, description: "The complete command to execute", required: true
       end
 

data/lib/aigency/sandbox.rb

@@ -7,11 +7,12 @@ module Aigency
     Plugin.register Plugin.new(
       'sandbox',
       tools: [Sandbox::Exec],
-      directories: ['data/sandbox', 'data/sandbox_ssh'],
+      directories: ['sandbox', 'data/sandbox', 'data/sandbox_ssh'],
       files: {
-        'Dockerfile' => File.read(File.join(__dir__, 'sandbox', 'Dockerfile.tpl')),
-        'docker-compose.yml' => File.read(File.join(__dir__, 'sandbox', 'docker-compose.yml.tpl')),
-        'squid.conf' => File.read(File.join(__dir__, 'sandbox', 'squid.conf.tpl'))
+        'sandbox/Dockerfile' => File.read(File.join(GEM_PATH, 'scaffold', 'sandbox', 'Dockerfile')),
+        'sandbox/squid.conf' => File.read(File.join(GEM_PATH, 'scaffold', 'sandbox', 'squid.conf')),
+        'docker-compose.yml' => File.read(File.join(GEM_PATH, 'scaffold', 'sandbox', 'docker-compose.yml')),
+        'data/sandbox_ssh/config' => File.read(File.join(GEM_PATH, 'scaffold', 'sandbox', 'ssh_config'))
       },
       config: <<~FILE
         prompt: "The sandbox tools provide access to a Docker container."

data/lib/aigency/shell.rb

@@ -4,9 +4,11 @@ require 'fileutils'
 require 'thor'
 
 module Aigency
+  # Top-level aigency commands for creating aigents.
+  #
   class Shell < Thor
     map %i[new] => :enlist
-    desc "enlist [DIRECTORY]", "Enable the current user as an aigent"
+    desc "enlist [DIRECTORY]", "Create an aigent directory"
     def enlist directory = 'aigent'
       puts "Installing aigent at #{directory}"
       if File.exist?(directory)
@@ -18,16 +20,7 @@ module Aigency
         end
       end
       FileUtils.mkdir(directory) unless File.directory?(directory)
-      FileUtils.copy_entry(File.join(GEM_PATH, 'scaffold'), directory)
+      FileUtils.copy_entry(File.join(GEM_PATH, 'scaffold', 'enlist'), directory)
     end
-
-    # desc "setup PLUGIN [...PLUGIN]", "Initialize plugin files"
-    # option :all, type: :boolean, alias: :a, description: "Set up all plugins", default: false
-    # option :overwrite, type: :boolean, alias: :o, description: "Overwrite existing files", default: false
-    # def setup *plugins
-    #   # @todo Assuming all for now
-    #   aigent = Aigent.new(aigent)
-    #   aigent.setup
-    # end
   end
 end

data/lib/aigency/tempdir/helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    module Helpers
+      module_function
+
+      def expand_in_tempdir path
+        absolute = File.absolute_path(path, PATH)
+        raise PathError, "#{path} is not relative to tempdir" unless absolute.start_with?(PATH)
+        absolute
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class List < Tool
+      description "List all files in the temp directory"
+
+      def execute
+        aigent.log.puts "[Tempdir::List]"
+        {
+          success: true,
+          absolute_paths: Dir.glob(File.join(PATH, '**', '*'))
+        }
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/read.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Read < Tool
+      include Helpers
+
+      description "Read a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The file to read"
+      end
+
+      def execute(filename:)
+        aigent.log.puts "[Tempdir::Read] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        # @todo Hardcoded max size
+        if File.size(absolute_path) > 500_000
+          { success: false, error: "File is too large to read (max 500000 bytes)"}
+        else
+          {
+            success: true,
+            absolute_path: absolute_path,
+            content: File.read(File.join(PATH, filename))
+          }
+        end
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/size.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Size < Tool
+      include Helpers
+
+      description "Get the size of a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The file to measure"
+      end
+
+      def execute(filename:)
+        aigent.log.puts "[Tempdir::Read] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        {
+          success: true,
+          absolute_path: absolute_path,
+          size: File.size(absolute_path)
+        }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/write.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Write < Tool
+      include Helpers
+
+      description "Write a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The filename to write"
+        string :content, description: "The file's content"
+      end
+
+      def execute(filename:, content:)
+        aigent.log.puts "[Tempdir::Write] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        File.write absolute_path, content
+        {
+          success: true,
+          absolute_path: absolute_path
+        }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end