aicommit-simongino 0.1.0

AI-powered git commit message generator

AI Commit

An AI-powered git commit message generator that helps you write better commit messages. Currently supports Qwen API, with planned support for OpenAI, Claude, and DeepSeek.

Features

• Generate meaningful commit messages based on your staged changes
• Support for multiple AI providers (currently Qwen, with more coming soon)
• Easy configuration and API key management
• Beautiful CLI interface with rich formatting
• Cross-platform support (Windows, macOS, Linux)

Installation

Option 1: Using Installation Scripts (Recommended)

On macOS/Linux:

# Download the installation script
curl -O https://raw.githubusercontent.com/SimonGino/aicommit/main/scripts/install.sh

# Make it executable
chmod +x install.sh

# Run the installer (requires sudo)
sudo ./install.sh

On Windows:

1. Open PowerShell as Administrator
2. Run the following commands:

# Download and run the installation script
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/SimonGino/aicommit/main/scripts/install.ps1" -OutFile "install.ps1"
.\install.ps1

Option 2: Manual Installation

1. Download the latest binary for your platform from the releases page
2. Add the binary to your system PATH:
   • Windows: Copy to C:\Program Files\aicommit\
   • macOS/Linux: Copy to /usr/local/bin/

Option 3: Using pip (Python package)

pip install aicommit

Configuration

Before using the tool, you need to configure your AI provider API key. Currently, Qwen API is supported:

aicommit config --provider qwen --api-key your-api-key-here

Usage

1. Stage your changes using git:

git add .  # or specific files

2. Generate and commit with AI-generated message:

aicommit

You can also specify a different provider:

aicommit --provider qwen  # Use Qwen API
aicommit --provider deepseek  # Use DeepSeek API

Or use it with a manual message (skips AI):

aicommit -m "your message"

Configuration

API Keys

1. For Qwen API:

aicommit config --provider qwen --api-key your-api-key

2. For DeepSeek API:

aicommit config --provider deepseek --api-key your-api-key

Language Settings

You can set the output language for commit messages:

aicommit config --language en      # English
aicommit config --language zh-CN   # Simplified Chinese
aicommit config --language zh-TW   # Traditional Chinese

Language Settings

You can configure the output language for commit messages. Currently supported languages:

• English (en)
• Simplified Chinese (zh-CN)
• Traditional Chinese (zh-TW)

aicommit config --language en     # Set to English
aicommit config --language zh-CN  # Set to Simplified Chinese
aicommit config --language zh-TW  # Set to Traditional Chinese

## Uninstallation

### On macOS/Linux:
```bash
# Download the uninstallation script
curl -O https://raw.githubusercontent.com/SimonGino/aicommit/main/scripts/uninstall.sh

# Make it executable
chmod +x uninstall.sh

# Run the uninstaller (requires sudo)
sudo ./uninstall.sh

On Windows:

1. Open PowerShell as Administrator
2. Run the following commands:

# Download and run the uninstallation script
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/SimonGino/aicommit/main/scripts/uninstall.ps1" -OutFile "uninstall.ps1"
.\uninstall.ps1

Development

1. Clone the repository
2. Install PDM if you haven't already:

pip install pdm

3. Install dependencies:

pdm install

4. Run the CLI:

pdm run aicommit

Building

Building Python Package

To build the package for Python distribution:

pdm build

Building Binary Executable

To build a standalone binary executable:

pdm run build-binary

This will create a single executable file in the dist directory that can be run without Python installation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT