git-busy

Crates.iogit-busy
lib.rsgit-busy
version1.0.0
sourcesrc
created_at2022-12-31 06:16:37.003268
updated_at2022-12-31 06:16:37.003268
descriptionA wrapper around "git commit" that generates the commit messages for you
homepagehttps://github.com/coderdan/goodcommit
repositoryhttps://github.com/coderdan/goodcommit
max_upload_size
id748259
size889,492
Dominik Wilkowski (dominikwilkowski)

documentation

README

   ██████╗  ██╗ ████████╗     ██████╗  ██╗   ██╗ ███████╗ ██╗   ██╗
  ██╔════╝  ██║ ╚══██╔══╝     ██╔══██╗ ██║   ██║ ██╔════╝ ╚██╗ ██╔╝
  ██║  ███╗ ██║    ██║        ██████╔╝ ██║   ██║ ███████╗  ╚████╔╝
  ██║   ██║ ██║    ██║        ██╔══██╗ ██║   ██║ ╚════██║   ╚██╔╝
  ╚██████╔╝ ██║    ██║        ██████╔╝ ╚██████╔╝ ███████║    ██║
   ╚═════╝  ╚═╝    ╚═╝        ╚═════╝   ╚═════╝  ╚══════╝    ╚═╝

git busy cli interface

Let the computer write the commit message for you

What it does

This tool helps you write commit messages

git history example

git-busy sends the output of git diff --staged --ignore-all-space to the GPT3 API and asks the model to write a commit message based off of the diff. It then allows you to choose from three suggestions and you will be able to edit before it calls git commit.

If you supply a -m or --message flag GPT3 will not be consulted and instead your supplied message will be used for the commit.

Use git-busy instead of git commit. All flags you write are passed on.

Requirements

You will need an API key for GPT3 as an environment variable called GPT_API_KEY. Go to https://beta.openai.com/account/api-keys to create an account and the required key.

💡 Large diffs won't work well so keep them small

Install

cargo install git-busy

Usage

Usage: git busy [<options>] [--] <pathspec>...

💡 Any arguments and flags are passed onto git commit.

License

Licensed under the GNU GPL-3.0-or-later.

Commit count: 40

cargo fmt