autommit

Description

Autommit is a simple tool to automatically commit and push changes to a git repository.

It uses the OpenAI API and your local git cli to generate appropriate commit messages for your changes.

Requirements

• OpenAI API key (either in cli with --openai-api-key or OPENAI_API_KEY environment variable)
• git executable in your $PATH
• If you want to sign/verify your commits, make sure you have a PGP key pair (public and private keys). If you don't have a PGP key pair, you can generate one using GnuPG. Then provide the --pgp-key-path flag to autommit as follows:

⚠️ Note: Do not use a password for your PGP key. autommit can't handle it (:

autommit --pgp-key-path /path/to/your/pgp/key

Usage

❯ autommit --help
Usage of autommit:
  -conventional-commits-type string
        Will add the provided type to the commit message (default "feat")
  -git-config-path string
        Will set the git config path (default "~/.gitconfig")
  -git-mail string
        Will set the git email
  -git-user string
        Will set the git user
  -max-chars int
        Will set the max characters for the commit message (default 80)
  -openai-api-key string
        OpenAI API key
  -path string
        Path to the git repository (default ".")
  -pgp-key-path string
        Path to the PGP key
  -sign-commits-with-message string
        Will add the provided message to the long commit message (default "Created by autommit 🦄")
  -t string
        Alias of --conventional-commits-type (default "feat")
  -version
        Will show the version of autommit

Demo

• Asciinema rec

The commit that was created: https://github.com/aorfanos/autommit/commit/6ffab96bf686621fc8dbd2c3db25c15c858ef753

Also don't try the api key, it won't work :D

Installation

Available builds

OS/Platform	Architecture	Supported
Linux	amd64	✅
Linux	arm64	✅
MacOS/Darwin	amd64	✅
MacOS/Darwin	arm64	✅
Docker	amd64	✅
Docker	arm64	TODO
Windows	amd64	❌
Windows	arm64	❌

Install

There are several options to run autommit. Sorting from fastest to more engaged:

1. Fetch binary from this repo's releases page

Get the latest release from https://github.com/aorfanos/autommit/releases/latest/download/autommit-- and place it in your $PATH. E.g. for Linux amd64:

wget https://github.com/aorfanos/autommit/releases/latest/download/autommit-linux-amd64 -O autommit && \
chmod +x autommit && \
sudo mv autommit /usr/local/bin

2. Use the Docker image

⚠️ Note: The Docker image is currently unstable. Prefer the binary builds. Use at your own risk.

docker run -it -e OPENAI_API_KEY=$OPENAI_API_KEY -e GIT_ACC_MAIL="$(git config user.email)" -e GIT_ACC_NAME="$(git config user.name)" -v $(pwd):/app:rw ghcr.io/aorfanos/autommit:latest

3. Build from source

make build && \
mv autommit-dev /usr/local/bin/autommit