https://github.com/michaelcurrin/llm-commit-msg

CLI tool to generate a commit message using an LLM
https://github.com/michaelcurrin/llm-commit-msg

ai commit git llm

Last synced: over 1 year ago
JSON representation

CLI tool to generate a commit message using an LLM

• Host: GitHub
• URL: https://github.com/michaelcurrin/llm-commit-msg
• Owner: MichaelCurrin
• License: mit
• Created: 2024-11-03T20:06:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-28T21:28:38.000Z (over 1 year ago)
• Last Synced: 2025-01-05T10:43:25.707Z (over 1 year ago)
• Topics: ai, commit, git, llm
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LLM Commit Msg

> CLI tool to generate a commit message based on your Git diff - using an LLM

[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/commit-msg?include_prereleases=&sort=semver)](https://github.com/MichaelCurrin/commit-msg/releases/)

[![License](https://img.shields.io/badge/License-MIT-blue)](#license)

[![Made with Python](https://img.shields.io/badge/Python->=3.10-blue?logo=python&logoColor=white)](https://python.org "Go to Python homepage")

[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)](https://www.linux.org/ "Go to Linux homepage")

[![OS - macOS](https://img.shields.io/badge/OS-macOS-blue?logo=apple&logoColor=white)](https://www.apple.com/macos/ "Go to Apple homepage")

## About

This tool works an LLM model to interpret the Git diff and generate a commit message.

Here are options for the LLM model:

- **Local LLM server** - Run at no cost and keeping your data private and offline.

- **OpenAI** - If you have a paid subscription for ChatGPT, configure with your credentials.

- **ChatGPT alternatives** - Use a free tool like [pollinations.ai](https://pollinations.ai) which uses the OpenAI API protocol.

### VS Code extension ideas

If you want this logic as an _extension_ in VS Code instead of as a CLI, you can search the extensions marketplace for extensions that generate commit messages. There are many, though they tend to require a ChatGPT token and paid subscription and won't necessarily work with a local LLM or ChatGPT alternatives.

## Documentation



[![View - Documentation](https://img.shields.io/badge/View-Documentation-blue?style=for-the-badge)](/docs/)



## License

Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).