Skip to main content

GitMuse is an AI-powered tool that helps developers craft meaningful and descriptive Git commit messages.

Project description

GitMuse

GitMuse is an AI-powered tool that helps developers craft meaningful and descriptive Git commit messages. By analyzing your staged changes, GitMuse provides intelligent suggestions for your commit messages, making your Git history more informative and easier to navigate.

Features

  • AI-Powered Commit Messages: Leverages advanced AI models to generate context-aware commit messages.
  • Git Integration: Seamlessly integrates with your existing Git workflow.
  • Customizable: Adapt the AI suggestions to match your team's commit message style and conventions.
  • Interactive CLI: User-friendly command-line interface for easy interaction.
  • Diff Analysis: Intelligent analysis of your staged changes to provide accurate commit message suggestions.

Installation

pip install gitmuse

Usage

  1. Stage your changes as you normally would:

    git add .
    
  2. Instead of using git commit, use GitMuse:

    gitmuse commit
    
  3. GitMuse will analyze your changes and suggest a commit message. You can accept, modify, or reject the suggestion.

Configuration

GitMuse can be configured to match your preferences. Create a .gitmuserc file in your home directory:

ai_model: gpt-4
commit_style: conventional
max_message_length: 72

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

GitMuse is released under the MIT License. See the LICENSE file for more details.

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

gitmuse-0.1.1.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

gitmuse-0.1.1-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file gitmuse-0.1.1.tar.gz.

File metadata

  • Download URL: gitmuse-0.1.1.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for gitmuse-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2f70425771dee3364ef5e870ddb6bc8afb74d9e223b405911e242b7a8d536355
MD5 91a156d3349367c6a4d1e1cdfaa50fef
BLAKE2b-256 f7f4be41abbb7a5b895b969ba0b4a4e7d345e562ddff33eb5451cc08ce41d8f6

See more details on using hashes here.

File details

Details for the file gitmuse-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gitmuse-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for gitmuse-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4922a7fb8d662ed23a15273542313ddc8e268a226f12be5e6b1eb21ae27c810
MD5 b0d39f64ad444839239b1f688fb1b93e
BLAKE2b-256 8a025c9f70d81622e25ed1087575f8ebfc7b74a9871eae47affb5020ac50be06

See more details on using hashes here.

Supported by

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