Skip to main content

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:

  1. 🔥 Auto-Generated Commit Messages: No more time wasted thinking about the perfect commit message.
  2. 📏 Conventionalcommits v1.0.0 Standard: Ensures that your commits align with best practices.
  3. 🤖 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:

  1. Open Command Prompt as administrator.
  2. Run the following command:
    curl -LO https://raw.githubusercontent.com/0xjesus/gitmess/main/install.bat && install.bat
    

macOS:

  1. Open the Terminal.
  2. 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:

  1. Open the Terminal.
  2. 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.

Source Distribution

gitmess-0.1.5.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitmess-0.1.5-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file gitmess-0.1.5.tar.gz.

File metadata

  • Download URL: gitmess-0.1.5.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for gitmess-0.1.5.tar.gz
Algorithm Hash digest
SHA256 aeee0cac452b426bfcf668c797890e6c973e24341fe46970966f5006536d7d27
MD5 d9a9694a150d6ee233192b6f5433468c
BLAKE2b-256 7cd4b2f3df7e58572b78edc00e01807068ceae2a249fdffe5d87acb23ae6eaa0

See more details on using hashes here.

File details

Details for the file gitmess-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: gitmess-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for gitmess-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 858355503a7478a838e49cfc17d1e37bb5d05279f7dc2e18a1838da90b1ca3fe
MD5 cd28b229efdcf3aa27470100476db86e
BLAKE2b-256 846f5c28bfdd4b731a75314dd80f393147a69c71d95e7ec491ca5135eae2f2ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page