ask-tools-shell 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1f5ba13ed96fd946f5fae6eaa010ac2ae9c8ef6c87a48fcec7ec0b994f1164
-  data.tar.gz: 79a8c50c47d6b43ba2fbe9dddd8a514aac6f2baa5951c240131003f4f88ac22d
+  metadata.gz: 57dd21c05244ce8dfcdc2b9c631ed37983b0d87071421906c7a38b090a36d237
+  data.tar.gz: 786e6bb78c5f98840d45554d77c826ddec8c94320fba1696425833e865bfef6e
 SHA512:
-  metadata.gz: d918ba9bd43e27f511c82f9adc4de3d6daa8817531555cfc567729f807f92df8e18f28932aa6e59738c0d2f1e653562255240df5974f3e128249e8ac04258418
-  data.tar.gz: 226ea5d605b60d10a8b6839c4469d5cbc97076f3c08596e59c0adb0fe29ed0b03bc95b54261af51a3c6babd074489a9b0ca3b55f47281d0cd8a4d1f41e01fe24
+  metadata.gz: cc2b723b0e12766e682ad46cebe01b60cd35fbc8df1fbece1c165f03f05bdfd3b534745cb57af78dac6bf550130a6cc21431f67f31d640ce025cfef7ec91b300
+  data.tar.gz: 7f5bf812384a63539c90b153d3bb1e5bfc30014634f357ce49bbf4f8860fbb423ac0dda9e813da12f50e0a0d6c3614e7b8a95dfaee95c738674bfcd53a3e4ec3

data/lib/ask/skills/shell.patterns/SKILL.md

@@ -0,0 +1,175 @@
+---
+name: shell.patterns
+description: Common shell tool composition patterns for code analysis, searching, and file manipulation
+---
+
+Use this skill when you need to search, analyze, or manipulate a codebase using
+shell tools. These patterns show you the most effective way to combine tools
+for common tasks.
+
+## Pattern 1: Find and Search with Glob + Grep
+
+The most powerful pattern for code analysis is combining Glob and Grep.
+
+**Find files of a type, then search their contents:**
+
+```ruby
+# Step 1: Find relevant files
+result = Glob.new.call(pattern: "**/*.rb", path: "/path/to/project")
+
+# Step 2: Search for a pattern in those files
+Grep.new.call(pattern: "class.*API", path: "/path/to/project", include: "*.rb")
+```
+
+**Search first to narrow, then read specific files:**
+
+```ruby
+# Step 1: Find where a method is used
+Grep.new.call(pattern: "def process_payment", path: "/project")
+
+# Step 2: Read the specific files found
+Read.new.call(path: "/project/app/services/payment_processor.rb")
+```
+
+## Pattern 2: Read Files with Offset/Limit
+
+When reading large files, use offset and limit to navigate:
+
+```ruby
+# Read the first 50 lines
+Read.new.call(path: "large_file.rb", limit: 50)
+
+# Then read from where you left off
+Read.new.call(path: "large_file.rb", offset: 50, limit: 50)
+```
+
+This avoids truncation and lets you browse files in chunks.
+
+## Pattern 3: Pipe Shell Commands via Bash
+
+For complex queries that aren't a simple grep, use Bash with pipes:
+
+```ruby
+# Count lines of Ruby code
+Bash.new.call(command: "find . -name '*.rb' -exec cat {} \\; | wc -l", workdir: "/project")
+
+# Find the top 10 largest files
+Bash.new.call(command: "find . -name '*.rb' -exec wc -l {} \\; | sort -rn | head -10", workdir: "/project")
+
+# Search git history
+Bash.new.call(command: "git log --oneline --all --grep='fix' | head -20", workdir: "/project")
+```
+
+## Pattern 4: Edit with Read + Edit + Read
+
+The safe way to make changes is Read → Edit → Read:
+
+```ruby
+# Step 1: Read the file to find exact text
+Read.new.call(path: "app/models/user.rb")
+
+# Step 2: Edit with exact match (provide surrounding context for uniqueness)
+Edit.new.call(
+  path: "app/models/user.rb",
+  old_string: "has_many :posts",
+  new_string: "has_many :posts, dependent: :destroy"
+)
+
+# Step 3: Verify the change
+Read.new.call(path: "app/models/user.rb", limit: 30)
+```
+
+When a string could appear multiple times:
+```ruby
+# First verify occurrences
+Grep.new.call(pattern: "old_string", path: "/project")
+
+# Then replace all if appropriate
+Edit.new.call(path: "file.rb", old_string: "old", new_string: "new", replace_all: true)
+```
+
+## Pattern 5: Code Execution for Quick Ruby Checks
+
+Use Code for ad-hoc Ruby that doesn't need tools:
+
+```ruby
+# Check Ruby version or gem availability
+Code.new.call(code: "puts Gem::Specification.map(&:name).grep(/devise/).first")
+
+# Parse and inspect data structures
+Code.new.call(code: "require 'json'; data = JSON.parse(File.read('data.json')); puts data.keys")
+
+# Test a regex before using it in Grep
+Code.new.call(code: "puts /foo.*bar/.match?('foo_baz_bar')")
+```
+
+## Pattern 6: Write Files with Content
+
+Create or overwrite files with Write:
+
+```ruby
+# Create a new file
+Write.new.call(path: "/project/app/services/new_service.rb", content: <<~RUBY)
+  class NewService
+    def call
+      # ...
+    end
+  end
+RUBY
+```
+
+Write creates parent directories automatically — no need for mkdir -p first.
+
+## Pattern 7: Project Structure Overview
+
+Get a quick lay of the land:
+
+```ruby
+# List top-level structure
+Read.new.call(path: "/project")
+
+# Count files by type
+Bash.new.call(command: "find . -name '*.rb' | sed 's/.*\\.//' | sort | uniq -c | sort -rn", workdir: "/project")
+
+# List all models or controllers
+Glob.new.call(pattern: "app/models/**/*.rb", path: "/project")
+Glob.new.call(pattern: "app/controllers/**/*.rb", path: "/project")
+```
+
+## Pattern 8: Search with Exclusions
+
+To exclude test directories or vendor code:
+
+```ruby
+# Grep already excludes .git, node_modules, vendor, .bundle, tmp, log
+# For additional exclusions, use Bash:
+Bash.new.call(
+  command: "grep -rn 'search_term' app/ lib/ --include='*.rb' | grep -v '_spec.rb' | head -50",
+  workdir: "/project"
+)
+```
+
+## Pattern 9: Sequential File Processing
+
+When you need to apply the same pattern across multiple files:
+
+```ruby
+# Step 1: Find the files
+result = Glob.new.call(pattern: "app/views/**/*.erb", path: "/project")
+
+# Step 2: Search for the pattern you need to understand
+Grep.new.call(pattern: "data-controller", path: "/project", include: "*.erb")
+```
+
+## Efficiency Guide
+
+| Task | Best Tool | Why |
+|------|-----------|-----|
+| Find files by name pattern | Glob | Fast, sorted newest first |
+| Search file contents | Grep | Pattern-aware, excludes cruft |
+| Read small files | Read | Line numbers, truncation-safe |
+| Read large files | Read (offset/limit) | Navigate in chunks |
+| Complex shell queries | Bash | Full shell power |
+| Ad-hoc Ruby checks | Code | Direct Ruby execution |
+| Make changes | Edit | Exact string replacement |
+| Create files | Write | Mkdir-p + write in one |

