https://github.com/shun-shobon/justcommit

AI-powered commit message generator
https://github.com/shun-shobon/justcommit

generator git gpt rust

Last synced: 2 months ago
JSON representation

AI-powered commit message generator

• Host: GitHub
• URL: https://github.com/shun-shobon/justcommit
• Owner: shun-shobon
• License: mit
• Created: 2023-03-19T15:36:14.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T21:15:49.000Z (8 months ago)
• Last Synced: 2024-05-20T15:11:43.660Z (8 months ago)
• Topics: generator, git, gpt, rust
• Language: Rust
• Homepage:
• Size: 319 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JustCommit

## Overview

JustCommit is an AI-powered commit message generator.

Based on the changes in your Git repository, it automatically suggests a commit message for you.

All you have to do is **Just Commit**.

This project is inspired by opencommit.

## Installation

You can either clone this repository and build it yourself using Rust or download the latest binary from the Release page.

Make sure to place the binary in a directory included in your system's path.

## Usage

Before committing with Git, execute JustCommit

It will automatically detect the staged changes in your Git repository and output a suggested commit message to the standard output.

While it currently only provides the output, future plans include supporting Git-hooks and launching an editor automatically.

## Configuration

JustCommit requires an OpenAI token to function. Place the token in `config.toml`. This configuration can be located in one of the following locations:

- `$XDG_CONFIG_HOME/justcommit` (For non-Windows users)

- `$APP_DATA/justcommit` (For Windows users)

- `$HOME/.config/justcommit` (If the above environment variables are not defined)

The configuration format is as follows:

```toml

openai_token = ""

```

If you're uncomfortable storing your token in plain text, you can use **a secret reference from 1Password**.

JustCommit will automatically detect the secret reference and use the token stored in 1Password.