aigency 0.2.0 → 0.4.0

data/scaffold/enlist/README.md

@@ -0,0 +1,90 @@
+# Your Aigent
+
+An aigent (AI agent) is an intelligent assistant powered by language models through OpenAI-compatible APIs. It can read and write files in its private workspace and perform scheduled tasks on your behalf.
+
+## Configuration
+
+### 1. Install dependencies
+
+```bash
+bundle install
+```
+
+### 2. Configure OpenAI API Connection
+
+Copy the example env file:
+
+```bash
+cp .env.example .env
+```
+
+Modify the `OPENAI_API_BASE` and `OPENAI_API_KEY` as needed. If you're using a local AI server or any other provider that is compatible with OpenAI, you can set the OPENAI_API_BASE config option to point there instead (e.g., `http://localhost:8080/v1`).
+
+### 3. Define the Aigent's Personality
+
+Edit `IDENTITY.md` to define how your aigent should behave:
+
+```markdown
+You are a professional assistant named Alex. You respond in a friendly but concise manner.
+```
+
+This file sets the foundation for all the aigent's responses.
+
+### 4. Configure Plugins
+
+Aigency ships with two plugins: `workspace` and `sandbox`. The `workspace` plugin is enabled by default. It's recommended that you use one or the other, but not both.
+
+The `workspace` plugin gives your aigent a directory where it can manage its own files.
+
+The `sandbox` plugin provides a container where the aigent can not only manage files, but also run commands and scripts.
+
+The `workspace` plugin is sufficient for many aigents. Switch to `sandbox` if you need your aigent to perform software development or other complex tasks.
+
+### 5. Run setup
+
+```bash
+rake setup
+```
+
+## Usage
+
+### Interactive Mode
+
+Talk to your aigent using the `say` command:
+
+```bash
+bin/aigent say "How many fibers are intertwined in a shredded wheat biscuit?"
+```
+
+### Scheduling Tasks
+
+Aigents use the `whenever` gem for scheduling. Example of a scheduled task:
+
+```ruby
+# config/schedule.rb
+
+# Every day at 9am, the aigent will run the prompt in the DAILY_TASKS.md file
+every 1.day, at: '9am' do
+  rake 'load[DAILY_TASKS.md]'
+end
+```
+
+Add the scheduled tasks to your crontab:
+
+```bash
+bundle exec whenever --update-crontab
+```
+
+(Note: the `whenever` gem does not work on Windows.)
+
+### Using the Sandbox
+
+If you enable the `sandbox` plugin, you'll need to start the container:
+
+```bash
+docker compose up -d
+```
+
+The sandbox app is initialized with an egress that only allows network access to domains that are whitelisted in `squid.conf`. See the `http_targets` and `ssh_targets` ACLs.
+
+Manage the sandbox user's SSH configuration in `data/sandbox_ssh`.

data/scaffold/enlist/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/setup"
+require 'dotenv/load'
+Bundler.require(:default)
+
+Aigency::Rake.define('.')
+
+# Run `rake --tasks` for a list of tasks provided by aigent plugins.
+
+# Custom rake tasks can be added below.

data/scaffold/enlist/bin/aigent

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# turn off warning diagnostics from Ruby
+$VERBOSE=nil
+
+require "bundler/setup"
+require 'dotenv/load'
+Bundler.require(:default)
+
+Aigency::Aigent::Shell.start(ARGV)

data/scaffold/{config → enlist/config}/schedule.rb

@@ -19,6 +19,11 @@
 
 # Learn more: http://github.com/javan/whenever
 
+job_type :rake, "cd :path && :environment_variable=:environment :bundle_command rake :task :output"
+
+set :output, File.join(Dir.pwd, 'data', 'log', 'cron.log')
+
+# Example job: run a prompt from a file named `DAILY.md` once a day
 # every 1.day do
 #   rake "load[DAILY.md]"
 # end

data/scaffold/sandbox/Dockerfile

