Skip to content

🎉 Release 1.0.0 - git-ai-commit

Latest

Choose a tag to compare

@dehenne dehenne released this 22 Jan 09:34
· 1 commit to main since this release

git-ai-commit integrates AI-powered commit message generation into your Git workflow, saving you time and ensuring professional, consistent commit messages. With OpenAI GPT-4 as the engine, this tool is built to improve your development process.


🚀 Features

  • AI-Generated Commit Messages:
    • Automatically analyze your changes and generate structured commit messages.
    • Uses prefixes like fix:, refactor:, and docs: for standardization.
  • Git Integration:
    • Fully supports standard Git commit options (-a, -m, file-specific commits).
    • Opens your Git editor with pre-filled commit messages for manual edits.
  • Customizable and Professional Output:
    • Generates short headlines and detailed descriptions, following best practices.

🛠 Setup & Usage

  1. Install git-ai-commit and configure your OpenAI API key:

    git-ai-commit --set-chatgpt-key YOUR_API_KEY
  2. Use it as a drop-in replacement for git commit:

    git-ai-commit -a
    git-ai-commit file1.txt file2.txt
    git-ai-commit -m "fix: updated [README](https://gitlab.com/dehenne/git-ai-commit)"

For detailed instructions, see the README.


🌟 Highlights

  • Seamless Workflow: Works out of the box with your existing Git commands.
  • Configurable: Stores your API key securely in your home directory.
  • Future-Ready: Plans for additional AI models and custom commit templates.

🔧 Debugging

If you run into issues, ensure:

  • Your API key is valid.
  • All dependencies (jq, curl, etc.) are installed.
  • Changes are properly staged or unstaged.

🗓 What’s Next?

  • Multi-AI model support for enhanced flexibility.
  • Advanced configuration options for custom commit templates.

Thank you for using git-ai-commit! I look forward to your feedback and contributions.

[Visit the Project on GitLab](https://gitlab.com/dehenne/git-ai-commit)