git-gpt

Gitp

This project helps automate the process of generating Git commit messages using OpenAI's API, while also providing several useful command-line options to customize the workflow.

Features

• OpenAI Integration: Generate commit messages and descriptions using the OpenAI API.
• Dry-run Mode: Simulate the OpenAI request without performing git operations (commit, push, or add).
• Default Ticket prefix for commits: Set prefix commits with Jira/Github/Gitlab ticket
• Conventional Commits Support: Use conventional commit format for specific repositories with semantic-release compatibility

Installation

npm install -g gitp

Quickstart

Configure your settings

Set API Key

gitp set-api-key <your api key>

Set Provider

gitp set-provider <provider>

Available providers: google, openai, deepseek

Set Model

gitp set-model <model>

Set up Git aliases

To create convenient git aliases for gitp commands:

gitp add-alias

This will add:

• git c as an alias for gitp commit
• git ca as an alias for gitp commit --add

Set a default ticket prefix

gitp set-default-ticket-for <path> <ticket>

Configure conventional commits for specific paths

gitp set-conventional-commits-for <path>

This will enable conventional commit format (feat:, fix:, etc.) for repositories matching the specified path. The path can be a regex pattern or simple string matching.

To remove a path from conventional commits:

gitp remove-conventional-commits-for <path>

To list all configured paths:

gitp list-conventional-commits

Usage

Generate and commit changes

To generate a commit message and description using the configured provider and commit the changes:

gitp commit

Dry-run mode

To simulate the request without performing git operations:

gitp commit --dry-run

Skip git commit hooks

To skip git commit hooks during the commit:

gitp commit --no-verify

Examples

Example 1: Basic commit

gitp commit

Output:

Message: Added new feature to handle user authentication
Description: Implemented user login and registration functionality. Updated the database schema to include user credentials. Added unit tests for the new feature.

Example 2: Dry-run mode

gitp commit --dry-run

Output:

Message: Added new feature to handle user authentication
Description: Implemented user login and registration functionality. Updated the database schema to include user credentials. Added unit tests for the new feature.
Dry-run enabled. Skipping commit and push.

Example 3: Set API key

gitp set-api-key sk-your-api-key

Example 4: Set default ticket prefix per path

gitp set-default-ticket-for project1 PROJECT1-0000

You can set as many as you want.

Example 5: Set provider and model

gitp set-provider openai
gitp set-model gpt-4

gitp set-provider deepseek
gitp set-model deepseek-coder

Example 6: Configure conventional commits

gitp set-conventional-commits-for my-project

This will generate commits like:

• feat: add new authentication feature
• fix: resolve login issue
• chore: update dependencies

When combined with default tickets:

• feat: PROJECT-123 add new authentication feature
• fix: PROJECT-123 resolve login issue

License

This project is licensed under the MIT License.