ox-ai-workers 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca54c1ff9c1f4360ddfe986c4b5bc6fb6b7c0cde0484d1b2f88bfe4d8c5707b7
-  data.tar.gz: 2c54e55fedd99af36f7a510ab923c54581faecfc8b36caa4d228f14349e293a8
+  metadata.gz: 6f6d50356df9fac9b6a2497737e46f2b478051fa9e1c524bde5047c06c38b07b
+  data.tar.gz: 7577169961cd5b1720b697c7751d9560a73415e52bfdba4f889dca695b7c9db7
 SHA512:
-  metadata.gz: b8915a64826c118706328c89a87c01fdf49f13b63408c64d5af1ea53a2f92dbb326b9e537f36aa755297a5c919239d426da1f38a83b3cd5fdfbc5a9ebc4146f7
-  data.tar.gz: 8614ed16d7771b594bda52de36f87bbd211adfc8c579fff752634fc4ce44a7d554cd25cf7b32bfaa80954830f835a7b3c1f61d0e237c930bc043f433e98534c1
+  metadata.gz: 35702e04879dcffc1f87f0224df17c251983ddae5c8915264d5ae5df0a2c254b8e9949bc7333b80125f05791e1ac21c5f5ce3106337db3da18646565d4b0243e
+  data.tar.gz: cbf4c76a447d52484c63afc4546589b4cf4098ad9b441cbb9e7eb7bf8297de011bb1eff5410fdfad57c3010619cb818fb53b8e67bf32f318fc86e995649ca948

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.5.6] - 2024-08-02
+
+- Added `oxaiworkers run` command
+
 ## [0.5.5] - 2024-08-02
 
 - Added `only` for Tools

data/README.md

@@ -97,9 +97,11 @@ Then you can create an assistant like this:
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
 assistant.task = "Remove all cron jobs."
+# assistant.execute # if auto_execute is false
 
 # Provide a response to the assistant's question
 assistant.add_response("blah-blah-blah")
+# assistant.execute # if auto_execute is false
 ```
 
 Besides, you can create assistants with different locales
@@ -132,6 +134,12 @@ iterator.add_task("Show files in current directory.")
 iterator.add_task("linux")
 ```
 
+If `auto_execute` is set to false in the configuration, don't forget to manually execute the iterator or assistant.
+
+```ruby
+iterator.execute # if auto_execute is false
+```
+
 This way, you have the flexibility to choose between a higher-level assistant for simplicity or a lower-level iterator for finer control over the tasks and tools used.
 
 ### Advanced instructions for your Assistant
@@ -176,25 +184,25 @@ As a worker, you can use different classes depending on your needs:
 
 2. Initialize with the command:
 
-```sh
-oxaiworkers init
-```
+    ```sh
+    oxaiworkers init
+    ```
 
-This will create a `.oxaiworkers-local` directory with the necessary initial source code.
+    This will create a `.oxaiworkers-local` directory with the necessary initial source code.
 
-Additionally, you can initialize a more comprehensive example using the command:
+    Additionally, you can initialize a more comprehensive example using the command:
 
-```sh
-oxaiworkers init full
-```
+    ```sh
+    oxaiworkers init full
+    ```
 
-After this, in the `my_assistant.rb` file, you can find an example of an assistant that uses a tool from the `tools/my_tool.rb` file. In the `start` file, you will find the algorithm for applying this assistant.
+    After this, in the `my_assistant.rb` file, you can find an example of an assistant that uses a tool from the `tools/my_tool.rb` file. In the `start` file, you will find the algorithm for applying this assistant.
 
 3. Modify the code as needed and run:
 
-```sh
-.oxaiworkers-local/start
-```
+    ```sh
+    .oxaiworkers-local/start
+    ```
 
 ## Logging
 
@@ -205,6 +213,82 @@ To show all log messages:
 OxAiWorkers.logger.level = :debug
 ```
 
+## Real World Examples
+
+### Project: Python Snake Game
+
+1. Create the project folder:
+
+    ```sh
+    mkdir snake
+    cd snake
+    ```
+
+2. Initialize OxAiWorkers:
+
+    ```sh
+    oxaiworkers init
+    ```
+
+3. Modify the file `.oxaiworkers-local/start`:
+
+    ```ruby
+    # Replace
+    @assistant = OxAiWorkers::Assistant::Sysop.new
+
+    # With
+    @assistant = OxAiWorkers::Assistant::Coder.new(language: 'python')
+    ```
+
+4. Run the project:
+
+    ```sh
+    .oxaiworkers-local/start
+    ```
+
+5. In the command prompt, type:
+
+    ```sh
+    @assistant.task = "Write a snake game"
+    ```
+
+### Running System Operator in Any Directory
+
+To run OxAiWorkers in any directory, execute the following command:
+
+```sh
+oxaiworkers run sysop
+```
+
+Alternatively, you can use IRB (Interactive Ruby):
+
+1. Start IRB:
+
+    ```sh
+    irb
+    ```
+
+2. In the console, enter the following commands:
+
+    ```ruby
+    require 'ox-ai-workers'
+    @sysop = OxAiWorkers::Assistant::Sysop.new
+    ```
+
+Then set a task:
+
+```ruby
+@sysop.task = "Show all cron jobs."
+```
+
+After these steps you can interact with it using the following method:
+
+```ruby
+@sysop.add_response("Yes, I want it.")
+```
+
+or set a new task.
+
 ## Features
 
 - **Generative Intelligence**: Leverages OpenAI's capabilities to enhance task execution.

data/exe/oxaiworkers

@@ -21,4 +21,13 @@ if ARGV.first == 'init'
     puts "A #{dir} directory was created with the necessary initial settings."
     puts "Modify the settings as needed and run: #{dir}/start"
   end
+elsif ARGV.first == 'run'
+  require 'irb'
+  require 'ox-ai-workers'
+  puts "#{ARGV.last.capitalize}: #{OxAiWorkers::VERSION}"
+  instance_variable_set("@#{ARGV.last}", Object.const_get("OxAiWorkers::Assistant::#{ARGV.last.capitalize}").new)
+  ARGV.clear
+  IRB.start
+else
+  puts "Error: Unknown command: #{ARGV.first}"
 end

data/lib/oxaiworkers/assistant/coder.rb

@@ -18,6 +18,12 @@ module OxAiWorkers
           on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
       end
+
+      def language=(language)
+        with_locale do
+          @iterator.role = format(I18n.t('oxaiworkers.assistant.coder.role'), language)
+        end
+      end
     end
   end
 end

data/lib/oxaiworkers/tool/eval.rb

@@ -24,7 +24,7 @@ module OxAiWorkers
       end
 
       def ruby(input:)
-        puts "Executing ruby: \"#{input}\"".colorize(:red)
+        OxAiWorkers.logger.info("Executing ruby: \"#{input}\"", for: self.class)
         eval(input)
       end
 

data/lib/oxaiworkers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OxAiWorkers
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 end

data/template/start

@@ -20,6 +20,7 @@ puts "OxAiWorkers #{OxAiWorkers::VERSION}"
 OxAiWorkers.configure do |config|
   config.access_token = ENV.fetch('OPENAI')
   config.model = 'gpt-4o-mini'
+  # config.auto_execute = false
 end
 
 # OxAiWorkers.logger.level = :debug
@@ -28,4 +29,7 @@ end
 @assistant = MyAssistant.new
 @assistant.task = '2 + 2 is ?'
 
+# Uncomment this if auto_execute is false
+# @assistant.execute
+
 IRB.start(__FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Denis Smolev