zaidfadhil / kemit

Generate Git commit messages with AI

kemit

Automate the process of generating commit messages based on the diff of staged files in a Git repository

Requirements

• Git
• Ollama (with llama3 or mistral)
• Supported platforms: macOS, Linux

Installation

Shell script

Install Kemit on macOS or Linux using the following command:

Using Curl

sudo curl -fsSL https://raw.githubusercontent.com/zaidfadhil/kemit/main/install.sh | sh

Or using Wget

sudo wget -qO- https://raw.githubusercontent.com/zaidfadhil/kemit/main/install.sh | sh

From Source

1. Clone the repository:

git clone https://github.com/zaidfadhil/kemit.git
cd kemit

2. Build the application:

make install

Setup

Make sure ollama installed and running in serve mode.

To set or update the configuration, use the config command:

kemit config [options]

• --provider: Set the LLM Provider. (default: ollama).
• --ollama_host: Set the Ollama Host. Example: http://localhost:11434. (required).
• --ollama_model: Set the Ollama Model. Example: llama3. (required).

example:

kemit config --ollama_host http://localhost:11434 --ollama_model llama3

Usage

To generate a commit message:

kemit

If there are no staged changes, the application will output "nothing to commit". Otherwise, it will generate and print a commit message based on the staged diff.

Uninstall

To uninstall Kemit, you can use the uninstall script which removes the installed binary:

sudo curl -fsSL https://raw.githubusercontent.com/zaidfadhil/kemit/main/uninstall.sh | sh
// or
sudo wget -qO- https://raw.githubusercontent.com/zaidfadhil/kemit/main/uninstall.sh | sh

License

kemit is licensed under the MIT License.

kemit's Issues

Add Support for Conventional Commits

Feature Details:

• Option for Conventional Commits: Introduce a config option that enables or disables the generation of commit messages following the Conventional Commits specification.
• Commit Types: Ensure that the commit messages generated include the appropriate types (e.g., feat, fix, docs, style, refactor, test, chore).
• Scoping: Allow for optional scoping of the commit messages to specify the part of the codebase affected (e.g., feat(parser): add ability to parse arrays).