This project provides an automated tool for generating Git commit messages using ChatGPT, targeting developers who want to streamline their commit workflow and adhere to conventional commit standards. It simplifies the process of creating descriptive and consistent commit messages by leveraging AI.

How It Works

The tool executes git diff --cached to capture staged changes. This diff is then sent to ChatGPT, which is prompted to suggest commit messages adhering to conventional commit formats. The user is presented with these AI-generated suggestions for selection.

Quick Start & Requirements

• Primary install / run command: npx commitgpt
• Non-default prerequisites and dependencies: OpenAI API key.
• Configuration: Optional .commitgpt.json for model parameters and .commitgpt-template for prompt customization.
• Documentation: Redocly API Docs

Highlighted Details

• Leverages ChatGPT for commit message generation.
• Supports customization of OpenAI model and parameters via .commitgpt.json.
• Allows modification of the prompt template via .commitgpt-template for tailored suggestions.
• Aims to enforce conventional commit standards.

Maintenance & Community

• Inspired by projects like acheong08/ChatGPT, transitive-bullshit/chatgpt-api, and wong2/chat-gpt-google-extension.

Licensing & Compatibility

• License: Not specified in the README.
• Compatibility: Designed for Git repositories.

Limitations & Caveats

The project's license is not explicitly stated, which may impact commercial use or integration into closed-source projects. The effectiveness of generated messages is dependent on the quality of the diff and the capabilities of the underlying OpenAI model.