genie_cli 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4582658de3ff1e9145b81a2975b973f7aebbc1762f8d7a21bb6237c211225558
-  data.tar.gz: 79b2870a69918c5c7eba6a72ca1a8d5e5284392304c39833cf61f74e19686eae
+  metadata.gz: f9431dda686ce68a45532465d2d0f75baabb62e7dee4dc5278d51cdbd0cf00b7
+  data.tar.gz: 86a77baeb167e1bdf058d020368a9069599f44c69fee4d290830bc02fb83cf96
 SHA512:
-  metadata.gz: eaf263a55c387b7e021afbc3dd161d47e38307ccf09a6ec5bfd952237f739bb74720fe23efcfd5873030d7bcc1af11540198c760f99438254562aabb39002f3f
-  data.tar.gz: 5e1cac00335cc946e3bbcbe04f2b6017861033186810523ac33e40ab56f763d28ba73d6b1cedbdaca755a3737aeb0048140d789ab8e43fac34ec243cab8093dc
+  metadata.gz: 8cc795dbe839e79b4e2d859051f2bb7c7fdcbaad70c50d17ded96d581aca5fe15cf2482c6d13fd39657f35872e0f997deb7a1bda4f54ad9b89c619600508cffa
+  data.tar.gz: d9a87bb13bfd5e679baa1934904c348e6e957b7737211c06992d85439e1740cc52e2be77cd5820fd47279d5c04ae5c4582266e6df29afa906e812b8206f3879d

data/README.md

@@ -1,9 +1,9 @@
 # Genie CLI
 
-Genie CLI is a command-line tool that brings Test Driven Development (TDD) 
-principles to life by integrating with a large language model (LLM) through 
-the `ruby_llm` library. It provides an interactive session where you can ask 
-the AI assistant to write tests, implement code, and manage your codebase—all 
+Genie CLI is a command-line tool that brings Test Driven Development (TDD)
+principles to life by integrating with a large language model (LLM) through
+the `ruby_llm` library. It provides an interactive session where you can ask
+the AI assistant to write tests, implement code, and manage your codebase—all
 while enforcing a strict TDD workflow.
 
 ## Features
@@ -23,33 +23,33 @@ while enforcing a strict TDD workflow.
 
 ## Installation
 
-1. Clone this repository:
-   ```bash
-   git clone https://github.com/jeffmcfadden/genie_cli.git
-   cd genie_cli
-   ```
+1.  Install the gem:
+    ```bash
+    gem install genie_cli
+    ```
 
-2. Install dependencies using Bundler:
-   ```bash
-   bundle install
-   ```
+2.  Set your OpenAI API key (or other LLM provider keys) in your environment:
+    ```bash
+    export OPENAI_API_KEY="your_api_key_here"
+    ```
+    
+    `dotenv` is also supported:
 
-3. Set your OpenAI API key (or other LLM provider keys) in your environment:
-   ```bash
-   export OPENAI_API_KEY="your_api_key_here"
-   ```
-
-4. Make the CLI executable:
-   ```bash
-   chmod +x bin/genie
-   ```
+    ```
+    # .env
+    OPENAI_API_KEY="your_api_key_here"
+    ```
 
 ## Usage
 
 Start a Genie session by running the `genie` command from the root of your project:
 
 ```bash
-./bin/genie ["initial prompt or command"]
+genie "initial prompt or command"
+```
+If you are using Bundler, you can run:
+```bash
+bundle exec genie "initial prompt or command"
 ```
 
 - If you provide an initial prompt, the assistant will immediately respond. Otherwise, you'll enter an interactive prompt where you can type your questions or commands.
