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

pip install ai-gcm

Usage

Generate Commit Message

# Stage your changes first
git add .

# Generate commit message with default models
ai-gcm commit

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

# Use custom models
ai-gcm commit --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-0.1.0.tar.gz (5.6 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-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ai_gcm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3af3a06d8ac0d90bebfc093e44d9c8bbcca9c2623e8ffd60a72c7fba3eb89f49
MD5 b9d636ee856f66d408d2ea624b872528
BLAKE2b-256 581808d79246a00094035e270f7ddb891846ad3883a296a756d782339800160b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ai_gcm-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 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-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71afe9c384b0d365a266336d39587fcab7e618597e4580423c9b648744705815
MD5 fab5cdf36a1ec5f61777ba1ed03377b9
BLAKE2b-256 b6228ba7c20d52ed85ba0a835732237be954c756f51f3f6427ef79aa16d6d0ac

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