Skip to main content

git auto commit

Project description

gac (Git Auto Commit)

Python Contributions welcome Code Style: black Build Status codecov License: MIT

Features

  • AI-Powered Commit Messages: Automatically generates clear, concise, and context-aware commit messages using large language models.
  • Deep Contextual Analysis: Understands your code by analyzing staged changes, repository structure, and recent commit history to provide highly relevant suggestions.
  • Multi-Provider & Model Support: Flexibly works with various leading AI providers (like Anthropic, Groq, OpenAI) and models, easily configured through an interactive setup or environment variables.
  • Seamless Git Workflow: Integrates smoothly into your existing Git routine as a simple drop-in replacement for git commit.
  • Extensive Customization: Tailor commit messages to your needs with a rich set of flags, including one-liners (-o), AI hints (-h), commit scope (-s), and specific model selection (-m).
  • Streamlined Workflow Commands: Boost your productivity with convenient options to stage all changes (-a), auto-confirm commits (-y), and push to your remote repository (-p) in a single step.
  • Reroll Capability: Not satisfied with the generated commit message? Simply type r or reroll at the confirmation prompt to generate a new message.
  • Token Usage Tracking: Display token consumption statistics (prompt, completion, and total tokens).

How It Works

gac analyzes your staged changes to generate high-quality commit messages with the help of large language models.

How to Use

git add .
gac

Simple gac Usage

Installation and Configuration

1. Installation

Install system-wide using pipx from the GitHub repository:

# Install pipx if you don't have it
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install gac
pipx install git+https://github.com/criteria-dev/gac.git

Verify installation:

gac --version

2. Configuration

The recommended way to configure gac is using the interactive setup:

gac init

This command will guide you through selecting an AI provider, model, and securely entering your API keys. It will create or update a user-level configuration file at $HOME/.gac.env.

Example $HOME/.gac.env output:

GAC_MODEL=anthropic:claude-3-5-haiku-latest
ANTHROPIC_API_KEY=your_anthropic_key_here

Alternatively, you can configure gac using environment variables or by manually creating/editing the configuration file.

Managing Configuration with gac config

You can manage settings in your $HOME/.gac.env file using gac config commands:

  • Show config: gac config show
  • Set a value: gac config set GAC_MODEL groq:meta-llama/llama-4-scout-17b-16e-instruct
  • Get a value: gac config get GAC_MODEL
  • Unset a value: gac config unset GAC_MODEL

3. Verify Setup

Test that gac is working properly with your configuration:

# Make a change to a file
echo "# Test change" >> README.md
git add README.md
gac -o # Generate a one-line commit message

You should see an AI-generated commit message.

4. Upgrade

To upgrade gac to the latest version, run:

pipx upgrade gac

Basic Usage

Once installed and configured, using gac is straightforward:

  1. Stage your changes:

    git add .
    
  2. Run gac:

    gac
    

    This will generate a commit message for review. Confirm with y to accept the message.

Common Commands

  • Generate a commit message: gac
  • Auto-accept the commit message: gac -y
  • Stage all changes and generate a commit message: gac -a
  • Generate a one-line commit message: gac -o
  • Add a hint for the AI: gac -h "Fixed the authentication bug"
  • Push the commit (requires accepting the commit message): gac -p
  • Advanced usage: Add all, auto-confirm, push a one-liner with a hint: gac -aypo -h "update for release"

For a full list of CLI flags, advanced options, and example workflows, see USAGE.md.

Best Practices

  • gac loads configuration from two locations (in order of precedence):
    1. User-level $HOME/.gac.env (applies to all projects for the user)
    2. Project-level .env (in the project root, overrides user config if present) Environment variables always take final precedence over both files.
  • Keep API keys out of version control
  • For troubleshooting, see docs/TROUBLESHOOTING.md

Contributing

We welcome contributions! Please see docs/CONTRIBUTING.md for guidelines.

License

This project is licensed under the MIT License. See LICENSE for details.

Community & Support

For questions, suggestions, or support, please open an issue or discussion on GitHub.

Brought to you by Criteria

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gac_dev-0.14.8.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gac_dev-0.14.8-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file gac_dev-0.14.8.tar.gz.

File metadata

  • Download URL: gac_dev-0.14.8.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for gac_dev-0.14.8.tar.gz
Algorithm Hash digest
SHA256 33ac76422f7da1d1575bcbcdf119aa5d298a64fd350eb328f0b8efea62f3ded6
MD5 a12bf96938ea813f707735f757cba22b
BLAKE2b-256 06cdcb0e5d5967567fb929b70966938c733e42c88db295a8bd6458410c1ff439

See more details on using hashes here.

File details

Details for the file gac_dev-0.14.8-py3-none-any.whl.

File metadata

  • Download URL: gac_dev-0.14.8-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for gac_dev-0.14.8-py3-none-any.whl
Algorithm Hash digest
SHA256 eea5db0468a78fb268d15d9f54d52743521d84257d799a738c1d1fba18f21d50
MD5 0d881bd882f7e44e1296e8c4e24a9d38
BLAKE2b-256 ec49dc952f28ca8d8aa7118bd207de6071ef67f6430e3c381ad5bee0d9995cfb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page