Skip to main content

AI powered Git Commit Message Generator

Project description

AI GCM

A command-line tool that uses AI to generate meaningful git commit messages.

Features

  • Analyzes git diff to understand code changes
  • Generates human-readable summaries of changes
  • Creates conventional commit messages
  • Supports custom AI models
  • Interactive prompts for staging changes

Prerequisites

  1. Install Ollama:

    brew install ollama
    
  2. Pull required models:

    ollama pull qwen2.5-coder  # for code analysis
    ollama pull llama3.2       # for commit message generation
    

Installation

pipx install ai-gcm

Usage

Generate Commit Message

# Stage your changes first
git add .

# Generate commit message with default models
ai-gcm generate

# Show detailed output including code changes summary
ai-gcm generate --verbose

# Use custom models
ai-gcm generate --summary-model qwen2.5-coder --commit-model llama3.2

Options

  • --summary-model, -s: Model to use for code summary generation (default: qwen2.5-coder)
  • --commit-model, -c: Model to use for commit message generation (default: llama3.2)
  • --verbose, -v: Show detailed output including summary

Check Version

ai-gcm version

Development

  1. Clone the repository

  2. Install dependencies:

    poetry install
    
  3. Activate the virtual environment:

    poetry shell
    

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_gcm-1.0.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_gcm-1.0.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file ai_gcm-1.0.1.tar.gz.

File metadata

  • Download URL: ai_gcm-1.0.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for ai_gcm-1.0.1.tar.gz
Algorithm Hash digest
SHA256 87eebfad305da7fb7a08b6e830ba860c826ab9073f4b2a1490dacb3705cc9fab
MD5 7442b31106f0ba7a74bf0553b12c96e6
BLAKE2b-256 0e69dde76e9d354ea6ffc86b4856e8e3c6948d118338b29f525f93443a5f4f78

See more details on using hashes here.

File details

Details for the file ai_gcm-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ai_gcm-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for ai_gcm-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 289d01a5eb1c44e6b3dcd212afb86c53876d289f2aca4a6221a53db9859a9995
MD5 8770bc000729410a3f75cfb6132eefbb
BLAKE2b-256 61561e38bc05d547245dc2bb31646ecdefc8b52f3edbd844549bfff04a454484

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page