@@ -58,7 +58,7 @@ Start a Genie session by running the `genie` command from the root of your proje
 Example session:
 
 ```bash
-$ ./bin/genie
+$ genie
 Starting a new session with:
  base_path: /Users/you/projects/genie_cli
 
@@ -81,14 +81,14 @@ Total Conversation Tokens: 1234
 
 ## Logging
 
-The output of `genie` to the terminal includes "essential" output, but not 
-_all_ output. To aid in debugging, the full RubyLLM debug log is saved to 
-`ruby_llm.log`. This can be useful for auditing what's happened during a 
+The output of `genie` to the terminal includes "essential" output, but not
+_all_ output. To aid in debugging, the full RubyLLM debug log is saved to
+`ruby_llm.log`. This can be useful for auditing what's happened during a
 session in great detail.
 
 ## Configuration
 
-Configuration is available via a `genie.yml` file in the project root.
+Configuration is available via a `genie.yml`.
 
 ## Testing
 
@@ -105,3 +105,14 @@ Contributions are welcome! Please fork the repository and open pull requests for
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Why "Genie"?
+
+[Kent Beck](https://tidyfirst.substack.com) has been using this term to 
+describe LLMs, especially coding agents, because it grants your wishes, but 
+rarely in the way you actually wanted it to. It's a great idea, so I'm 
+shamelessly stealing it.
+
+## The Lamp
+
+From https://www.asciiart.website/index.php?art=movies%2Faladdin

data/lib/genie/session.rb

@@ -15,7 +15,11 @@ module Genie
     def initialize(config:)
       @config = config
 
-      Genie.output "Starting a new session with:\n base_path: #{base_path}\n model: #{model}\n", color: :green
+      Genie.output genie_lamp, color: :yellow, include_genie_icon: false
+
+      Genie.output "Your wish is my command!", color: :magenta
+      Genie.output "   base_path: #{base_path}", color: :cyan, include_genie_icon: false
+      Genie.output "   model: #{model}", color: :cyan, include_genie_icon: false
 
       # Initialize the LLM chat with the specified model
       @chat = RubyLLM.chat(model: model)
@@ -79,5 +83,31 @@ module Genie
       exit
     end
 
+    private
+
+    def genie_lamp
+      <<-LAMP
+                                          ..
+                                         dP/$.
+                                         $4$$%
+                                       .ee$$ee.
+                                    .eF3??????$C$r.        .d$$$$$$$$$$$e.
+ .zeez$$$$$be..                    JP3F$5'$5K$?K?Je$.     d$$$FCLze.CC?$$$e
+     """??$$$$$$$$ee..         .e$$$e$CC$???$$CC3e$$$$.  $$$/$$$$$$$$$.$$$$
+            `"?$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$b $$"$$$$P?CCe$$$$$F
+                 "?$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$b$$J?bd$$$$$$$$$F"
+                     "$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$d$$F"
+                        "?$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$"...
+                            "?$$$$$$$$$$$$$$$$$$$$$$$$$F "$$"$$$$b
+                                "?$$$$$$$$$$$$$$$$$$F"     ?$$$$$F
+                                     ""????????C"
+                                     e$$$$$$$$$$$$.
+                                   .$b CC$????$$F3eF
+                                 4$bC/%$bdd$b@$Pd??Jbbr
+                                   ""?$$$$eeee$$$$F?"
+
+      LAMP
+    end
+
   end
 end

data/lib/genie/session_config.rb

@@ -1,10 +1,8 @@
-require 'yaml'
-
 module Genie
   # Handles loading of session configuration such as run_tests_cmd
   class SessionConfig
     # Read-only attributes
-    attr_reader :base_path, :run_tests_cmd, :model, :first_question, :instructions
+    attr_reader :base_path, :run_tests_cmd, :model, :first_question, :instructions, :ignore_paths
 
     DEFAULT_INSTRUCTIONS = <<~INSTRUCTIONS
       # Genie Instructions
@@ -24,7 +22,8 @@ module Genie
       run_tests_cmd: 'rake test',
       model: 'gpt-4o-mini',
       first_question: nil,
-      instructions: DEFAULT_INSTRUCTIONS
+      instructions: DEFAULT_INSTRUCTIONS,
+      ignore_paths: ['tmp', '/tmp'],
     }
 
     def self.from_argv(argv)
@@ -54,6 +53,10 @@ module Genie
           cli_options[:instructions] = text
         end
 
+        opts.on("--ignore-paths LIST", "Comma-separated paths to ignore") do |list|
+          cli_options[:ignore_paths] = list.split(',').map(&:strip)
+        end
+
         opts.on("-v", "--[no-]verbose", "Enable verbose mode") do |v|
           cli_options['verbose'] = v
         end
@@ -73,10 +76,10 @@ module Genie
       # We always preface the instructions with context
       final_config[:instructions] = <<~PREFACE
       # Context
-      Current Date and Time: #{Time.now.iso8601}
-      We are working in a codebase located at '#{final_config[:base_path]}'.
+      Current Date and Time: \\#{Time.now.iso8601}
+      We are working in a codebase located at '\\#{final_config[:base_path]}'.
 
-      #{final_config[:instructions]}
+      \\#{final_config[:instructions]}
       PREFACE
 
       new(
@@ -84,7 +87,8 @@ module Genie
         run_tests_cmd: final_config[:run_tests_cmd],
         model: final_config[:model],
         first_question: final_config[:first_question],
-        instructions: final_config[:instructions]
+        instructions: final_config[:instructions],
+        ignore_paths: final_config[:ignore_paths]
       )
     end
 
@@ -94,17 +98,18 @@ module Genie
         run_tests_cmd: DEFAULTS[:run_tests_cmd],
         model: DEFAULTS[:model],
         first_question: DEFAULTS[:first_question],
-        instructions: DEFAULTS[:instructions]
+        instructions: DEFAULTS[:instructions],
+        ignore_paths: DEFAULTS[:ignore_paths],
       )
     end
 
-    def initialize(base_path:, run_tests_cmd:, model:, first_question:, instructions:)    # Requires both base_path and run_tests_cmd
+    def initialize(base_path:, run_tests_cmd:, model:, first_question:, instructions:, ignore_paths:)  
       @base_path = File.expand_path(base_path)
       @run_tests_cmd = run_tests_cmd
       @model = model
       @first_question = first_question
       @instructions = instructions
