Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gpt-auto-commit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GPT Auto Commit

GPT Auto Commit Screenshot

GPT Auto Commit is a lightweight CLI tool that uses OpenAI’s GPT models to automatically generate clear, standards-compliant commit messages.

Why

Commit messages are the foundation of maintainable software. They drive changelogs, guide future debugging, and communicate intent across teams. Yet, writing them is often inconsistent, rushed, or forgotten entirely.

GPT Auto Commit helps developers maintain quality without adding friction. By analyzing staged changes and generating conventional commit messages, it enforces consistency while saving time so teams can focus on shipping code instead of debating message formats.

Features

Generate commit messages with a single command
Interactive mode to review or edit messages before committing
Works only on staged changes for precision
Follows Conventional Commits for consistent versioning and changelogs
Clean, colorful CLI interface for a smooth developer experience
Built-in progress indicators for responsive feedback

Installation

npm install -g gpt-auto-commit

API Key & Pricing

GPT Auto Commit requires an OpenAI API key.

Sign up for an OpenAI account
Create a new API key

Note: Usage costs depend on the model you select.

Setup

Configure your API key before first use:

gpt-auto-commit config --key YOUR_OPENAI_API_KEY
# or use the shorthand
gpc config --key YOUR_OPENAI_API_KEY

Model Configuration

The default model is gpt-4o-mini for cost efficiency, but you can configure others:

# Set a different model
gpc config --model gpt-4o
gpc config --model gpt-3.5-turbo

# Set both API key and model at once
gpc config --key YOUR_API_KEY --model gpt-4o

# View current configuration
gpc config

See the full list of available models.

Usage

Quick Commit (Recommended)

Automatically generate and commit with one command:

gpc

Process:

Analyze staged changes
Generate a commit message
Commit with the generated message

Interactive Mode

Review or edit before committing:

gpc generate

Options:

c to commit as generated
e to edit the message
q to quit without committing

Commands

All commands are available via gpt-auto-commit or shorthand gpc:

gpc - Quick generate and commit
gpc generate - Interactive mode with edit options
gpc config --key <key> - Set your OpenAI API key
gpc config --model <model> - Set your OpenAI model
gpc config - View current configuration
gpc --help - Show help information