git-copilot-commit 0.2.2

Automatically generate and commit changes using copilot

git-copilot-commit

AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.

Features

• Generates commit messages based on your staged changes
• Supports multiple AI models: GPT-4, Claude, Gemini, and more
• Allows editing of generated messages before committing
• Follows the Conventional Commits standard

Installation

Install the tool using uv (recommended)

Install uv:

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

You can install and run the latest version of tool directly every time by invoking this one command:

# Install latest version into temporary environment and run --help
uvx git-copilot-commit --help

Alternatively, you can install into a global isolated environment and run git-copilot-commit:

# Install into global isolated environment
uv tool install git-copilot-commit

# Run --help to see available commands
git-copilot-commit --help

Install with pipx

If you prefer to use pipx:

pipx install git-copilot-commit

Prerequisites

• Active GitHub Copilot subscription

Quick Start

1. Authenticate with GitHub Copilot:

   uvx git-copilot-commit authenticate
   

2. Make changes in your repository.

3. Generate and commit:

   uvx git-copilot-commit commit
   # Or, if you want to stage all files and accept the generated commit message, use:
   uvx git-copilot-commit commit --all --yes
   

Usage

Commit changes

$ uvx git-copilot-commit commit --help
Usage: git-copilot-commit commit [OPTIONS]

  Automatically commit changes in the current git repository.

Options:
  -a, --all         Stage all files before committing
  -m, --model TEXT  Model to use for generating commit message
  -y, --yes         Automatically accept the generated commit message
  --help            Show this message and exit.

Authenticate

$ uvx git-copilot-commit authenticate --help
Usage: git-copilot-commit authenticate [OPTIONS]

  Autheticate with GitHub Copilot.

Options:
  --help  Show this message and exit.

List models

$ uvx git-copilot-commit models --help
Usage: git-copilot-commit models [OPTIONS]

  List models available for chat in a table.

Options:
  --help  Show this message and exit.

Configure

$ uvx git-copilot-commit config --help
Usage: git-copilot-commit config [OPTIONS]

  Manage application configuration.

Options:
  --set-default-model TEXT  Set default model for commit messages
  --show                    Show current configuration
  --help                    Show this message and exit.

Examples

Commit all changes:

uvx git-copilot-commit commit --all

Accept the generated commit message without editing:

uvx git-copilot-commit commit --yes

Use a specific model:

uvx git-copilot-commit commit --model claude-3.5-sonnet

Set and use a default model:

uvx git-copilot-commit config --set-default-model gpt-4o
uvx git-copilot-commit commit
uvx git-copilot-commit commit --model claude-3.5-sonnet

Commit Message Format

Follows Conventional Commits:

<type>[optional scope]: <description>

Types:

• feat: New feature
• fix: Bug fix
• docs: Documentation
• style: Formatting only
• refactor: Code restructure
• perf: Performance
• test: Tests
• chore: Maintenance
• revert: Revert changes

Git Configuration

Add a git alias by adding the following to your ~/.gitconfig:

[alias]
    ai-commit = "!f() { uvx git-copilot-commit commit $@; }; f"

Now you can run:

git ai-commit
git ai-commit --all --yes --model claude-3.5-sonnet

Additionally, show more context in diffs by running the following command:

git config --global diff.context 3