An AI genius for generating meaningful git commit messages from repository state and user instructions.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.
commit-whisperer.mov
Install with npm:
$ npm install --save commit-whispererCommit Whisperer is a CLI and API for crafting meaningful commit messages using AI.
By analyzing the current state of your project and any provided instructions, it helps generate commit messages that accurately describe your changes.
Installation
To use Commit Whisperer, first ensure you have it installed as a dependency in your project:
npm install commit-whisperer --save-dev
# or
pnpm i commit-whisperer -D
# or
yarn add commit-whisperer --devUsage
import { whisper } from 'commit-whisperer';The whisper function is the primary method provided by Commit Whisperer. It generates a commit message based on the project's state and user input.
- cwd (string, optional): The current working directory. Defaults to
process.cwd(). - useGitState (boolean, optional): Whether to include the git state in the message generation. Defaults to
true. - usePackageJson (boolean, optional): Whether to include
package.jsondetails. Defaults totrue. - message (string, optional): An initial message or instructions to guide the commit message generation.
- instructions (string, optional): Specific instructions for the commit message.
- diff (boolean, optional): Whether to include the git diff in the message. Defaults to
false. - orgId (string, optional): OpenAI organization ID. Defaults to
process.env.OPENAI_ORG_ID. - apiKey (string, optional): OpenAI API key. Defaults to
process.env.OPENAI_API_KEY. - openaiConfig (object, optional): Additional configuration passed directly to the OpenAI API. Useful for customizing parameters like
temperature,model, or overriding the default messages array. - formatContent (function, optional): Custom function to format the content sent to OpenAI.
A promise that resolves to an OpenAI response object with an additional content property containing the generated commit message.
const response = await whisper({ message: 'First commit' });
console.log(response.content);git diff
Pass git diff to the LLM as context:
const response = await whisper({
message: 'First commit',
diff: true
});
console.log(response.content);Installation
npm install -g commit-whisperer
# or
pnpm add -g commit-whisperer
# or
yarn global add commit-whispererUsage
Commit Whisperer can be used from the command line using either the commit-whisperer or cw command:
cw [options] [text]
# or
commit-whisperer [options] [text]-M, --max-tokens: Maximum number of tokens for the response (default: 1000)-m, --model: OpenAI model to use (default: gpt-4o)-t, --temperature: Temperature for response generation (default: 0.8)-s, --stream: Stream the output as it's generated (default: true)-d, --debug: Enable debug mode to show timing information (boolean)-D, --diff: Include git diff in the context (boolean)-h, --help: Display help message
Generate a commit message with default settings:
cw "Update documentation"Include git diff in the commit message context:
cw "Describe changes" -DUse a different model with custom temperature:
cw -m o1-preview -t 0.5 "Refactor authentication"Commit Whisperer relies on OpenAI's API to generate commit messages. Ensure you have set your OpenAI API key and organization ID in your environment variables:
OPENAI_API_KEY: Your OpenAI API key.OPENAI_ORG_ID(optional): Your OpenAI organization ID.
You can extend the functionality of Commit Whisperer by providing custom formatting functions and OpenAI configurations through the formatContent and openaiConfig parameters respectively.
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testBuilding docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbJon Schlinkert
Copyright © 2024, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on November 07, 2024.