genie_cli 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4582658de3ff1e9145b81a2975b973f7aebbc1762f8d7a21bb6237c211225558
-  data.tar.gz: 79b2870a69918c5c7eba6a72ca1a8d5e5284392304c39833cf61f74e19686eae
+  metadata.gz: ae88ad33211ea966ef1f55bf6da8497ba8f669e46bec8ed5bf51e70dfc62b0a8
+  data.tar.gz: 4f349cad129aee7c7f8e336a8f7e2846c13caf74a2381bef1e5797b683dbacaa
 SHA512:
-  metadata.gz: eaf263a55c387b7e021afbc3dd161d47e38307ccf09a6ec5bfd952237f739bb74720fe23efcfd5873030d7bcc1af11540198c760f99438254562aabb39002f3f
-  data.tar.gz: 5e1cac00335cc946e3bbcbe04f2b6017861033186810523ac33e40ab56f763d28ba73d6b1cedbdaca755a3737aeb0048140d789ab8e43fac34ec243cab8093dc
+  metadata.gz: 6c6dd37077b01500c8bed0e33180cc36ec706d4bbeb66b0d8dbe7e15ac4366f8166d681c3635151ecaa5de724aede4ed82e17b6ab340824140d36e0d7b174e9d
+  data.tar.gz: 5b8d9186b2528f3635d825842e6b98c8b7594e2e69fd680a417d5be231e121d630982d048766d2b4a3840cb16d1a0e695677a24086b407ab162d8db9b25980d0

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,6 +15,8 @@ module Genie
     def initialize(config:)
       @config = config
 
+      Genie.output genie_lamp, color: :yellow
+
       Genie.output "Starting a new session with:\n base_path: #{base_path}\n model: #{model}\n", color: :green
 
       # Initialize the LLM chat with the specified model
@@ -79,5 +81,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/version.rb

@@ -1,3 +1,3 @@
 module Genie
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 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.0
 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: []