commitgpt 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a73fe2965f7f3fedb44a5173fcd2dfb888c909c3ea275bed72ae1474f6bfe7cc
-  data.tar.gz: 22388d33280bd6c90a4febff1964eab35b558befc777465374b420567d080e35
+  metadata.gz: 39ba14207dd3a3821b77597f628a3a5eb5c4d350bac6f5aac1828feda130f7df
+  data.tar.gz: d03c824c7e5f6b31a3e16dc1175def59b85980da67e9767a643242ea5d65b1df
 SHA512:
-  metadata.gz: 5d0af4dacb622f9c893bafadf5bafe45a48fdd7664a29c804e122ae9cddafea13d7d8a61a0345215cffe6552e15ba4e8e6d0888515a12527b7e79f7305a3e238
-  data.tar.gz: bc785e338d404f12f8d6e5b94659ae4aa8dc9301507722ec78b73f7f85ea7824e2e8ce718563fa5a1cf69c1c56d62e0ad8cb8f66646418b56865ebc9a061be4a
+  metadata.gz: 84fed7c25c40981c4ac1c6d29e26c5260b3b79a59e7e7921aec5d0f176d826f07c06d21d354fd7168d3b0a0f17a9bcd834271d17cd5a2db0cf63964de02a4dd0
+  data.tar.gz: e443c012f0ddb35f03551a4d7b943dd207c5500f647e6cacf429f20e3ce1e6863eced86f9292232c7ce49a6aa6fb2d088e180d3c59b8bc268e24fd07d980b097

data/README.md

@@ -8,53 +8,271 @@
 ---
 
 ## Installation
+
+### Method 1: Homebrew (Recommended)
+
+The easiest way to install and keep CommitGPT updated.
+
+**Install:**
+
 ```bash
-$ gem install commitgpt
+brew tap ZPVIP/commitgpt https://github.com/ZPVIP/commitgpt
+brew install commitgpt
 ```
 
