Skip to content

CLI to let GPT-3 write commit messages for a given diff

Notifications You must be signed in to change notification settings

tiborpilz/commitomatic

Repository files navigation

DeepSource DeepSource

Commitomatic

Commitomatic is a command-line tool that uses the OpenAI GPT-Codex to generate commit messages based on a git diff.

Dependencies

Nix

Commitomatic uses Nix to manage dependencies. You need to have Nix installed to build and run Commitomatic.

OpenAI API key

Commitomatic uses the OpenAI API to generate commit messages. You need to have an OpenAI API key to use Commitomatic. You can create one here. Note that you need to be signed up to OpenAI to use the API.

Commitomatic reads the OpenAI API key from the OPENAI_API_KEY environment variable. You can set it in your shell configuration file.

Running Commitomatic

To run Commitomatic, you need have a git repository with staged changes. You can then run Commitomatic inside of the repository's directory with the following command:

nix run github:tiborpilz/commitomatic .

Commitomatic will then generate a commit message based on the staged changes and open your editor to let you edit the commit message. After you save and close the editor, Commitomatic will commit the staged changes using the commit message.

About

CLI to let GPT-3 write commit messages for a given diff

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published