Before you can use Script-Commit to generate commit messages, you'll need to set the OPENAI_API_KEY environment variable on your machine. You can obtain an API key from the OpenAI API website.
To generate a commit message based on your staged changes, follow these steps:
- Stage your changes using
git addcommand. For example, to stage all changes in the current directory, run:
git add .
- Run
npx script-commitcommand in your terminal. This will generate a commit message based on your changes and copy it to your clipboard.
That's it! You've successfully generated and committed your changes with a commit message generated by Script-Commit.