Skip to main content

Generate git commit messages using Groq LLMs

Project description

gen-commit

Generate concise, descriptive Git commit messages using Groq LLMs.

Features

  • Produce context-aware commit message suggestions from staged changes.
  • Simple CLI workflow that fits into existing git usage.
  • Configurable via environment variables.

Requirements

  • Python 3.8+
  • A valid GROQ API key

Install

pip install gen-commit-cli

Quickstart

  1. Stage your changes:
git add .
  1. Generate a commit message:
gen-commit
  1. Use the suggested message for committing:
git commit -m "feat: add user authentication flow"

Configuration

Set your Groq API key in the environment:

export GROQ_API_KEY=sk-xxxx

For help and available options:

gen-commit --help

Troubleshooting

  • "Invalid API key" — verify GROQ_API_KEY is set and correct.
  • "No staged files" — ensure you ran git add before generating a message.

Contributing

Contributions, issues and feature requests are welcome via the project repository.

License

Specify your project's license (e.g., MIT) in the repository root.

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

gen_commit_cli-0.1.1.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

gen_commit_cli-0.1.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file gen_commit_cli-0.1.1.tar.gz.

File metadata

  • Download URL: gen_commit_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gen_commit_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 11e26b0d571db6658ee146a98dcfc13abe0542be6ecaf6fdcb99eaaebbd9630d
MD5 89096a5b5cc7939ab7c3db1728f7cf9b
BLAKE2b-256 91f9396e1fc959d8e4780e4813a8a891e185eecfa60c1c681f9f5fc5bd7421be

See more details on using hashes here.

File details

Details for the file gen_commit_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gen_commit_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gen_commit_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 314c33b6ecbd82fb10ab3dc05624d73af9307d6bf79e9acc956ba4de08c4520e
MD5 3b4fd635ec5f39c4b5228f0d9403da61
BLAKE2b-256 6b8a1a7246c4ca7e9e7bd1cc7ffa886fafc3b6bb176a94dacb4402a5b3dfcc4a

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