@@ -0,0 +1,37 @@
+FROM alpine:latest
+
+RUN apk update && apk upgrade && apk add --no-cache \
+      autoconf \
+      bash \
+      bison \
+      build-base \
+      curl \
+      git \
+      libffi-dev \
+      linux-headers \
+      mise \
+      musl-dev \
+      netcat-openbsd \
+      nodejs \
+      openssh \
+      openssl \
+      openssl-dev \
+      perl \
+      pkgconf \
+      python3 \
+      tzdata \
+      xz \
+      yaml-dev \
+      zlib-dev
+
+RUN adduser -D -h /sandbox user \
+    && mkdir -p /opt/mise \
+    && chown -R user:user /opt/mise
+USER user
+ENV MISE_DATA_DIR=/opt/mise \
+    MISE_CONFIG_DIR=/opt/mise/config \
+    MISE_TRUSTED_CONFIG_PATHS=/sandbox \
+    PATH=/opt/mise/shims:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+RUN mise use -g ruby@3.4 && mise install --yes
+
+CMD ["sleep", "infinity"]

data/scaffold/sandbox/docker-compose.yml

@@ -0,0 +1,37 @@
+services:
+  app:
+    build:
+      context: .
+      dockerfile: ./sandbox/Dockerfile
+    networks: [sandbox]
+    restart: unless-stopped
+    depends_on:
+      - egress
+    volumes:
+      - ./data/sandbox:/sandbox
+      - ./data/sandbox_ssh:/sandbox/.ssh
+    working_dir: /sandbox
+    environment:
+      - http_proxy=http://egress:3128
+      - https_proxy=http://egress:3128
+      - HTTP_PROXY=http://egress:3128
+      - HTTPS_PROXY=http://egress:3128
+      - no_proxy=localhost,127.0.0.1,::1
+      - NO_PROXY=localhost,127.0.0.1,::1
+    command: ["sleep", "infinity"]
+
+  egress:
+    image: ubuntu/squid
+    networks: [sandbox, outside]
+    volumes:
+      - ./sandbox/squid.conf:/etc/squid/squid.conf:ro
+
+networks:
+   sandbox:
+     internal: true
+     driver: bridge
+     driver_opts:
+       com.docker.network.bridge.gateway_mode_ipv4: isolated
+       com.docker.network.bridge.gateway_mode_ipv6: isolated
+   outside:
+     driver: bridge

data/scaffold/sandbox/squid.conf

@@ -0,0 +1,25 @@
+# Allowlist-only forward proxy.
+# NOTE: this file deliberately does NOT `include /etc/squid/conf.d/*`, so the
+# rules Ubuntu ships in the image can't silently widen the allowlist.
+
+http_port 3128
+visible_hostname egress
+cache deny all                       # forward proxy only, nothing to disk
+access_log daemon:/var/log/squid/access.log
+logfile_rotate 0
+forwarded_for off                    # don't leak the container's IP downstream
+
+acl SSL_ports  port 443
+acl Safe_ports port 80 443
+acl http_targets dstdomain \
+  www.example.com
+
+acl SSH_ports port 22
+acl ssh_targets dstdomain \
+  ssh.example.com
+
+http_access allow CONNECT ssh_targets SSH_ports
+http_access deny !Safe_ports
+http_access deny CONNECT !SSL_ports
+http_access allow  http_targets
+http_access deny   all

data/scaffold/sandbox/ssh_config

@@ -0,0 +1,2 @@
+Host *
+    ProxyCommand nc -X connect -x egress:3128 %h %p

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aigency
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Fred Snyder
@@ -9,6 +9,34 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
@@ -29,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +79,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 email:
 - fsnyder@castwide.com
 executables:
@@ -64,25 +134,53 @@ files:
 - exe/aigency
 - lib/aigency.rb
 - lib/aigency/aigent.rb
+- lib/aigency/aigent/current_time.rb
+- lib/aigency/aigent/shell.rb
+- lib/aigency/delegator.rb
+- lib/aigency/plugin.rb
+- lib/aigency/plugin/shell.rb
+- lib/aigency/rake.rb
+- lib/aigency/sandbox.rb
+- lib/aigency/sandbox/exec.rb
 - lib/aigency/shell.rb
+- lib/aigency/tempdir.rb
+- lib/aigency/tempdir/helpers.rb
+- lib/aigency/tempdir/list.rb
+- lib/aigency/tempdir/read.rb
+- lib/aigency/tempdir/size.rb
+- lib/aigency/tempdir/write.rb
 - lib/aigency/tool.rb
-- lib/aigency/tools.rb
 - lib/aigency/usability.rb
 - lib/aigency/version.rb
 - lib/aigency/workspace.rb
