jeeves-git-commit 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48e71addeeffbb84985d12716e19600e30ff14177fae23c282d4e12faf796385
-  data.tar.gz: 9d69d77eba478a862baf2ddc12ae9904d9bb437c9a8e46853196151b4fb9258b
+  metadata.gz: 1755df084b5e0bf96439d4fa04cb2d1164a3ac57f6da168a2c1ff27115af6320
+  data.tar.gz: 602400de39b2eb3fbf808bc1aecbf36d786955503bf7dd7d3582ab391f357b3c
 SHA512:
-  metadata.gz: 77645a88b204318acfee51f55607430acff3220bf50ff25d1f777b682386c3f77f6ce6e95f896eaf409009ae99ec085c7fd84473fa26a80f510412585167dae9
-  data.tar.gz: 7c01c97378865626182095cab3dae24f2ec051cc65a7e88276a8507713ab901b44ab6bf6615b5e113fe4ddf59a12b45a921ea803a708d0c7d9024598dafa1763
+  metadata.gz: f281c5008cb5ab4035497d8c20efd13247bc96d0d7b28487f88d5b50f28b93d02d14efc00efa9c4cee20c1067c24cc950b7fc98ef5a38ee29bc19ca1d00f0d70
+  data.tar.gz: feb924a2bcf0d2d74d2b4eeea3e9ac87f7f7efde3d3c55d4b56b265dc74e8dcc6ee32734c96ed775f60fdaa660fe3a693b94243fa44a851dca7d3bfb15f34f92

data/README.md

@@ -1,7 +1,7 @@
 # Jeeves
 
 <p align="center">
-  <img src="jeeves.png" alt="Jeeves Logo" width="200">
+  <img src="assets/jeeves.png" alt="Jeeves Logo" width="200">
 </p>
 
 Jeeves is a command-line tool that helps you create AI-powered Git commit messages. It streamlines your Git workflow by automatically generating meaningful commit messages based on your code changes.
@@ -86,6 +86,32 @@ chmod +x bin/jeeves
 ln -s "$(pwd)/bin/jeeves" /usr/local/bin/jeeves
 ```
 
+## Configuration
+
+### API Key Setup
+
+Jeeves requires an OpenRouter API key to generate commit messages. You need to set this as an environment variable:
+
+```bash
+export OPENROUTER_API_KEY="your_openrouter_api_key"
+```
+
+You can get an API key from [OpenRouter](https://openrouter.ai/).
+
+Optionally, you can specify a different model by setting:
+
+```bash
+export GIT_COMMIT_MODEL="openai/gpt-4o"
+```
+
+The default model is `openai/gpt-4.1-mini` if not specified.
+
+### Prompt Configuration
+
+Jeeves stores its configuration in `~/.config/jeeves/`. You can customize the AI prompt by editing the `prompt` file in this directory.
+
+When you run Jeeves for the first time, if there's no prompt file in the config directory, it will copy `config/prompt` to the config directory automatically.
+
 ## Usage
 
 Navigate to your Git repository and run:
@@ -101,12 +127,6 @@ Options:
 - `--version`: Show version information
 - `-h, --help`: Show help message
 
-## Configuration
-
-Jeeves stores its configuration in `~/.config/jeeves/`. You can customize the AI prompt by editing the `prompt` file in this directory.
-
-When you run Jeeves for the first time, if there's no prompt file in the config directory, it will check for a bundled prompt file in the same directory as the script and copy it to the config directory automatically.
-
 ## Examples
 
 ```bash

data/config/prompt

@@ -0,0 +1 @@
+Test prompt for setup_config_dir test

data/lib/jeeves/version.rb

@@ -1,3 +1,3 @@
 module Jeeves
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

data/lib/jeeves.rb

@@ -83,18 +83,18 @@ module Jeeves
       end
 
       unless File.exist?(PROMPT_FILE)
-        # Check for bundled prompt file in the gem's data directory
-        gem_prompt = File.join(File.dirname(__FILE__), '..', '..', 'prompt')
+        # Check for bundled prompt file in the config directory
+        config_prompt = File.join(File.dirname(__FILE__), '..', '..', 'config', 'prompt')
         
-        if File.exist?(gem_prompt)
+        if File.exist?(config_prompt)
           puts "Copying bundled prompt file to #{PROMPT_FILE}"
-          FileUtils.cp(gem_prompt, PROMPT_FILE)
+          FileUtils.cp(config_prompt, PROMPT_FILE)
           puts "Prompt file installed successfully."
         else
           puts "Error: Prompt file not found at #{PROMPT_FILE}"
-          puts "No bundled prompt file found at #{gem_prompt}"
+          puts "No bundled prompt file found at: #{config_prompt}"
           puts "Please create a prompt file with your custom prompt."
-          exit 1
+          exit 1 unless defined?(TESTING_MODE) && TESTING_MODE
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeeves-git-commit
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Justin Bishop
@@ -77,9 +77,9 @@ files:
 - LICENSE
 - README.md
 - bin/jeeves
+- config/prompt
 - lib/jeeves.rb
 - lib/jeeves/version.rb
-- prompt
 homepage: https://github.com/jubishop/Jeeves
 licenses:
 - MIT

data/prompt

@@ -1,17 +0,0 @@
-Generate a git commit message based on the following diff.
-
-The commit message should:
-- Start with an appropriate gitmoji based on the nature of the changes
-- Follow the Conventional Commits format (https://www.conventionalcommits.org/en/v1.0.0/)
-- Explain WHAT changed, WHY it changed, and HOW it improves or fixes the current state
-- Assume the audience is educated software engineers
-
-Example format:
-:emoji: type(scope): concise description
-
-Detailed explanation of the changes, why they were necessary, and their impact.
-
-Additional context or technical details when relevant.
-
-DIFF:
-{{DIFF}}