+      @ignore_paths = ignore_paths
     end
-
   end
 end

data/lib/genie/version.rb

@@ -1,3 +1,3 @@
 module Genie
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 end

data/lib/genie.rb

@@ -32,9 +32,11 @@ RubyLLM.configure do |config|
 end
 
 module Genie
-  def self.output(s, color: :white)
+  def self.output(s, color: :white, include_genie_icon: true)
     return if quiet?
 
+    s = "🧞‍♂️ #{s}" if include_genie_icon
+
     # This method is used to output messages in a consistent format.
     # You can customize the color or format as needed.
     puts "\e[32m#{s}\e[0m" if color == :green

data/lib/tools/list_files.rb

@@ -8,6 +8,13 @@ module Genie
     param :recursive, desc: "Whether to list files recursively (default: false)"
     param :filter, desc: "Filter string to include only paths that include this substring (Optional)"
 
+    def initialize(base_path:, ignore_paths: [])
+      @base_path = base_path
+      @base_path.freeze
+
+      @ignore_paths = ignore_paths
+    end
+
     def execute(directory:, recursive: false, filter: nil)
       directory = File.expand_path(directory, @base_path)
 
@@ -22,6 +29,9 @@ module Genie
         listing = listing.select { |entry| entry[:name].include?(filter) }
       end
 
+      # Apply ignore paths
+      listing.reject! { |entry| @ignore_paths.any? { |ignore_path| entry[:name].gsub(@base_path, '').start_with?(ignore_path) } }
+
       Genie.output listing.map { |e| e[:name] }.join("\n") + "\n", color: :green
 
       listing

data/test/test_session_config.rb

@@ -1,14 +1,11 @@
-require_relative "test_helper"
-require 'tmpdir'
-
-class SessionConfigTest < TLDR
   def test_basic_session_config
     config = Genie::SessionConfig.new(
       base_path: "/my/cool/path",
       run_tests_cmd: "bundle exec testit",
       model: "gpt-4",
       first_question: "What is the meaning of life?",
-      instructions: "Default instructions"
+      instructions: "Default instructions",
+      ignore_paths: ['tmp']
     )
 
     assert_equal "/my/cool/path", config.base_path
@@ -16,40 +13,5 @@ class SessionConfigTest < TLDR
     assert_equal "gpt-4", config.model
     assert_equal "What is the meaning of life?", config.first_question
     assert config.instructions.include?("Default instructions")
+    assert_equal ['tmp'], config.ignore_paths
   end
-
-  def test_session_from_argv
-    argv = ["-c", "asdf.yml", "--base-path", "/tmp", "--run-tests", "rake test", "--model", "gpt-4o", "--instructions", "Command line instructions", "What is the meaning of life?"]
-    config = Genie::SessionConfig.from_argv(argv)
-
-    assert_equal "/tmp", config.base_path
-    assert_equal "rake test", config.run_tests_cmd
-    assert_equal "gpt-4o", config.model
-    assert_equal "What is the meaning of life?", config.first_question
-    assert config.instructions.include?("Command line instructions")
-  end
-
-  def test_session_from_config_file
-    argv = ["-c", "./test/data/sample_config.yml"]
-    config = Genie::SessionConfig.from_argv(argv)
-    expected_base_path = "/tmp/myapp/from_config"
-
-    assert_equal File.realpath(expected_base_path), File.realpath(config.base_path)
-    assert_equal "bundle exec tests_from_config_ex", config.run_tests_cmd
-    assert_equal "test_model_from_config", config.model
-    assert_equal nil, config.first_question
-    assert config.instructions.include?("Instructions from config file")
-  end
-
-  def test_default_instructions
-    config = Genie::SessionConfig.default
-    default_instructions = config.instructions
-    assert_includes default_instructions, "Genie coding assistant"
-    assert_includes default_instructions, "Test Driven Development"
-    assert_includes default_instructions, "tools available"
-    assert_includes default_instructions, "write tests first"
-    assert_includes default_instructions, "do not have access to any files outside"
-    assert_includes default_instructions, "do not have access to the internet"
-  end
-
-end

data/test/tools/test_list_files.rb

@@ -28,4 +28,17 @@ class TestListFiles < TLDR
 
     assert_equal expected, actual
   end
+
+  def test_list_files_with_ignore_paths
+    base_path = File.expand_path("../../", __dir__)
+    t = Genie::ListFiles.new(base_path: base_path, ignore_paths: ["a_dir"])
+
+    actual = t.execute(directory: "./test/data/sample_files")
+
+    expected = [{ name: "read_file_test.txt", type: "file" },
+                { name: "one.txt", type: "file" }]
+
+    assert_equal expected, actual
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: genie_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Jeff McFadden
 bindir: bin
 cert_chain: []
-date: 2025-06-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_llm
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CLI Coding Agent written in Ruby.
 test_files: []