Skip to main content

AI-powered git commands for summarizing changes

Project description

Git AI Summarize

A command-line tool for summarizing changes in Git repositories using AI.

Installation

pip install git-ai-summarize

Requirements

  • Python 3.8 or higher
  • An API key for Anthropic (or your preferred LLM)

Setup

Set an environment variable with your LLM API key. To use the default Anthropic model, use:

export ANTHROPIC_API_KEY='your-api-key-here'

Add this to your shell profile to make it permanent.

Commands

Summarize changes between commits

Provide a commit hash or a range of commits to get a summary of the changes.

# Compare with HEAD
git summarize <commit-hash>

# Compare any two commits
git summarize <commit1>..<commit2>

Pull and summarize changes

Pass the --pull flag to pull changes from the remote and summarize the changes since the last pull.

git summarize --pull

Using alternative LLM providers/models

You can pass the --provider and --model argument to use a different LLM provider/model. The default provider is anthropic, and the default model is claude-3-5-sonnet-latest. To get a list of all supported providers, run:

git summarize --list-providers

To get a list of all supported models for a provider, see the LLM providers' documentation.

Depending on the provider, you may need to set additional environment variables with that provider's API key (e.g., ANTHROPIC_API_KEY for Anthropic/Claude, OPENAI_API_KEY for OpenAI/GPT, etc.).

To change your default provider/model, you can set the GIT_SUMMARIZE_PROVIDER and GIT_SUMMARIZE_MODEL environment variables.

If you would like to use a model by a provider that is not currently supported by this package, feel free to submit an Issue with the name of the model/provider and we can look into it. If it is supported by LangChain, we can most likely add it.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

GNU GPLv3 License

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

git_ai_summarize-0.1.2.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

git_ai_summarize-0.1.2-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file git_ai_summarize-0.1.2.tar.gz.

File metadata

  • Download URL: git_ai_summarize-0.1.2.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for git_ai_summarize-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d8b95cc7c470fef7ddc61ce61209c1d7087700089668e65388bcd97463f6671e
MD5 0261842e86af869c4b57739ee6ebeab1
BLAKE2b-256 a78f264a8c6325c898fa96eadce4054c92239d3e4e877c3ef0a82ce2a79d1755

See more details on using hashes here.

File details

Details for the file git_ai_summarize-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for git_ai_summarize-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cca5b8b91a51abcee2ed0676c8c4073189ae339283776d7875906377ccac2034
MD5 a25f2a175c53875fb6bea8af7b038005
BLAKE2b-256 92547b332ce3c2d1a62e1e10ff2ade2b1f4a4680ce8606b8e912f9600f3390c1

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