No project description provided
Project description
🚀 gitmess: Automated Git Commit Messages with GPT! 🚀
📝 Prerequisites:
Before using gitmess
, you must set up your OpenAI API key:
Linux/macOS:
export OPENAI_API_KEY=<your_api_key>
Windows (Command Prompt):
set OPENAI_API_KEY=<your_api_key>
Windows (PowerShell):
$env:OPENAI_API_KEY="<your_api_key>"
🖥 Usage:
Generating an automatic commit message:
gm
Activating Auto-Push:
After committing, you can choose to automatically push your commits to the repository. To activate the auto-push feature, use:
gm --set-push-auto
Checking the installed version:
To ensure that gitmess has been installed correctly and to check its version, use:
gm -v
This will display the currently installed version of gitmess.
🎯 Description
gitmess is a revolutionary tool designed to supercharge developers' git workflows by automatically generating commit messages with the power of GPT. Keeping with the conventionalcommits v1.0.0
standard, gitmess ensures that your commits remain consistent, meaningful, and time-efficient!
🛠 Features:
- 🔥 Auto-Generated Commit Messages: No more time wasted thinking about the perfect commit message.
- 📏 Conventionalcommits v1.0.0 Standard: Ensures that your commits align with best practices.
- 🤖 GPT-powered: Leverages the capabilities of GPT to generate relevant commit messages.
🌟 Benefits:
- 🕐 Save Time: No need to think about commit messages anymore.
- 🔄 Consistency: Follow the
conventionalcommits v1.0.0
standard every time. - 🚀 Enhance Workflow: Streamline your git process.
📥 Installation:
Windows:
- Open Command Prompt as administrator.
- Run the following command:
curl -LO https://raw.githubusercontent.com/0xjesus/gitmess/main/install.bat && install.bat
macOS:
- Open the Terminal.
- Use the following command to download and run the installer:
curl -LO https://raw.githubusercontent.com/0xjesus/gitmess/main/install_gitmess.sh && chmod +x install_gitmess.sh && ./install_gitmess.sh
Linux:
- Open the Terminal.
- Execute the following command to download and run the installer:
curl -LO https://raw.githubusercontent.com/0xjesus/gitmess/main/install_script.sh && chmod +x install_script.sh && ./install_script.sh
🤔 Frequently Asked Questions:
Q: How does gitmess use GPT?
A: gitmess analyzes your changes and uses GPT's natural language processing capabilities to craft the perfect commit message.
📜 License:
This project is licensed under the MIT License. See the LICENSE
file for more details.
🌐 Happy coding and commit with style using gitmess! 🌐
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.