-- lib/aigency/workspace/directory_deleter.rb
-- lib/aigency/workspace/directory_reader.rb
-- lib/aigency/workspace/file_deleter.rb
-- lib/aigency/workspace/file_reader.rb
-- lib/aigency/workspace/file_writer.rb
+- lib/aigency/workspace/cat.rb
+- lib/aigency/workspace/cmd.rb
+- lib/aigency/workspace/copy_tempdir_file.rb
+- lib/aigency/workspace/cp.rb
+- lib/aigency/workspace/diff.rb
+- lib/aigency/workspace/grep.rb
+- lib/aigency/workspace/head.rb
 - lib/aigency/workspace/helpers.rb
-- scaffold/.gitignore
-- scaffold/Gemfile
-- scaffold/IDENTITY.md
-- scaffold/README.md
-- scaffold/Rakefile
-- scaffold/config/aigent.yml
-- scaffold/config/schedule.rb
+- lib/aigency/workspace/ls.rb
+- lib/aigency/workspace/mkdir.rb
+- lib/aigency/workspace/mv.rb
+- lib/aigency/workspace/rm.rb
+- lib/aigency/workspace/tail.rb
+- lib/aigency/workspace/wc.rb
+- lib/aigency/workspace/write.rb
+- scaffold/aigent/aigent.rake
+- scaffold/enlist/.env.example
+- scaffold/enlist/.gitignore
+- scaffold/enlist/Gemfile
+- scaffold/enlist/IDENTITY.md
+- scaffold/enlist/README.md
+- scaffold/enlist/Rakefile
+- scaffold/enlist/bin/aigent
+- scaffold/enlist/config/schedule.rb
+- scaffold/sandbox/Dockerfile
+- scaffold/sandbox/docker-compose.yml
+- scaffold/sandbox/squid.conf
+- scaffold/sandbox/ssh_config
 - sig/aigency.rbs
 licenses: []
 metadata: {}

data/lib/aigency/tools.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Aigency
-  module Tools
-    # @return [Array<Class<Tool>>]
-    def self.registry
-      @registry ||= []
-    end
-
-    # @return [Hash{String => String}]
-    def self.config_map
-      @configs ||= {}
-    end
-
-    # @return [Array<String>]
-    def self.directories
-      @directories ||= []
-    end
-
-    # Register a tool.
-    #
-    # @param klass [Class<Tool>]
-    # @return [void]
-    def self.register klass
-      registry.push klass
-    end
-
-    # Define a default configuration.
-    #
-    # @param name [String] The name of the config section
-    # @param text [String] YAML-formatted config data
-    # @return [void]
-    def self.configure name, text
-      config_map[name] = text
-    end
-
-    # Define directories to be created relative to an aigent's root.
-    #
-    def self.mkdir_p *paths
-      directories.concat paths
-    end
-  end
-
-  Tools.configure 'aigent', <<~EOF
-    name: an Aigent
-    openai_api_base: https://api.openai.com/v1
-    openai_api_key: CHANGE_ME
-    require:
-      - aigency/email
-      - aigency/wikipedia
-      - aigency/workspace
-  EOF
-
-  Tools.mkdir_p 'data/chats', 'data/log'
-end

data/lib/aigency/workspace/directory_deleter.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Aigency
-  module Workspace
-    class DirectoryDeleter < Tool
-      include Helpers
-
-      desc "Delete a directory and all of its contents from your private workspace"
-
-      def execute(directory_name:)
-        aigent.log.puts "[Workspace::DirectoryDeleter] #{directory_name}"
-
-        resolved = expand_to_workspace(directory_name)
-        FileUtils.rm_rf(resolved)
-        { dirname: directory_name, success: true }
-      rescue StandardError => e
-        { success: false, error: "[#{e.class}] #{e.message}"}
-      end
-    end
-  end
-end
-
-Aigency::Tools.register Aigency::Workspace::DirectoryDeleter

data/lib/aigency/workspace/directory_reader.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Aigency
-  module Workspace
-    class DirectoryReader < Tool
-      include Helpers
-
-      desc "Get the contents of a directory from your private workspace"
-
-      def execute(directory_name:)
-        aigent.log.puts "[Workspace::DirectoryReader] Reading #{directory_name}"
-        resolved = expand_to_workspace(directory_name)
-        if File.directory?(resolved)
-          {
-            directory: directory_name,
-            success: true,
-            entries: Dir.entries(resolved)[2..]
-          }
-        else
-          {
-            directory: directory_name,
-            success: false,
-            error: "Not a directory"
-          }
-        end
-      rescue StandardError => e
-        { success: false, error: "[#{e.class}] #{e.message}" }
-      end
-    end
-  end
-end
-
-Aigency::Tools.register Aigency::Workspace::DirectoryReader

data/lib/aigency/workspace/file_deleter.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Aigency
-  module Workspace
-    class FileDeleter < Tool
-      include Helpers
-
-      desc "Delete a file from your private workspace"
-
-      def execute(filename:)
-        aigent.log.puts "[Workspace::FileDeleter] Deleting file #{filename}"
-        resolved = expand_to_workspace(filename)
-        File.delete resolved
-        { filename: filename, success: true }
-      rescue StandardError => e
-        { success: false, error: "[#{e.class}] #{e.message}" }
-      end
-    end
-  end
-end
-
-Aigency::Tools.register Aigency::Workspace::FileDeleter

data/lib/aigency/workspace/file_reader.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Aigency
-  module Workspace
-    class FileReader < Tool
-      include Helpers
-
-      desc "Read a file from your private workspace"
-
-      def execute(filename:)
-        aigent.log.puts "[Workspace::FileReader] Reading #{filename}"
-
-        resolved = expand_to_workspace(filename)
-
-        {
-          success: true,
-          filename: filename,
-          content: File.read(resolved)
-        }
-      rescue StandardError => e
-        { success: false, error: "[#{e.class}] #{e.message}"}
-      end
-    end
-  end
-end
-
-Aigency::Tools.register Aigency::Workspace::FileReader

data/lib/aigency/workspace/file_writer.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-module Aigency
-  module Workspace
-    class FileWriter < Tool
-      include Helpers
-
-      desc "Write a file to your private workspace"
-
-      def execute(filename:, content:)
-        aigent.log.puts "[Workspace::FileWriter] Writing #{filename}"
-
-        resolved = expand_to_workspace(filename)
-        FileUtils.mkdir_p File.dirname(resolved)
-        File.write resolved, content
-        return { filename: filename, success: true }
-      rescue StandardError => e
-        { success: false, error: "[#{e.class}] #{e.message}" }
-      end
-    end
-  end
-end
-
-Aigency::Tools.register Aigency::Workspace::FileWriter

data/scaffold/README.md

@@ -1,74 +0,0 @@
-# Your Aigent
-
-An aigent (AI agent) is an intelligent assistant powered by language models through OpenAI-compatible APIs. It can read and write files in its private workspace and perform scheduled tasks on your behalf.
-
-## Configuration
-
-### Install dependencies
-
-```bash
-bundle install
-```
-
-### Initial setup
-
-```bash
-rake setup
-```
-
-### 1. Configure the Aigent
-
-Configure the aigent's settings in `config/aigent.yml`.
-
-#### OpenAI-Compatible Providers
-
-If you're using a local AI server or any other provider that is compatible with OpenAI, you can set the OPENAI_API_BASE config option to point there instead (e.g., `http://localhost:8080/v1`).
-
-### 2. Define the Aigent's Personality
-
-Edit `IDENTITY.md` to define how your aigent should behave:
-
-```markdown
-You are a professional assistant named Alex. You respond in a friendly but concise manner.
-```
-
-This file sets the foundation for all the aigent's responses.
-
-## Usage
-
-### Interactive Mode
-
-Talk to your aigent using the Rake task:
-
-```bash
-rake say["Tell me about project progress"]
-```
-
-### The Workspace
-
-Your aigent has read/write access to everything in the `data/workspace` directory.
-
-### Scheduling Tasks
-
-The project includes the `whenever` gem for scheduling. Example of a scheduled task:
-
-```ruby
-# config/schedule.rb
-
-# Every day at 9am, the aigent will run the prompt in the DAILY_TASKS.md file
-every 1.day, at: '9am' do
-  rake 'load[DAILY_TASKS.md]'
-end
-```
-
-Add the scheduled tasks to your crontab:
-
-```bash
-bundle exec whenever --update-crontab
-```
-
-(Note: the `whenever` gem does not work on Windows.)
-
-## Aigent Tools
-
-You can give your aigent more functionality by installing additional tools. It ships with the `Workspace` tool, which gives it full read/write access to the `data/workspace` directory.

data/scaffold/config/aigent.yml

@@ -1,6 +0,0 @@
-name: an Aigent
-openai_api_base: https://api.openai.com/v1
-openai_api_key: CHANGE_ME
-# max_tokens: 65536
-# require:
-#   - aigency-example