Generate commit messages using GPT3 based on your changes and commit history.

Brian Le

Last update: Jan 3, 2023

Related tags

Utilities commit

Overview

Commit

Generate commit messages using GPT-3 based on your changes and commit history.

Install

You need Rust and Cargo installed on your machine. See the installation guide here.

Then clone the repo and install the CLI globally like this:

cargo install --path .

Usage

commit uses GPT-3. To use it, you'll need to grab an API key from your dashboard, and save it to OPENAI_API_KEY as follows (you can also save it in your bash/zsh profile for persistance between sessions).

export OPENAI_API_KEY='sk-XXXXXXXX'

Once you have configured your environment, run commit in any Git repository with staged changes.

To get a full overview of all available options, run commit --help

$ commit --help
Generate commit messages using GPT-3 based on your changes and commit history.

Usage: commit [OPTIONS] [FILES]...

Arguments:
  [FILES]...  Files to stage and commit

Options:
  -c, --commits <COMMITS>        Number of commits in history to use generating message [default: 50]
  -t, --max-tokens <MAX_TOKENS>  Maximum number of tokens to use generating message [default: 2000]
      --copy                     Copy the commit message to clipboard instead of committing
      --no-commit                Don't commit, just print the commit message to stdout
  -y, --yes                      Answert "Yes" to prompts
  -h, --help                     Print help information
  -V, --version                  Print version information

Tool written in rust to read for file changes and accordingly run build commands.

Sniff A simple tool written in rust to read for file changes and accordingly run build commands. Note this tool is for linux and linux only. If it hap

4 Oct 2, 2022

messloc is a drop in replacement for malloc that can transparently recover from memory fragmentation without any changes to application code.

messloc is a drop in replacement for malloc that can transparently recover from memory fragmentation without any changes to application code. Goals Al

11 Dec 10, 2022

Rust program to monitor Windows 10 Registry keys for changes or modifications.

RegMon This Rust program monitors changes to multiple registry keys in Windows 10 and writes the changes to a text file. It also periodically sends a

3 Jan 16, 2023

Universal changelog generator using conventional commit+ with monorepo support. Written in Rust.

chlog Universal changelog generator using conventional commit+ with monorepo support. chlog can generate the changelog from the conventional commits w

3 Nov 27, 2022

Better error messages for axum framework.

axum-debug This is a debugging crate that provides better error messages for axum framework. axum is a great framework for developing web applications

3 Feb 3, 2022

Log defmt messages over the serial port.

defmt-serial A defmt target for logging over a serial port. Messages can e.g. be read using socat and passed through defmt-print, see example-artemis

10 Oct 5, 2022

"Philips Ambilight for desktops". A tool to generate color palettes from your desktop wallpaper and send them to Home Assistant.

Desktop Dye DesktopDye is an open source project written in Rust that allows users to have their lights paired with Home Assistant adjust to the most

7 Feb 22, 2023

📝 Generate your README.md from Rust doc comments

cargo-onedoc 📝 Generate README.md from doc comments. Only write your documentation once! This crate provides a Cargo subcommand that can generate Mar

2 Dec 14, 2022

Generate an HTML page based on a Notion document

Notion Generator Generate an HTML page based on a Notion document! Still a bit of a work in progress, but I am about to actually use it for some actua

9 Dec 14, 2022

Comments

Unable to generate commit message
Hey, thanks for creating this tool - looking forward to it making my workflow much more streamlined!

I'm having issues generating my commit messages - as far as I can tell the executable built properly and installed globally with cargo as intended. I have my OpenAI API key set as a global bash export variable, and can log it to the terminal so that seems okay. However, when trying to generate a commit message with my locally added changes, the following is outputted: `✔ Got commit message!

Failed to generate commit message.`

(shown in full here:)

Looking at the OpenAI dashboard the API isn't getting queried via that key at all on their end.

Any pointers as to what might be the cause here, or how I can get some more verbose logs, would be appreciated!

System information

MacBook Pro 2019, Intel Silicon.

macOS Ventura 13.0.1

git version 2.38.1

Shell: GNU bash, version 3.2.57(1)-release (x86_64-apple-darwin22)

rustc 1.66.0 (69f9c33d7 2022-12-12)

cargo 1.66.0 (d65d197ad 2022-11-15)
opened by b-d-e 2