data/lib/ask/tools/shell/bash.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
-require "open3"
-require "tempfile"
-require "stringio"
-require "tmpdir"
+require "ask-sandbox-providers"
 
 module Ask
   module Tools
     # Execute shell commands in a sandboxed environment.
-    # Returns stdout, stderr, exit code, and a timed_out flag.
-    # Output is truncated to 100KB.
+    # Runs via Ask::Sandbox.provider (Local by default, configurable for
+    # stronger isolation via Docker, Daytona, or Cloudflare).
     class Bash < Ask::Tool
       description "Execute a bash command in a sandboxed environment. " \
                    "Returns stdout, stderr, and exit code. " \
@@ -19,59 +16,26 @@ module Ask
       param :timeout, type: :integer, desc: "Timeout in seconds", required: false
       param :workdir, type: :string, desc: "Working directory", required: false
 
-      MAX_OUTPUT_SIZE = 102_400
-
       def execute(command:, timeout: 30, workdir: nil)
-        Dir.mktmpdir("ask_bash") do |dir|
-          workdir ||= dir
-
-          stdout = StringIO.new
-          stderr = StringIO.new
-          timed_out = false
-          exit_code = -1
-
-          begin
-            Open3.popen3("bash", "-c", command, chdir: workdir) do |stdin, out, err, wait_thr|
-              stdin.close
-
-              threads = [
-                Thread.new { IO.copy_stream(out, stdout) rescue nil },
-                Thread.new { IO.copy_stream(err, stderr) rescue nil }
-              ]
-
-              unless wait_thr.join(timeout)
-                Process.kill("-KILL", wait_thr.pid) rescue nil
-                timed_out = true
-              end
-
-              threads.each(&:join)
-              exit_code = timed_out ? -1 : wait_thr.value.exitstatus
-            end
-          rescue => e
-            return Ask::Result.error(message: "Bash execution failed: #{e.message}",
-                                     metadata: { stdout: stdout.string, stderr: stderr.string })
-          end
-
-          out_text = stdout.string
-          err_text = stderr.string
-
-          if out_text.length > MAX_OUTPUT_SIZE
-            header = "[Output truncated to #{MAX_OUTPUT_SIZE / 1024}KB]\n"
-            out_text = "#{header}#{out_text[-(MAX_OUTPUT_SIZE - header.length)..]}"
-          end
-
-          if err_text.length > MAX_OUTPUT_SIZE
-            header = "[Error output truncated to #{MAX_OUTPUT_SIZE / 1024}KB]\n"
-            err_text = "#{header}#{err_text[-(MAX_OUTPUT_SIZE - header.length)..]}"
-          end
-
-          Ask::Result.ok(data: {
-            stdout: out_text,
-            stderr: err_text,
-            exit_code: exit_code,
-            timed_out: timed_out
-          })
+        result = Ask::Sandbox.provider.call(
+          command,
+          timeout: timeout,
+          workdir: workdir
+        )
+
+        if result.timed_out
+          return Ask::Result.error(
+            message: "Command timed out",
+            metadata: { stdout: result.stdout, stderr: result.stderr }
+          )
         end
