Skip to content

README.md

Latest commit

 

History

History
35 lines (22 loc) · 614 Bytes

README.md

File metadata and controls

35 lines (22 loc) · 614 Bytes
Raw

generate-commit message

Installation

  1. Install the CLI:

    npm install -g generate-commit-message

  2. Obtain your API key from OpenAI

    Note: If you have not done so yet, you will need to register an account with OpenAI.

  3. Set openai key

    echo "OPENAI_API_KEY=<your token>" >> .env

Usage

  1. Generating commit messages:

    g-commit -g

  2. Staging changes

    g-commit -a