-## Usage
-### API key
-grab your [OpenAI key](https://openai.com/api/) and add it as an env variable.
+**Upgrade:**
+
+```bash
+brew update
+brew upgrade commitgpt
+```
+
+**Uninstall:**
+
+```bash
+brew uninstall commitgpt
+# Optional: Remove configuration files manually
+rm -rf ~/.config/commitgpt
+```
+
+### Method 2: RubyGems (For Ruby Developers)
+
+<details>
+<summary>Click to expand RubyGems installation instructions</summary>
+
+#### Prerequisites: Install Ruby
+
+If you don't have Ruby installed, follow these steps first.
+
+<details>
+<summary><strong>macOS</strong></summary>
+
+**1. Install Homebrew** (skip if already installed)
+
+```bash
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+echo 'export PATH="/opt/homebrew/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+**2. Install Ruby dependencies**
+
+```bash
+brew install openssl@3 libyaml gmp rust
+```
+
+</details>
+
+<details>
+<summary><strong>Ubuntu / Debian</strong></summary>
+
+**Install Ruby dependencies**
+
+```bash
+sudo apt-get update
+sudo apt install build-essential rustc libssl-dev libyaml-dev zlib1g-dev libgmp-dev
+```
+
+</details>
+
+**Install Ruby with Mise** (version manager)
+
+```bash
+# Install Mise
+curl https://mise.run | sh
+
+# For zsh (macOS default)
+echo 'eval "$(~/.local/bin/mise activate)"' >> ~/.zshrc
+source ~/.zshrc
+
+# For bash (Ubuntu default)
+# echo 'eval "$(~/.local/bin/mise activate)"' >> ~/.bashrc
+# source ~/.bashrc
+
+# Install Ruby
+mise use --global ruby@3
+
+# Verify installation
+ruby --version
+#=> 3.4.7
+
+# Update RubyGems
+gem update --system
+```
+
+#### Install CommitGPT
+
 ```bash
-$ export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx
+gem install commitgpt
 ```
-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.
+
+</details>
+
+---
+
+## Configuration
+
+CommitGPT uses a YAML configuration system (`~/.config/commitgpt/`) to support multiple providers and per-provider settings.
+
+### Interactive Setup (Recommended)
+Run the setup wizard to configure your provider:
+```bash
+$ aicm setup
+```
+
+You'll be guided to:
+1. Choose an AI provider (Presets: Cerebras, OpenAI, Ollama, Groq, etc.)
+2. Enter your API Key (stored securely in `config.local.yml`)
+3. Select a model interactively
+4. Set maximum diff length
+
+**Note:** Please add `~/.config/commitgpt/config.local.yml` to your `.gitignore` if you are syncing your home directory, as it contains your API keys.
+
+---
+
+## Usage
+
+### Generate Commit Message
+Stage your changes and run `aicm`:
 ```bash
-$ cd /path/to/your/repo
 $ git add .
 $ aicm
+```
+
+### Switch Provider
+Switch between configured providers easily:
+```bash
+$ aicm -p
+# or
+$ aicm --provider
+```
+
+### Select Model
+Interactively list and select a model for your current provider:
+```bash
+$ aicm -m
+# or
+$ aicm --models
+```
+
+### Check Configuration
+View your current configuration (Provider, Model, Base URL, Diff Len):
+```bash
+$ aicm help
+```
+(Use the help command to see current active provider settings)
+
+### View Git Diff
+Preview the diff that will be sent to the AI:
+```bash
+$ aicm -v
+```
+
+### Update
+To update to the latest version (if installed via Gem):
+```bash
+$ gem update commitgpt
+```
+
+---
+
+## Supported Providers
+We support any OpenAI-compatible API. Presets available for:
+- **Cerebras** (Fast & Recommended)
+- **OpenAI** (Official)
+- **Ollama** (Local)
+- **Groq**
+- **DeepSeek**
+- **Anthropic (Claude)**
+- **Google AI (Gemini)**
+- **Mistral**
+- **OpenRouter**
+- **Local setups** (LM Studio, LLaMa.cpp, Llamafile)
+
+### Recommended Providers
 
-▲ Welcome to AI Commits!
-▲   Generating your AI commit message...
+**OpenAI** ([https://platform.openai.com](https://platform.openai.com))
+```
+gpt-4o
+gpt-4o-mini
+```
 
-▲ Commit message: git commit -am "Update README.md with contribution instructions and OpenAI API key instructions."
+**Cerebras** ([https://cloud.cerebras.ai](https://cloud.cerebras.ai)) ⭐ Recommended
+```
+zai-glm-4.7          # ⭐ Best for commit messages - fast & accurate
+llama3.1-8b
+llama-3.3-70b
+```
 
-▲ Do you want to commit this message? [y/n]
-[main c082637] Update README.md with contribution instructions and OpenAI API key instructions.
- 4 files changed, 24 insertions(+), 19 deletions(-)
+**Groq** ([https://console.groq.com](https://console.groq.com))
 ```
+llama-3.3-70b-versatile
+llama-3.1-8b-instant
+```
+
+## 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/system instructions for generating conventional commit messages.
 
 ## Special Thanks
-I used chatGPT to convert `AICommits`(JS) to `CommitGPT`(Ruby). Thanks to [https://github.com/Nutlope/aicommits](https://github.com/Nutlope/aicommits)   
+I used ChatGPT to convert `AICommits` from TypeScript to Ruby. Special thanks to [https://github.com/Nutlope/aicommits](https://github.com/Nutlope/aicommits)
 
-## 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.
+---
 
-## 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.
+## Development Guide
 
-## Contributing
+### Requirements
+- Ruby >= 2.6.0
+- Git
+
+### Local Setup
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/ZPVIP/commitgpt.git
+   cd commitgpt
+   ```
+2. Install dependencies:
+   ```bash
+   bundle install
+   ```
+
+### Local Build and Install
+To test your changes locally (builds the gem and installs it to your system):
+```bash
+gem build commitgpt.gemspec
+gem install ./commitgpt-*.gem
+```
+
+### Publishing
 
+#### RubyGems
+To publish a new version to RubyGems.org (requires RubyGems account permissions):
+```bash
+gem push commitgpt-*.gem
+```
+
+#### Homebrew (GitHub Distribution)
+We use a custom script to automate the GitHub Release and Homebrew Formula update process. This enables users to install via `brew tap`.
+
+**Steps:**
+```bash
+./scripts/release.sh <version>
+# Example: ./scripts/release.sh 0.3.1
+```
+
+**This script automates:**
+1. Creating and pushing a Git Tag.
+2. Creating a GitHub Release (which generates the source tarball).
+3. Calculating the SHA256 checksum of the tarball.
+4. Updating `Formula/commitgpt.rb` with the new URL and checksum.
+5. Committing and pushing the updated Formula to the repository.
+
+---
+
+## 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/commitgpt.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/commitgpt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "commitgpt"
+  spec.version = CommitGpt::VERSION
+  spec.authors = ["Peng Zhang"]
+  spec.email = ["zpregister@gmail.com"]
+
+  spec.summary = "A CLI AI that writes git commit messages for you."
+  spec.description = "A CLI that writes your git commit messages for you with AI. Never write a commit message again."
+  spec.homepage = "https://github.com/ZPVIP/commitgpt"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.glob("lib/**/*") + Dir.glob("bin/*") + %w[README.md LICENSE commitgpt.gemspec]
+                             .reject { |f| File.directory?(f) }
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_dependency "thor", "~> 1.2"
+  spec.add_dependency "tty-prompt", "~> 0.23"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/commitgpt/cli.rb

@@ -2,15 +2,61 @@
 
 require "thor"
 require "commitgpt/commit_ai"
+require "commitgpt/setup_wizard"
 
 module CommitGpt
   # CommitGpt CLI
   class CLI < Thor
-    default_task :aicm
+    default_task :generate
 
-    desc "aicm", "AI commits for you!"
-    def aicm
-      CommitGpt::CommitAi.new.aicm
+    desc "generate", "AI commits for you!"
+    method_option :models, aliases: "-m", type: :boolean, desc: "List/Select available models"
+    method_option :verbose, aliases: "-v", type: :boolean, desc: "Show git diff being sent to AI"
+    method_option :provider, aliases: "-p", type: :boolean, desc: "Switch active provider"
+    def generate
+      if options[:provider]
+        CommitGpt::SetupWizard.new.switch_provider
+      elsif options[:models]
+        CommitGpt::SetupWizard.new.change_model
+      else
+        CommitGpt::CommitAi.new.aicm(verbose: options[:verbose])
+      end
+    end
+
+    desc "setup", "Configure AI provider and settings"
+    def setup
+      CommitGpt::SetupWizard.new.run
+    end
+
+    # Custom help message
+    def self.help(shell, subcommand = false)
+      shell.say "Usage:"
+      shell.say "  aicm                     # Generate AI commit message (Default)"
+      shell.say "  aicm setup               # Configure AI provider and settings"
+      shell.say "  aicm help [COMMAND]      # Describe available commands"
+      shell.say ""
+      shell.say "Options:"
+      shell.say "  -m, --models             # Interactive model selection"
+      shell.say "  -p, --provider           # Switch active provider"
+      shell.say "  -v, --verbose            # Show git diff being sent to AI"
+      shell.say ""
+
+      # Show current configuration
+      begin
+        require "commitgpt/config_manager"
+        require "commitgpt/string"
+        config = CommitGpt::ConfigManager.get_active_provider_config
+        if config
+          shell.say "Current Configuration:"
+          shell.say "  Provider:  #{config['name'].green}"
+          shell.say "  Model:     #{config['model'].cyan}"
+          shell.say "  Base URL:  #{config['base_url']}"
+          shell.say "  Diff Len:  #{config['diff_len']}"
+          shell.say ""
+        end
+      rescue StandardError
+        # Ignore errors during help display if config is missing/invalid
+      end
     end
   end
 end