commitgpt 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a73fe2965f7f3fedb44a5173fcd2dfb888c909c3ea275bed72ae1474f6bfe7cc
-  data.tar.gz: 22388d33280bd6c90a4febff1964eab35b558befc777465374b420567d080e35
+  metadata.gz: 550cd13670cec1d792df268d54b8c511ca528bb498377a9789bb265acb8a55a5
+  data.tar.gz: 6cbf6bb2c24376cca893409b6af23879225e61c02111c2cba656eac361b60da9
 SHA512:
-  metadata.gz: 5d0af4dacb622f9c893bafadf5bafe45a48fdd7664a29c804e122ae9cddafea13d7d8a61a0345215cffe6552e15ba4e8e6d0888515a12527b7e79f7305a3e238
-  data.tar.gz: bc785e338d404f12f8d6e5b94659ae4aa8dc9301507722ec78b73f7f85ea7824e2e8ce718563fa5a1cf69c1c56d62e0ad8cb8f66646418b56865ebc9a061be4a
+  metadata.gz: e835710e43929f73e491ec963c37e37763f0d620e5711d746db4ea066110e012edbeef6ff8d2dd849e0dcd443a131dfcb31654aeb2438f7386e2d4568ec80fba
+  data.tar.gz: 34c20bf93a7fe6553b74706fb32b7be50c875471a535d1abebaffd768dd14ddfb235dc58887b5028f500e65a560486aa8309e87c93e4424a3ee86c76fd04b876

data/Gemfile

@@ -5,6 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in commitgpt.gemspec
 gemspec
 
+gem "base64"
+gem "bigdecimal"
+gem "csv"
 gem "httparty"
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    commitgpt (0.1.2)
+    commitgpt (0.2.0)
       httparty (~> 0.18)
       thor (~> 1.2)
 
@@ -9,6 +9,9 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
+    csv (3.3.5)
     diff-lcs (1.5.0)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
@@ -52,10 +55,14 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-25
   x86_64-darwin-22
 
 DEPENDENCIES
+  base64
+  bigdecimal
   commitgpt!
+  csv
   httparty
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -13,15 +13,42 @@ $ gem install commitgpt
 ```
 
 ## Usage
-### API key
-grab your [OpenAI key](https://openai.com/api/) and add it as an env variable.
+
+### API Key
+Grab your API key and add it as an env variable.
+```bash
+$ export AICM_KEY=sk-xxxxxxxxxxxxxxxx
+```
+
+It's recommended to add this to your `.zshrc` or `.bashrc` so it persists across terminal sessions.
+
+### Custom API Endpoint (Optional)
+You can use any OpenAI-compatible API provider by setting `AICM_LINK`:
+```bash
+# Use a local proxy
+$ export AICM_LINK=http://127.0.0.1:8045/v1
+
+# Or use another provider
+# Cerebras
+$ export AICM_LINK=https://api.cerebras.ai/v1
+
+# Groq
+$ export AICM_LINK=https://api.groq.com/openai/v1
+```
+
+> **Note**: If you're using a local proxy that doesn't require authentication, you can leave `AICM_KEY` empty.
+
+### List Models
+Use `-m` to list all available models from your API provider:
 ```bash
-$ export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx
+$ aicm -m
+llama3.1-8b
+llama-3.3-70b
+gpt-4o-mini
 ```
-It's recommended to add the first line to your `.zshrc` or `.bashrc` so it persists instead of having to define it in each terminal session.
-    
+
 ### aicm
-`aicm` is an abbreviation for `AI commits`, after `git add .` add your file to stage, then use `aicm` to commit with an AI generated commit message.
+`aicm` is an abbreviation for `AI commits`. After staging your changes with `git add .`, use `aicm` to commit with an AI-generated message.
 ```bash
 $ cd /path/to/your/repo
 $ git add .
@@ -37,24 +64,77 @@ $ aicm
  4 files changed, 24 insertions(+), 19 deletions(-)
 ```
 
-## Special Thanks
-I used chatGPT to convert `AICommits`(JS) to `CommitGPT`(Ruby). Thanks to [https://github.com/Nutlope/aicommits](https://github.com/Nutlope/aicommits)   
+### Update
+To update to the latest version:
+```bash
+$ gem update commitgpt
+$ gem cleanup commitgpt
+$ gem info commitgpt
+```
+
+## Configuration
+
+| Environment Variable | Required | Default | Description |
+|---------------------|----------|---------|-------------|
+| `AICM_KEY` | No* | `nil` | Your API key. Required when using official OpenAI API. |
+| `AICM_LINK` | No | `https://api.openai.com/v1` | Custom API endpoint for OpenAI-compatible services. |
+| `AICM_MODEL` | Yes | `gpt-4o-mini` | Model to use for generating commit messages. |
+| `AICM_DIFF_LEN` | No | `32768` | Maximum diff length in characters. Increase if you have large diffs. |
+
+\* Required when using the default OpenAI endpoint.
 
-## How it works
-This CLI tool runs a git diff command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. I also want to note that it does cost money since GPT-3 generations aren't free. However, OpenAI gives folks $18 of free credits and commit message generations are cheap so it should be free for a long time.
+### Available Models
+
+Use `aicm -m` to list models from your provider, or set `AICM_MODEL` directly:
+
+**OpenAI** ([https://api.openai.com/v1](https://platform.openai.com))
+```
+gpt-5.2 
+gpt-5-mini 
+gpt-5-nano 
+gpt-4o-mini
+```
+
+**Cerebras** ([https://api.cerebras.ai/v1](https://cloud.cerebras.ai))
+```
+zai-glm-4.6
+zai-glm-4.7
+gpt-oss-120b
+llama3.1-8b
+llama-3.3-70b
+qwen-3-32b
+qwen-3-235b-a22b-instruct-2507
+
+```
+
+**Groq** ([https://api.groq.com/openai/v1](https://console.groq.com))
+```
+llama-3.3-70b-versatile
+llama-3.1-8b-instant
+meta-llama/llama-4-maverick-17b-128e-instruct
+meta-llama/llama-4-scout-17b-16e-instruct
+qwen/qwen3-32b
+moonshotai/kimi-k2-instruct-0905
+openai/gpt-oss-120b
+groq/compound
+groq/compound-mini
+```
+
+## How It Works
+This CLI tool runs a `git diff` command to grab all staged changes, sends this to OpenAI's GPT API (or compatible endpoint), and returns an AI-generated commit message. The tool uses the `/v1/chat/completions` endpoint with optimized prompts for generating conventional commit messages.
 
 ## Limitations
-Only supports git diffs of up to 200 lines of code for now
-The generated commit message can't be edited yet, but you can choose `n` and copy the commit command and edit it manually.
+- Only supports git diffs up to `AICM_DIFF_LEN` characters (default 32K)
+- The generated commit message can't be edited interactively, but you can choose `n` and copy the command to edit manually
 
-## Contributing
+## Special Thanks
+I used ChatGPT to convert `AICommits` from TypeScript to Ruby. Special thanks to [https://github.com/Nutlope/aicommits](https://github.com/Nutlope/aicommits)
 
+## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/ZPVIP/commitgpt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ZPVIP/commitgpt/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
-
 Everyone interacting in the CommitGpt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ZPVIP/commitgpt/blob/master/CODE_OF_CONDUCT.md).

data/lib/commitgpt/cli.rb

@@ -9,8 +9,14 @@ module CommitGpt
     default_task :aicm
 
     desc "aicm", "AI commits for you!"
+    method_option :models, aliases: "-m", type: :boolean, desc: "List available models"
+    method_option :verbose, aliases: "-v", type: :boolean, desc: "Show git diff being sent to AI"
     def aicm
-      CommitGpt::CommitAi.new.aicm
+      if options[:models]
+        CommitGpt::CommitAi.new.list_models
+      else
+        CommitGpt::CommitAi.new.aicm(verbose: options[:verbose])
+      end
     end
   end
 end

data/lib/commitgpt/commit_ai.rb

@@ -9,14 +9,39 @@ require_relative "string"
 module CommitGpt
   # Commit AI roboter based on GPT-3
   class CommitAi
-    OPENAI_API_KEY = ENV.fetch("OPENAI_API_KEY", nil)
-    def aicm
+    AICM_KEY = ENV.fetch("AICM_KEY", nil)
+    AICM_LINK = ENV.fetch("AICM_LINK", "https://api.openai.com/v1")
+    AICM_DIFF_LEN = ENV.fetch("AICM_DIFF_LEN", "32768").to_i
+    AICM_MODEL = ENV.fetch("AICM_MODEL", "gpt-4o-mini")
+
+    def aicm(verbose: false)
       exit(1) unless welcome
       diff = git_diff || exit(1)
+      if verbose
+        puts "▲ Git diff (#{diff.length} chars):".cyan
+        puts diff
+        puts "\n"
+      end
       ai_commit_message = message(diff) || exit(1)
       puts `git commit -m "#{ai_commit_message}" && echo && echo && git log -1 && echo` if confirmed
     end
 
+    def list_models
+      headers = {
+        "Content-Type" => "application/json",
+        "User-Agent" => "Ruby/#{RUBY_VERSION}"
+      }
+      headers["Authorization"] = "Bearer #{AICM_KEY}" if AICM_KEY
+
+      begin
+        response = HTTParty.get("#{AICM_LINK}/models", headers: headers)
+        models = response["data"] || []
+        models.each { |m| puts m["id"] }
+      rescue StandardError => e
+        puts "▲ Failed to list models: #{e.message}".red
+      end
+    end
+
     private
 
     def confirmed
@@ -31,12 +56,8 @@ module CommitGpt
     end
 
     def message(diff = nil)
-      prompt = "I want you to act like a git commit message writer. I will input a git diff and your job is to convert it into a useful " \
-               "commit message. Do not preface the commit with anything, use the present tense, return a complete sentence, " \
-               "and do not repeat yourself: #{diff}"
-
       puts "▲   Generating your AI commit message...\n".gray
-      ai_commit_message = generate_commit(prompt)
+      ai_commit_message = generate_commit(diff)
       return nil if ai_commit_message.nil?
 
       puts "#{"▲ Commit message: ".green}git commit -am \"#{ai_commit_message}\"\n\n"
@@ -51,9 +72,8 @@ module CommitGpt
         return nil
       end
 
-      # Accounting for GPT-3's input req of 4k tokens (approx 8k chars)
-      if diff.length > 8000
-        puts "▲ The diff is too large to write a commit message.".red
+      if diff.length > AICM_DIFF_LEN
+        puts "▲ The diff is too large (#{diff.length} chars, max #{AICM_DIFF_LEN}). Set AICM_DIFF_LEN to increase limit.".red
         return nil
       end
 
@@ -63,8 +83,8 @@ module CommitGpt
     def welcome
       puts "\n▲ Welcome to AI Commits!".green
 
-      if OPENAI_API_KEY.nil?
-        puts "▲ Please save your OpenAI API key as an env variable by doing 'export OPENAI_API_KEY=YOUR_API_KEY'".red
+      if AICM_KEY.nil? && AICM_LINK == "https://api.openai.com/v1"
+        puts "▲ Please save your API key as an env variable by doing 'export AICM_KEY=YOUR_API_KEY'".red
         return false
       end
 
@@ -78,27 +98,63 @@ module CommitGpt
       true
     end
 
-    def generate_commit(prompt = "")
+    def generate_commit(diff = "")
+      messages = [
+        {
+          role: "system",
+          content: "Generate a concise git commit message title in present tense that precisely describes the key changes in the following code diff. Focus on what was changed, not just file names. Provide only the title, no description or body. " \
+                   "Message language: English. Rules:\n" \
+                   "- Commit message must be a maximum of 100 characters.\n" \
+                   "- Exclude anything unnecessary such as translation. Your entire response will be passed directly into git commit.\n" \
+                   "- IMPORTANT: Do not include any explanations, introductions, or additional text. Do not wrap the commit message in quotes or any other formatting. The commit message must not exceed 100 characters. Respond with ONLY the commit message text. \n" \
+                   "- Be specific: include concrete details (package names, versions, functionality) rather than generic statements. \n" \
+                   "- Return ONLY the commit message, nothing else."
+        },
+        {
+          role: "user",
+          content: "Generate a commit message for the following git diff:\n\n#{diff}"
+        }
+      ]
+
       payload = {
-        model: "text-davinci-003", prompt: prompt, temperature: 0.7, top_p: 1,
-        frequency_penalty: 0, presence_penalty: 0, max_tokens: 200, stream: false, n: 1
+        model: AICM_MODEL,
+        messages: messages,
+        temperature: 0.7,
+        max_tokens: 300,
+        disable_reasoning: true
       }
 
       begin
-        response = HTTParty.post("https://api.openai.com/v1/completions",
-                                 headers: { "Authorization" => "Bearer #{OPENAI_API_KEY}",
-                                            "Content-Type" => "application/json", "User-Agent" => "Ruby/#{RUBY_VERSION}" },
+        headers = {
+          "Content-Type" => "application/json",
+          "User-Agent" => "Ruby/#{RUBY_VERSION}"
+        }
+        headers["Authorization"] = "Bearer #{AICM_KEY}" if AICM_KEY
+
+        response = HTTParty.post("#{AICM_LINK}/chat/completions",
+                                 headers: headers,
                                  body: payload.to_json)
 
-        puts "#{response.inspect}\n"
-
-        ai_commit = response["choices"][0]["text"]
-      rescue StandardError
-        puts "▲ There was an error with the OpenAI API. Please try again later.".red
+        # Check for API error response
+        if response["error"]
+          puts "▲ API Error: #{response['error']['message']}".red
+          return nil
+        end
+
+        message = response.dig("choices", 0, "message")
+        # Some models (like zai-glm) use 'reasoning' instead of 'content'
+        ai_commit = message&.dig("content") || message&.dig("reasoning")
+        if ai_commit.nil?
+          puts "▲ Unexpected API response format:".red
+          puts response.inspect
+          return nil
+        end
+      rescue StandardError => e
+        puts "▲ Error: #{e.message}".red
         return nil
       end
 
-      ai_commit.gsub(/(\r\n|\n|\r)/, "")
+      ai_commit.gsub(/(\r\n|\n|\r)/, "").gsub(/\A["']|["']\z/, "")
     end
   end
 end

data/lib/commitgpt/string.rb

@@ -17,4 +17,8 @@ class String
   def magenta
     "\e[35m#{self}\e[0m"
   end
+
+  def cyan
+    "\e[36m#{self}\e[0m"
+  end
 end

data/lib/commitgpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommitGpt
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: commitgpt
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Peng Zhang
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -70,7 +69,6 @@ metadata:
   homepage_uri: https://github.com/ZPVIP/commitgpt
   source_code_uri: https://github.com/ZPVIP/commitgpt
   changelog_uri: https://github.com/ZPVIP/commitgpt/blob/master/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A CLI AI that writes git commit messages for you.
 test_files: []