# 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](https://matuco19.com/Commify) website to know more. --> Don't forget to ⭐ the project!
>
>Ollama provider can be slow without a good GPU or a very large AI model. It's not a Commify optimization problem.
<!-- space -->
>
> <sup>**Latest version:**</sup> [](https://pypi.org/project/Commify)
> <sup>**Stats:**</sup> [](https://pepy.tech/project/Commify) [](https://pepy.tech/project/Commify)
---
## ✨ Features
- **AI-Powered Commit Messages:** Generate concise and structured commit messages using the `ollama` local AI provider, `G4F` AI provider or `Openai` AI provider (Openai provider requires an apikey).
- **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, ollama or openai).
- **Interactive Review System:** Review and approve generated messages or request new ones.
- **Customizable Models:** Specify the AI model to use.
---
## 🛠️ Installation
### Windows
Make sure you have installed `Git`, `python3.10+` and `ollama` (ollama is optional)
Run the following:
```bash
pip install Commify
```
### Linux
Make sure you have installed `Git`, `python3.10+`, `pipx` and `ollama` (ollama is optional)
If you don't, use this command:
```bash
sudo apt install git
sudo apt install pipx
```
And install Commify:
```bash
pipx install Commify
pipx ensurepath
```
After that, restart your terminal and you will already have Commify installed.
---
## 🏗️ Usage
See the [Commify Documentation](https://github.com/Matuco19/Commify/blob/main/docs/) to see more example usage, milestones, and others.
Run the `commify` CLI with the desired options:
```bash
commify <path_to_repo> [--lang <language>] [--emoji <True/False>] [--model <AI_model>] [--provider <AI_PROVIDER>] [--apikey <API_KEY>]
```
### Examples
#### Basic Usage
Commify supports multiple AI providers, from locally run (Ollama) to cloud-based (Groq, G4F & Openai)
>
>See more example usage in documentation [docs/example-usage](https://github.com/Matuco19/Commify/blob/main/docs/example-usage.md)
Using Ollama Provider:
```bash
commify /path/to/repo --lang english --emoji True --model llama3.1 --provider ollama
```
Using G4F Provider:
```bash
commify /path/to/repo --lang english --emoji True --model gpt-4o --provider g4f
```
Using Openai Provider:
```bash
commify /path/to/repo --lang english --emoji True --model gpt-4o --provider openai
```
Using Groq Provider:
```bash
commify /path/to/repo --lang english --emoji True --model llama-3.3-70b-versatile --provider groq
```
Without Specifying The Repository Path:
```bash
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.
- **`--debug`:** Run Commify in Debug Mode. (It is not recommended if you don't know what you are doing.)
- **`--apikey`:** A temporary apikey use for Openai or Groq API key to use (default: `sk-`).
- **`--save-apikey`:** Save API key for a provider. Ex: --save-apikey openai sk-...
- **`--mod-apikey`:** Modify API key for a provider. Ex: --mod-apikey groq gsk-...
---
## 💡 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 4 providers:
- [ollama](https://ollama.com/): ollama is an open-source project that serves as a powerful and user-friendly platform for running LLMs on your local machine.
- [gpt4free](https://github.com/xtekky/gpt4free): gpt4free is an AI-Based Software Package that Reverse-Engineers APIs to Grant Anyone Free Access to Popular and powerful AI Models.
- [openai](https://platform.openai.com/): openAI is a cutting-edge research organization that works to push the limits of artificial intelligence in a variety of domains.
- [groq](https://groq.com): Groq is an extremely fast AI response engine that can write factual and quoted responses in hundreds of words in less than a second.
Feel free to submit a pull request or open an issue to add more providers!
### Apikey Saving
Commify allows you to save and modify API keys for certain providers (`openai` and `groq`). This can be useful if you frequently use these providers and want to avoid entering the API key each time you run Commify.
#### Saving an API Key
To save an API key for a provider, use the `--save-apikey` option followed by the provider name and the API key. For example:
```bash
commify --save-apikey openai sk-...
```
This will save the API key for the openai provider. You can also save an API key for the groq provider:
```bash
commify --save-apikey groq gsk-...
```
The saved API key will be stored in a file located at `~/.commify_env` and will be automatically used in future Commify runs.
#### Modifying an API Key
If you need to update an existing API key, use the `--mod-apikey` option followed by the provider name and the new API key. For example:
```bash
commify --mod-apikey openai sk-...
```
This will update the saved API key for the openai provider. Similarly, you can update the API key for the groq provider:
```bash
commify --mod-apikey groq gsk-...
```
#### Using a Temporary API Key
If you prefer not to save the API key, you can provide it directly when running Commify using the `--apikey` option. For example:
```bash
commify /path/to/repo --provider openai --apikey sk-...
```
This will use the provided API key for the current run without saving it.
Feel free to submit a pull request or open an issue if you have any suggestions or improvements for this feature!
---
## 🧩 Testing Information
Confirmed successful runs (with no errors) on the following:
- **OS:**
- Windows 11
- Windows 10
- Ubuntu24.04.1 LTS
- 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`
- deepseek-r1 `Ollama`
- Phi3.5 `Ollama`
- llama-3.3-70b-versatile `Groq`
- deepseek-r1-distill-llama-70b `Groq`
Let us know if it runs on your machine too!
---
## 💻 Developer Information
Commify is developed and maintained by **Matuco19**.
- Matuco19 Website: [matuco19.com](https://matuco19.com)
- GitHub: [github.com/Matuco19](https://github.com/Matuco19)
- Discord Server: [discord.gg/Matuco19Server0](https://discord.gg/hp7yCxHJBw)
---
## 📑 License
This project is open-source and available under the [MATCO-Open-Source License](https://matuco19.com/licenses/MATCO-Open-Source). See the `LICENSE` file for details.
---
## 👋 Contributions
Contributions are welcome! Feel free to open an issue or submit a pull request on [GitHub](https://github.com/Matuco19/commify).
---
Start making commits with **Commify** today! 🎉
Raw data
{
"_id": null,
"home_page": "https://matuco19.com/Commify",
"name": "Commify",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "commify, python, ai, commit, commits, git, github, gpt, language-model, automation, commits, gpt-4, gpt4, gpt-4o, gpt4o, gpt4-o, gpt-4omni, o1, o3-mini, deepseek-r1, groq, cli, cli-app, ollama, ollama-api, llama3, llama3.1, llama3.2, llama3.3, matuco19, openai, python3, gitpython",
"author": "Matuco19",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/50/fe/83a8b11ef9bd58b505817128ec31c8e4ab581056d2dd993135decb0eacf0/commify-1.7.tar.gz",
"platform": null,
"description": "\n# Commify\n\nCommify 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](https://matuco19.com/Commify) website to know more. --> Don't forget to \u2b50 the project!\n\n>\n>Ollama provider can be slow without a good GPU or a very large AI model. It's not a Commify optimization problem. \n\n<!-- space -->\n> \n> <sup>**Latest version:**</sup> [](https://pypi.org/project/Commify) \n> <sup>**Stats:**</sup> [](https://pepy.tech/project/Commify) [](https://pepy.tech/project/Commify) \n\n---\n\n## \u2728 Features\n\n- **AI-Powered Commit Messages:** Generate concise and structured commit messages using the `ollama` local AI provider, `G4F` AI provider or `Openai` AI provider (Openai provider requires an apikey).\n- **Emoji Support:** Optionally include relevant emojis in commit messages.\n- **Language Support:** Generate commit messages in the language of your choice.\n- **Customizable Providers:** Specify the AI provider to use (g4f, ollama or openai).\n- **Interactive Review System:** Review and approve generated messages or request new ones.\n- **Customizable Models:** Specify the AI model to use.\n\n---\n\n## \ud83d\udee0\ufe0f Installation\n\n### Windows\n\nMake sure you have installed `Git`, `python3.10+` and `ollama` (ollama is optional)\nRun the following:\n\n```bash\npip install Commify\n```\n\n### Linux\n\nMake sure you have installed `Git`, `python3.10+`, `pipx` and `ollama` (ollama is optional)\nIf you don't, use this command:\n\n```bash\nsudo apt install git\nsudo apt install pipx\n```\n\nAnd install Commify:\n\n```bash\npipx install Commify\npipx ensurepath\n```\n\nAfter that, restart your terminal and you will already have Commify installed.\n\n---\n\n## \ud83c\udfd7\ufe0f Usage\n\nSee the [Commify Documentation](https://github.com/Matuco19/Commify/blob/main/docs/) to see more example usage, milestones, and others.\n\nRun the `commify` CLI with the desired options:\n\n```bash\ncommify <path_to_repo> [--lang <language>] [--emoji <True/False>] [--model <AI_model>] [--provider <AI_PROVIDER>] [--apikey <API_KEY>]\n```\n\n### Examples\n\n#### Basic Usage\n\nCommify supports multiple AI providers, from locally run (Ollama) to cloud-based (Groq, G4F & Openai)\n\n>\n>See more example usage in documentation [docs/example-usage](https://github.com/Matuco19/Commify/blob/main/docs/example-usage.md)\n\nUsing Ollama Provider:\n\n```bash\ncommify /path/to/repo --lang english --emoji True --model llama3.1 --provider ollama\n```\n\nUsing G4F Provider:\n\n```bash\ncommify /path/to/repo --lang english --emoji True --model gpt-4o --provider g4f\n```\n\nUsing Openai Provider:\n\n```bash\ncommify /path/to/repo --lang english --emoji True --model gpt-4o --provider openai\n```\n\nUsing Groq Provider:\n\n```bash\ncommify /path/to/repo --lang english --emoji True --model llama-3.3-70b-versatile --provider groq\n```\n\nWithout Specifying The Repository Path:\n\n```bash\ncd /path/to/repo\ncommify --lang english --emoji True --model llama3.1 --provider ollama\n```\n\n### Arguments\n\n- **`path`:** Path to the Git repository. (If the repository path is not specified, the path Commify is running from will be used)\n- **`--lang`:** Language for the commit message (default: `english`).\n- **`--provider`:** AI provider to use for generating messages (default: `ollama`). (required)\n- **`--emoji`:** Include emojis in the commit message (`True` or `False`, default: `True`).\n- **`--model`:** AI model to use for generating messages (default: `llama3.1`). (required)\n- **`--help`:** Display all available parameters and their descriptions.\n- **`--version`:** Display the installed Commify version.\n- **`--debug`:** Run Commify in Debug Mode. (It is not recommended if you don't know what you are doing.)\n- **`--apikey`:** A temporary apikey use for Openai or Groq API key to use (default: `sk-`). \n- **`--save-apikey`:** Save API key for a provider. Ex: --save-apikey openai sk-... \n- **`--mod-apikey`:** Modify API key for a provider. Ex: --mod-apikey groq gsk-... \n\n---\n\n## \ud83d\udca1 Features in Detail\n\n### Commit Message Review\n\nOnce a message is generated, you'll be prompted to:\n\n- **Accept** the message (`y`).\n- **Reject** the message will be generated again (`n`).\n- **Cancel** the message (`c`).\n\n### Commify Providers\n\nCommify currently supports only 4 providers:\n\n- [ollama](https://ollama.com/): ollama is an open-source project that serves as a powerful and user-friendly platform for running LLMs on your local machine.\n- [gpt4free](https://github.com/xtekky/gpt4free): gpt4free is an AI-Based Software Package that Reverse-Engineers APIs to Grant Anyone Free Access to Popular and powerful AI Models.\n- [openai](https://platform.openai.com/): openAI is a cutting-edge research organization that works to push the limits of artificial intelligence in a variety of domains.\n- [groq](https://groq.com): Groq is an extremely fast AI response engine that can write factual and quoted responses in hundreds of words in less than a second.\n\nFeel free to submit a pull request or open an issue to add more providers!\n\n### Apikey Saving\n\nCommify allows you to save and modify API keys for certain providers (`openai` and `groq`). This can be useful if you frequently use these providers and want to avoid entering the API key each time you run Commify.\n\n#### Saving an API Key\n\nTo save an API key for a provider, use the `--save-apikey` option followed by the provider name and the API key. For example:\n\n```bash\ncommify --save-apikey openai sk-...\n```\n\nThis will save the API key for the openai provider. You can also save an API key for the groq provider:\n\n```bash\ncommify --save-apikey groq gsk-...\n```\n\nThe saved API key will be stored in a file located at `~/.commify_env` and will be automatically used in future Commify runs.\n\n#### Modifying an API Key\n\nIf you need to update an existing API key, use the `--mod-apikey` option followed by the provider name and the new API key. For example:\n\n```bash\ncommify --mod-apikey openai sk-...\n```\n\nThis will update the saved API key for the openai provider. Similarly, you can update the API key for the groq provider:\n\n```bash\ncommify --mod-apikey groq gsk-...\n```\n\n#### Using a Temporary API Key\n\nIf you prefer not to save the API key, you can provide it directly when running Commify using the `--apikey` option. For example:\n\n```bash\ncommify /path/to/repo --provider openai --apikey sk-...\n```\n\nThis will use the provided API key for the current run without saving it.\n\nFeel free to submit a pull request or open an issue if you have any suggestions or improvements for this feature!\n\n---\n\n## \ud83e\udde9 Testing Information\n\nConfirmed successful runs (with no errors) on the following:\n\n- **OS:**\n - Windows 11\n - Windows 10\n - Ubuntu24.04.1 LTS\n - Linux Mint 22\n\n- **Python:**\n - Python 3.11.9\n - Python 3.12.3\n\n- **AI Models:**\n - llama3.2-vision `Ollama`\n - llama3.1 `Ollama`\n - dolphin-llama3 `Ollama`\n - gpt-4o `G4F`\n - gpt-4o-mini `G4F`\n - deepseek-r1 `Ollama`\n - Phi3.5 `Ollama`\n - llama-3.3-70b-versatile `Groq`\n - deepseek-r1-distill-llama-70b `Groq`\n\nLet us know if it runs on your machine too!\n\n---\n\n## \ud83d\udcbb Developer Information\n\nCommify is developed and maintained by **Matuco19**.\n\n- Matuco19 Website: [matuco19.com](https://matuco19.com) \n- GitHub: [github.com/Matuco19](https://github.com/Matuco19)\n- Discord Server: [discord.gg/Matuco19Server0](https://discord.gg/hp7yCxHJBw)\n\n---\n\n## \ud83d\udcd1 License\n\n\n\nThis project is open-source and available under the [MATCO-Open-Source License](https://matuco19.com/licenses/MATCO-Open-Source). See the `LICENSE` file for details.\n\n---\n\n## \ud83d\udc4b Contributions\n\nContributions are welcome! Feel free to open an issue or submit a pull request on [GitHub](https://github.com/Matuco19/commify).\n\n---\n\nStart making commits with **Commify** today! \ud83c\udf89\n",
"bugtrack_url": null,
"license": "MATCO-Open-Source",
"summary": "Commify: You Should Commit Yourself.",
"version": "1.7",
"project_urls": {
"Bug Tracker": "https://github.com/Matuco19/Commify/issues",
"Homepage": "https://matuco19.com/Commify",
"Source Code": "https://github.com/Matuco19/Commify"
},
"split_keywords": [
"commify",
" python",
" ai",
" commit",
" commits",
" git",
" github",
" gpt",
" language-model",
" automation",
" commits",
" gpt-4",
" gpt4",
" gpt-4o",
" gpt4o",
" gpt4-o",
" gpt-4omni",
" o1",
" o3-mini",
" deepseek-r1",
" groq",
" cli",
" cli-app",
" ollama",
" ollama-api",
" llama3",
" llama3.1",
" llama3.2",
" llama3.3",
" matuco19",
" openai",
" python3",
" gitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "92eea8c6f193bce1c8c8e0a8a49d65a814f7b12bdec8b9680c716c14e5484220",
"md5": "5f21c4d1bee72a80e7d3a92dd3c7eec9",
"sha256": "9df4e981fb3c9ff201a99a565dec2c705eb47fb4262726277401678b6e96324c"
},
"downloads": -1,
"filename": "Commify-1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f21c4d1bee72a80e7d3a92dd3c7eec9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11478,
"upload_time": "2025-02-04T14:58:59",
"upload_time_iso_8601": "2025-02-04T14:58:59.726256Z",
"url": "https://files.pythonhosted.org/packages/92/ee/a8c6f193bce1c8c8e0a8a49d65a814f7b12bdec8b9680c716c14e5484220/Commify-1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "50fe83a8b11ef9bd58b505817128ec31c8e4ab581056d2dd993135decb0eacf0",
"md5": "9e38deb5c747121bdd08ab7e0e4b5520",
"sha256": "0c43a7d777285949aaf09aa416f157aa07f7f498cdfcbbed5de3f27ed76869a2"
},
"downloads": -1,
"filename": "commify-1.7.tar.gz",
"has_sig": false,
"md5_digest": "9e38deb5c747121bdd08ab7e0e4b5520",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10816,
"upload_time": "2025-02-04T14:59:01",
"upload_time_iso_8601": "2025-02-04T14:59:01.192287Z",
"url": "https://files.pythonhosted.org/packages/50/fe/83a8b11ef9bd58b505817128ec31c8e4ab581056d2dd993135decb0eacf0/commify-1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 14:59:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Matuco19",
"github_project": "Commify",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "ollama",
"specs": []
},
{
"name": "gitpython",
"specs": []
},
{
"name": "argparse",
"specs": []
},
{
"name": "g4f",
"specs": []
},
{
"name": "rich",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "openai",
"specs": []
},
{
"name": "groq",
"specs": []
}
],
"lcname": "commify"
}
JSON
