commit-air v1.0.1

Commit-Air - Automated Commit Message Generator

Commit-Air is a Node.js-based application that generates commit messages from code diffs using the OpenAI API. It aims to streamline the process of creating meaningful and descriptive commit messages for your Git repositories.

Installation

To use Commit-Air, you need to have Node.js installed. You can install Commit-Air globally by running the following command:

npm install -g commit-air

Alternatively, you can run Commit-Air without installing it globally using npx:

npx commit-air

Usage

1. First-Time Setup: When running Commit-Air for the first time, it will prompt you to provide an API key for the OpenAI API.

2. Generating Commit Messages: To generate a commit message, navigate to a Git repository with uncommitted staged changes and run Commit-Air with the appropriate commit type:

commit-aid <type>

Replace <type> with the type of commit you want to make. The available commit types are: "feat", "fix", "docs", "style", "refactor", "test", or "chore".

3. Multi-Line Commit Body: If you wish to include a multiline commit message body, you can use the --force-body flag:

commit-air <type> --force-body

4. Debug Mode: To see the intermediate steps and debug information, use the --debug flag:

commit-air <type> --debug

Example

To generate a commit message for a new feature, you would run:

commit-air feat

This will create a commit message based on the changes you've staged for the "feat" (feature) type.

Note

Commit-Air relies on the OpenAI API for generating commit messages, so you may need to manage your API usage and consider any potential costs associated with API calls.

Commit-Air simplifies the process of generating informative commit messages for your Git repositories, making it easier to maintain a clean and well-documented project history. Happy coding! :rocket: