✨ Features

• 🔍 Smart Analysis — Reads your git diff --cached and understands what changed
• 🤖 LLM-Powered — Uses Groq's blazing-fast Llama 3 70B for high-quality suggestions
• 📝 Conventional Commits — Auto-prefixes with feat:, fix:, refactor:, etc.
• 🎨 Beautiful CLI — Rich terminal output with colors and formatting
• ⚡ One Command — Run commitwise, pick a message, done
• 🔒 Privacy-First — Only staged diffs are sent; nothing leaves your machine otherwise

📦 Installation

pip install commitwise-cli

Or install from source:

git clone https://github.com/Md-Shamir-raza/commitwise.git
cd commitwise
pip install -e .

🔑 Setup

You need a free Groq API key.

Option 1: Environment variable

export GROQ_API_KEY=your_api_key_here

Option 2: .env file

Create a .env file in your project root:

GROQ_API_KEY=your_api_key_here

🚀 Usage

# Stage your changes
git add .

# Generate AI commit messages
commitwise

What happens:

1. CommitWise reads your staged changes via git diff --cached
2. Sends the diff to Groq (Llama 3 70B) for analysis
3. Displays 3 commit message suggestions in Conventional Commits format
4. You pick one (1/2/3) or type your own custom message
5. The commit is automatically applied

🎬 Demo

📖 Example

🧠 CommitWise  v0.1.0

⠋ Analyzing changes…

╭─ ✦ Suggested Commit Messages ────────────────────────╮
│                                                       │
│  1. feat: add user authentication middleware          │
│  2. feat: implement JWT token validation for routes   │
│  3. chore: add auth dependencies to requirements      │
│                                                       │
╰───────────────────────────────────────────────────────╯

Enter 1, 2, or 3 to pick a suggestion, or type your own message.

❯ 1

✓ Committed: feat: add user authentication middleware

⚙️ How It Works

┌─────────────┐     ┌──────────────┐     ┌───────────┐     ┌────────────┐
│  git add .   │ ──▶ │  commitwise  │ ──▶ │  Groq API │ ──▶ │ git commit │
│  (you stage) │     │  (reads diff)│     │ (Llama 3) │     │  (applied) │
└─────────────┘     └──────────────┘     └───────────┘     └────────────┘

🛡️ Edge Cases Handled

🏗️ Project Structure

commitwise/
├── commitwise/
│   ├── __init__.py          # Package metadata
│   ├── cli.py               # Click CLI entry point
│   ├── git_utils.py         # Git subprocess wrappers
│   ├── llm.py               # Groq API integration
│   └── prompt_templates.py  # LLM prompt definitions
├── .env.example             # API key template
├── pyproject.toml           # PyPI packaging config
├── README.md
└── LICENSE

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

# Clone the repo
git clone https://github.com/Md-Shamir-raza/commitwise.git
cd commitwise

# Install in development mode
pip install -e .

# Run locally
commitwise

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.