Giter Club home page Giter Club logo

got's Introduction

GOT

GOT is a command-line tool designed to enhance your git workflow by integrating AI-driven commit message suggestions. It leverages models from both OpenAI and Groq to suggest relevant commit messages based on the changes you've made.

Features

  • AI-Driven Commit Suggestions: Utilize models like GPT-3.5, GPT-4, and Groq open source models to generate commit messages.
  • Interactive Commit Process: Choose commit messages from suggested options or enter manually.
  • Commit and Push: Option to automatically add, commit, and push changes to a remote repository.

got

Installation

Install from pip

pip install got-cli

API Tokens

GOT leverages powerful AI models from OpenAI's Chat GPT and GROQ Cloud. To enable these features, you must configure the API tokens as environment variables.

Before using the CLI, set up your environment variables based on the model you intend to use. These tokens will authenticate your requests to the respective services.

# Set the OpenAI Chat GPT API token
export CHAT_GPT_TOKEN=<Your_Chat_GPT_API_Token>

# Set the GROQ API key
export GROQ_API_KEY=<Your_GROQ_API_Key>

Usage

Committing Changes

To commit changes with AI-generated messages:

got commit -a -p

Options:

  • -a: Add all changes to stage before committing.

  • -p: Push changes to the remote repository after committing.

  • -m: Specify the language model to use for generating commit messages (Default: gpt-4-turbo).

  • -t: Specify maximum amount of tokens to be used by the model (Default: 4096).

    Available models: gpt-3.5-turbo, gpt-4-turbo, gemma-7b-it, llama2-70b-4096, llama3-70b-8192, llama3-8b-8192, mixtral-8x7b-32768

Modifying Prompts

To modify the prompts and examples used by the cli:

got prompt --set-example

Options:

  • --restore: Restore the default prompts.
  • --set-example: Set examples of the desired output.

Contributing

Contributions are welcome! Feel free to submit pull requests or open issues to suggest improvements or add new features.

License

This project is open source and available under the MIT License.

got's People

Contributors

guipimenta-dev avatar

Stargazers

João Hang avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.