Commify 1.4.4

Commify: You Should Commit Yourself.

Commify

Commify is a command-line interface (CLI) tool that generates meaningful, structured commit messages for Git repositories using AI. By analyzing the staged changes (diff) in your repository, it creates commit messages that follow conventional commit guidelines, optionally including emojis for better context and readability. See Commify website to know more. Don't forget to :star: the project!

Ollama provider can be slow without a good GPU or a very large AI model. It's not a Commify optimization problem.

---

:sparkles: Features

• AI-Powered Commit Messages: Generate concise and structured commit messages using the ollama local AI provider or G4F AI provider.
• Emoji Support: Optionally include relevant emojis in commit messages.
• Language Support: Generate commit messages in the language of your choice.
• Customizable Providers: Specify the AI provider to use (g4f or ollama).
• Interactive Review System: Review and approve generated messages or request new ones.
• Customizable Models: Specify the AI model to use.

---

:hammer_and_wrench: Installation

Windows

Make sure you have installed Git, python3.10+ and ollama (ollama is optional) Run the following:

pip install Commify

Linux

Make sure you have installed Git, python3.10+, pipx and ollama (ollama is optional) If don't, use this command:

sudo apt install git
sudo apt install pipx

And install Commify:

pipx install Commify
pipx ensurepath

After that, restart your terminal and you will already have Commify installed.

---

:building_construction: Usage

Run the commify CLI with the desired options:

commify <path_to_repo> [--lang <language>] [--emoji <True/False>] [--model <AI_model>] [--provider <AI_PROVIDER>]

Examples

Using Ollama Provider:

commify /path/to/repo --lang english --emoji True --model llama3.1 --provider ollama

Using G4F Provider:

commify /path/to/repo --lang english --emoji True --model gpt-4o --provider g4f

Without Specifying The Repository Path:

cd /path/to/repo
commify --lang english --emoji True --model llama3.1 --provider ollama

Arguments

• path: Path to the Git repository. (If the repository path is not specified, the path Commify is running from will be used)
• --lang: Language for the commit message (default: english).
• --provider: AI provider to use for generating messages (default: ollama). (required)
• --emoji: Include emojis in the commit message (True or False, default: True).
• --model: AI model to use for generating messages (default: llama3.1). (required)
• --help: Display all available parameters and their descriptions.
• --version: Display the installed Commify version.

---

:bulb: Features in Detail

Commit Message Review

Once a message is generated, you'll be prompted to:

• Accept the message (y).
• Reject the message will be generated again (n).
• Cancel the message (c).

Commify Providers

Commify currently supports only 2 providers:

• ollama: Ollama is an open-source project that serves as a powerful and user-friendly platform for running LLMs on your local machine.
• gpt4free: gpt4free is an AI-Based Software Package that Reverse-Engineers APIs to Grant Anyone Free Access to Popular and powerful AI Models.

Feel free to submit a pull request or open an issue to add more providers!

---

:jigsaw: Testing Information

Confirmed successful runs (with no errors) on the following:

• OS:

  • Windows11
  • Windows10
  • Ubuntu24.04.1LTS
  • Linux Mint 22

• Python:

  • Python 3.11.9
  • Python 3.12.3

• AI Models:

  • llama3.2-vision Ollama
  • llama3.1 Ollama
  • dolphin-llama3 Ollama
  • gpt-4o G4F
  • gpt-4o-mini G4F

Let us know if it runs on your machine too!

---

:computer: Developer Information

Commify is developed and maintained by Matuco19.

• Matuco19 Website: matuco19.com
• GitHub: github.com/Matuco19
• Discord Server: discord.gg/Matuco19Server0

---

:bookmark_tabs: License

This project is open-source and available under the MATCO-Open-Source License. See the LICENSE file for details.

---

:wave: Contributions

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.

---

Start making commits with Commify today! :tada: