Skip to main content

AI generated commit messages!

Project description

🐙 AI Commit Generator

Use AI to generate commit message for your staged changes.

⚡️ Features

  • Use local models (via Ollama) or remote models (with OpenAI API compatible providers like: openai, groq, gemini, togetherai, deepseek)
  • Use your preferred AI model
  • Regenerate commit messages until you find the perfect one
  • In-place editing of generated commit
  • Simple CLI interface with debug mode

⚡️ Install

pip install ai-gen-commit

✨ Generate Commit messages

In any git directory with staged changes, run:

aic

🔍 Run in debug mode

aic -d

🦙 Local Mode [Specify model to use]

aic -m <model-name>

aic -m "llama3.2:3b"

# OR

export OLLAMA_MODEL="llama3.2:3b"

🛜 Remote Mode

To run in remote mode, export your API keys as:

export OPENAI_API_KEY=<your-api-key>

Specify which remote provider to use:

export AI_COMMIT_PROVIDER="gemini" or "openai" or "togetherai" or "groq" or "deepseek"

then enable remote mode:

aic -r

Specify the model to use based on the provider's API key:

export AI_COMMIT_PROVIDER="openai"
aic -r -m "gpt-4o-2024-11-20"

# ---

export AI_COMMIT_PROVIDER="gemini"
aic -r -m "gemini-1.5-flash"

📝 In-place Editing

Set your editor environment variable:

export EDITOR=vim
export EDITOR=nvim

# For VSCode
export EDITOR='code --wait'

After commit message is generated, press e to edit using the defined $EDITOR.

Defaults to using vi.

Getting Help

aic -h

🔨 Development

👀 Prerequisites Local mode [default]

🚀 Setting up

make setup

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

ai_gen_commit-0.0.4.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

ai_gen_commit-0.0.4-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file ai_gen_commit-0.0.4.tar.gz.

File metadata

  • Download URL: ai_gen_commit-0.0.4.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ai_gen_commit-0.0.4.tar.gz
Algorithm Hash digest
SHA256 f32d65f203b234148e0e6b14a27af7d7d3d14ec7c416a9d4d6c2118e1315f81d
MD5 1047ea697cb3924ddfcc75a75b34a1b1
BLAKE2b-256 0aa3909350d1e9ca49bf2d3236720251bdbc908e7f0bdded609cab9c3322ba72

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_gen_commit-0.0.4.tar.gz:

Publisher: release.yml on yankeexe/ai-gen-commit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_gen_commit-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: ai_gen_commit-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ai_gen_commit-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 54ef68cfeee8b615d49255b48c2ba78619aaef10f538a3cb0c691da21b9a7639
MD5 b937919173d50c05dd52ca78bf79fce4
BLAKE2b-256 901a330a9b82cf48350740dae482cdbcea451e0a3e5cfb77a2f0e1d6f247b8ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_gen_commit-0.0.4-py3-none-any.whl:

Publisher: release.yml on yankeexe/ai-gen-commit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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