Skip to main content

AI-powered Git commit message generator

Project description

Easy Commit

AI-powered Git commit message generator using Groq API.

Installation

pip install easy-commit

Usage

Stage your changes

git add .

It is neccesary to first stage all your changes. This picks up the code diffs from the staged changes.

Set your Groq API key as an environment variable:

export GROQ_API_KEY=your_groq_api_key_here

Or pass it as a command-line argument:

easy-commit --api-key your_groq_api_key_here

Optional arguments:

  • --trunc-diff: Maximum length of diff to analyze (default: 2048)
  • --commit-len: Maximum length of commit message (default: 100)

Examples

easy-commit

Yes! Thats actually all it takes. You will be shown the commit message, and prompted to press enter to perform the commit

With arguments

easy-commit --trunc-diff 1024 --commit-len 50 --model-name "llama3-8b-8192"

Requirements

  • Python 3.7+
  • Groq API key

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

easy-commit-0.1.6.tar.gz (3.7 kB view details)

Uploaded Source

File details

Details for the file easy-commit-0.1.6.tar.gz.

File metadata

  • Download URL: easy-commit-0.1.6.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.4

File hashes

Hashes for easy-commit-0.1.6.tar.gz
Algorithm Hash digest
SHA256 0e31be075a4909217ee9daa578bf00cb6cb9c7a09e98acaaa12bc284972a82cc
MD5 582cb7ddb6782fd176b2d33211f22aef
BLAKE2b-256 75494c786181fd7b71ab80d3757a54f9acd35e392a2b275a127573dd82232fe0

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