/commitai

Primary LanguageJavaScript

Commit AI

A command-line application built with Node.js that generates git commit messages using OpenAI's GPT-3 model. This app runs git diff in the current working directory, sends the output to the GPT-3 model, and presents multiple commit message suggestions. The user can then choose a message, and the app will commit the changes using the selected message.

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/tommyle/commit_ai_nodejs.git
  1. Change to the cloned directory:
cd commit_ai_nodejs
  1. Install dependencies:
npm install

Usage

  1. Set your OpenAI API key:
npm run build-and-run --set_api_key

You'll be prompted to enter your API key, which will be saved to a local file for future use.

  1. Run the app to generate a commit message and commit the changes:
npm run start app.js

The app will display multiple commit message suggestions based on the git diff output. Choose a message and the app will commit the changes using the selected message.

Optional arguments

  • --help or -h: Display help information.
npm run start app.js --help
  • --show_diff or -d: Show the git diff output.
npm run start app.js --show_diff

License

This project is licensed under the MIT License - see the LICENSE file for details.