+
+        Ask::Result.ok(data: {
+          stdout: result.stdout,
+          stderr: result.stderr,
+          exit_code: result.exit_code,
+          timed_out: result.timed_out
+        })
       end
     end
   end

data/lib/ask/tools/shell/code.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "open3"
-require "tmpdir"
+require "ask-sandbox-providers"
 
 module Ask
   module Tools
     # Write and execute Ruby code in a subprocess.
-    # Runs in a temp directory via ruby -e.
+    # Runs via Ask::Sandbox.provider (Local by default, configurable for
+    # stronger isolation via Docker, Daytona, or Cloudflare).
     class Code < Ask::Tool
       description "Write and execute Ruby code in a subprocess. " \
                    "Returns stdout, stderr, and exit code. " \
@@ -14,45 +14,24 @@ module Ask
 
       param :code, type: :string, desc: "Ruby source code to execute", required: true
 
-      MAX_OUTPUT_SIZE = 102_400
-
       def execute(code:)
-        Dir.mktmpdir("ask_code") do |_dir|
-          stdout = StringIO.new
-          stderr = StringIO.new
-          exit_code = -1
-
-          begin
-            Open3.popen3("ruby", "-e", code, chdir: Dir.pwd) do |stdin, out, err, wait_thr|
-              stdin.close
-
-              threads = [
-                Thread.new { IO.copy_stream(out, stdout) rescue nil },
-                Thread.new { IO.copy_stream(err, stderr) rescue nil }
-              ]
-
-              threads.each(&:join)
-              exit_code = wait_thr.value.exitstatus
-            end
-          rescue => e
-            return Ask::Result.error(message: "Code execution failed: #{e.message}",
-                                     metadata: { stdout: stdout.string, stderr: stderr.string })
-          end
-
-          out_text = stdout.string
-          err_text = stderr.string
-
-          if out_text.length > MAX_OUTPUT_SIZE
-            header = "[Output truncated to #{MAX_OUTPUT_SIZE / 1024}KB]\n"
-            out_text = "#{header}#{out_text[-(MAX_OUTPUT_SIZE - header.length)..]}"
-          end
-
-          Ask::Result.ok(data: {
-            stdout: out_text,
-            stderr: err_text,
-            exit_code: exit_code
-          })
+        result = Ask::Sandbox.provider.call(
+          ["ruby", "-e", code],
+          timeout: 30
+        )
+
+        if result.timed_out
+          return Ask::Result.error(
+            message: "Code execution timed out",
+            metadata: { stdout: result.stdout, stderr: result.stderr }
+          )
         end
+
+        Ask::Result.ok(data: {
+          stdout: result.stdout,
+          stderr: result.stderr,
+          exit_code: result.exit_code
+        })
       end
     end
   end

data/lib/ask/tools/shell/version.rb

@@ -3,7 +3,7 @@
 module Ask
   module Tools
     module Shell
-      VERSION = "0.1.0"
+      VERSION = "0.2.1"
     end
   end
 end

data/lib/ask/tools/shell.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
 
+require_relative "shell/version"
+require_relative "shell/bash"
+require_relative "shell/read"
+require_relative "shell/write"
+require_relative "shell/edit"
+require_relative "shell/glob"
+require_relative "shell/grep"
+require_relative "shell/code"
+
 module Ask
   module Tools
-    # Collection point for shell tools.
-    #
-    #   Ask::Tools::Shell.all  # => [Bash, Read, Write, ...] instances
-    #
     module Shell
       TOOLS = [Bash, Read, Write, Edit, Glob, Grep, Code].freeze
-
-      # Return an instance of every registered shell tool.
-      #
-      # @return [Array<Ask::Tool>]
-      def self.all
-        TOOLS.map(&:new)
-      end
     end
   end
 end

data/lib/ask-tools-shell.rb

@@ -1,13 +1,4 @@
 # frozen_string_literal: true
 
 require "ask-tools"
-
-require_relative "ask/tools/shell/version"
-require_relative "ask/tools/shell/bash"
-require_relative "ask/tools/shell/read"
-require_relative "ask/tools/shell/write"
-require_relative "ask/tools/shell/edit"
-require_relative "ask/tools/shell/glob"
-require_relative "ask/tools/shell/grep"
-require_relative "ask/tools/shell/code"
-require_relative "ask/tools/shell"
+require "ask/tools/shell"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-tools-shell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kaka Ruto
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ask-sandbox-providers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ files:
 - LICENSE
 - README.md
 - lib/ask-tools-shell.rb
+- lib/ask/skills/shell.patterns/SKILL.md
 - lib/ask/tools/shell.rb
 - lib/ask/tools/shell/bash.rb
 - lib/ask/tools/shell/code.rb