commit-chad
v1.1.0
Published
A CLI tool that uses AI to generate commit messages.
Downloads
9
Maintainers
Readme
Commit Chad
Introduction
Commit Chad is a command-line tool built with zx that leverages the Google Gemini AI API to perform automatically commit message generation with your staged changes.
Installation
- First, get a Google Gemini API key for free here. Alternatively, you can use the OpenAI API as well. Get an API key for free here.
- Next, set the
GEMINI_API_KEYorOPENAI_API_KEYenvironment variable to your API key:
export GEMINI_API_KEY=<your-api-key>
# or
export OPENAI_API_KEY=<your-api-key>- Finally, install the
commit-chadcommand usingnpm:
npm install -g commit-chadThis will install the commit-chad command globally, allowing you to use it from anywhere in your terminal.
Usage
commit-chad [options]Options
-h, --help: Display help for the command-v, --version: Display the version of the command-y, --yes: Skip the the confirmation prompt except for the commit message. Default isfalse.-d, --debug: Enable debug mode, which will log the commands output. Default isfalse.-dr, --dry-run: Perform a dry run of the command without actually committing the changes. Default isfalse- --openai: Use the OpenAI API as ai provider. Default is
true. - --gemini: Use the Google Gemini API as ai provider. Default is
false.
Examples
- Example 1: Skip the some trivial confirmation prompts and enable debug mode
commit-chad --yes --debug- Example 2: Perform a dry run of the command
commit-chad --dry-runContributing
If you would like to contribute to this project, fill free to open an issue or submit a pull request at ease.
