https://github.com/dejorrit/commit-assist

Auto generate commit messages using ChatGPT
https://github.com/dejorrit/commit-assist

ai chatgpt cli git

Last synced: about 1 month ago
JSON representation

Auto generate commit messages using ChatGPT

• Host: GitHub
• URL: https://github.com/dejorrit/commit-assist
• Owner: dejorrit
• Created: 2023-04-22T16:23:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-04-23T16:21:25.000Z (over 1 year ago)
• Last Synced: 2024-10-02T11:36:25.215Z (2 months ago)
• Topics: ai, chatgpt, cli, git
• Language: TypeScript
• Homepage:
• Size: 57.6 KB
• Stars: 14
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-chatgpt - commit-assist - Automatically generate Git commit messages. (CLI tools / Examples)
• awesome-ChatGPT-repositories - commit-assist - Auto generate commit messages using ChatGPT (CLIs)
• awesome-chatgpt - CommitAssist
• awesome-chatgpt - commit-assist - Automatically generate Git commit messages. (CLI tools / Examples)
• awesome-gpt - CommitAssist

README

        
# CommitAssist

[![NPM](https://img.shields.io/npm/v/commit-assist.svg)](https://www.npmjs.com/package/commit-assist)

Auto generate commit messages using ChatGPT

![Preview](https://raw.githubusercontent.com/dejorrit/commit-assist/main/preview.gif)

## Installation

To install CommitAssist, simply run the following command:

```bash

yarn global add commit-assist

```

## Usage

To generate commit messages using CommitAssist, follow these simple steps:

Stage the files you want to commit. Then run:

```bash

git-ca

```

The first time you run the tool, it will prompt you for your OpenAI API key. If you don't have one, you can get yours by visiting the [OpenAI API Keys](https://platform.openai.com/account/api-keys) page.

### Resetting your API Key

If you need to reset your API Key for any reason, simply run the following command:

```bash

git-ca reset

```

## Important Information

Please note that using the OpenAI API is not free. However, OpenAI offers each new user $18 worth of credit to get started.