Use tool forge

Author: afstanton

examples/docker_chat.rb

@@ -24,6 +24,9 @@
 require 'io/console'
 
 # rubocop:disable Metrics/ClassLength
+
+# Interactive Docker chat interface using RubyLLM and OpenAI.
+# Provides natural language interaction with Docker containers, images, networks, and volumes.
 class DockerChat
   def initialize
     check_environment

lib/ruby_llm/docker.rb

@@ -3,6 +3,7 @@
 require 'ruby_llm'
 require 'docker'
 require 'shellwords'
+require 'tool_forge'
 require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem_extension(RubyLLM)
@@ -11,6 +12,18 @@
 require_relative 'docker/version'
 
 module RubyLLM
+  # Docker tools module providing comprehensive Docker management capabilities for RubyLLM.
+  #
+  # This module contains 22 Docker management tools organized into four categories:
+  # - Container Management (10 tools)
+  # - Image Management (6 tools)
+  # - Network Management (3 tools)
+  # - Volume Management (3 tools)
+  #
+  # @example Basic usage
+  #   chat = RubyLLM::Chat.new(api_key: 'your-key', model: 'gpt-4')
+  #   RubyLLM::Docker.add_all_tools_to_chat(chat)
+  #   response = chat.ask("How many containers are running?")
   module Docker
     class Error < StandardError; end
 

lib/ruby_llm/docker/build_image.rb

@@ -73,7 +73,7 @@ module Docker
     #
     # @see Docker::Image.build_from_dir
     # @since 0.1.0
-    BUILD_IMAGE_DEFINITION = ::ToolForge.define(:build_image) do
+    BUILD_IMAGE_DEFINITION = ToolForge.define(:build_image) do
       description 'Build a Docker image'
 
       param :dockerfile,

lib/ruby_llm/docker/copy_to_container.rb

@@ -63,7 +63,7 @@ module Docker
     #
     # @see Docker::Container#archive_in_stream
     # @since 0.1.0
-    COPY_TO_CONTAINER_DEFINITION = ::ToolForge.define(:copy_to_container) do
+    COPY_TO_CONTAINER_DEFINITION = ToolForge.define(:copy_to_container) do
       description 'Copy a file or directory from the local filesystem into a running Docker container. ' \
                   'The source path is on the local machine, and the destination path is inside the container.'
 

lib/ruby_llm/docker/create_container.rb

@@ -61,7 +61,7 @@ module Docker
     #
     # @see Docker::Container.create
     # @since 0.1.0
-    CREATE_CONTAINER_DEFINITION = ::ToolForge.define(:create_container) do
+    CREATE_CONTAINER_DEFINITION = ToolForge.define(:create_container) do
       description 'Create a Docker container'
 
       param :image,

lib/ruby_llm/docker/create_network.rb

@@ -74,7 +74,7 @@ module Docker
     #
     # @see Docker::Network.create
     # @since 0.1.0
-    CREATE_NETWORK_DEFINITION = ::ToolForge.define(:create_network) do
+    CREATE_NETWORK_DEFINITION = ToolForge.define(:create_network) do
       description 'Create a Docker network'
 
       param :name,

lib/ruby_llm/docker/create_volume.rb

@@ -73,7 +73,7 @@ module Docker
     #
     # @see Docker::Volume.create
     # @since 0.1.0
-    CREATE_VOLUME_DEFINITION = ::ToolForge.define(:create_volume) do
+    CREATE_VOLUME_DEFINITION = ToolForge.define(:create_volume) do
       description 'Create a Docker volume'
 
       param :name,

lib/ruby_llm/docker/exec_container.rb

@@ -73,7 +73,7 @@ module Docker
     #
     # @see Docker::Container#exec
     # @since 0.1.0
-    EXEC_CONTAINER_DEFINITION = ::ToolForge.define(:exec_container) do
+    EXEC_CONTAINER_DEFINITION = ToolForge.define(:exec_container) do
       description 'Execute a command inside a running Docker container. ' \
                   'WARNING: This provides arbitrary command execution within the container. ' \
                   'Ensure proper security measures are in place.'

lib/ruby_llm/docker/fetch_container_logs.rb

@@ -57,7 +57,7 @@ module Docker
     #
     # @see Docker::Container#logs
     # @since 0.1.0
-    FETCH_CONTAINER_LOGS_DEFINITION = ::ToolForge.define(:fetch_container_logs) do
+    FETCH_CONTAINER_LOGS_DEFINITION = ToolForge.define(:fetch_container_logs) do
       description 'Fetch Docker container logs'
 
       param :id,

lib/ruby_llm/docker/list_containers.rb

@@ -46,7 +46,7 @@ module Docker
     #
     # @see Docker::Container.all
     # @since 0.1.0
-    LIST_CONTAINERS_DEFINITION = ::ToolForge.define(:list_containers) do
+    LIST_CONTAINERS_DEFINITION = ToolForge.define(:list_containers) do
       description 'List Docker containers'
 
       param :all,