Skip to content

aymenhamada/Commayte

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Commayte

AI-powered git commit message generator with a beautiful interactive CLI.

Status Rust License

✨ Features

  • 🤖 AI-Powered: Uses Local AI LLM model for intelligent commit messages
  • 🎨 Beautiful UI: Interactive CLI with spinners and colors
  • 📝 Conventional Commits: Follows the conventional commit specification
  • 🔄 Interactive: Regenerate messages until you're satisfied
  • 🚀 Zero Setup: Automatic local Ollama installation

🚀 Quick Install

One command to install everything:

curl -fsSL https://github.com/aymenhamada/Commayte/releases/latest/download/install.sh | bash

That's it! The installer will:

  • ✅ Check prerequisites (Git, curl)
  • 📦 Install Ollama locally
  • 🤖 Interactive model selection (Phi3:latest or Mistral)
  • 📥 Download your chosen model
  • 📦 Install Commayte binary
  • ⚙️ Configure everything automatically

Supported Platforms:

  • 🐧 Linux (x86_64)
  • 🍎 macOS (Intel & Apple Silicon)
  • 🪟 Windows (x86_64, via Git Bash/WSL)

📖 Usage

  1. Stage your changes:

    git add .
  2. Generate commit message:

    commayte
  3. Choose your action:

    • ✅ Accept and commit
    • 🔄 Regenerate message
    • ❌ Cancel

📖 Example

# Before
git commit -m "fix stuff"

# After
commayte
# Generated: fix(client): resolve authentication token validation
# ✅ Accept and commit

Model Selection

The installer runs in interactive mode to let you choose your preferred AI model:

  • Mistral (default): Better quality, more consuming
  • Phi3:latest: Good balance of speed and quality

Manual Configuration

If you prefer a different model or want to change later, you can manually edit the configuration:

# Edit the config file
nano ~/.config/commayte/config.toml

# Change the model property
model = "your-preferred-model"

Then download your chosen model:

ollama pull your-preferred-model

🗑️ Uninstall

To completely remove Commayte:

curl -fsSL https://github.com/aymenhamada/Commayte/releases/latest/download/uninstall.sh | bash

The uninstaller will:

  • 🗑️ Remove Commayte binary
  • ⚙️ Clean up configuration files
  • 🛑 Stop Ollama service
  • 🧹 Clean up PATH configuration
  • 🤖 Optionally remove Ollama completely

🛠️ Development

For developers who want to build from source:

git clone https://github.com/aymenhamada/Commayte.git
cd Commayte
cargo build --release

Note: End users should use the one-line installer above. Building from source is only for contributors.

📄 License

MIT License - see LICENSE file.


Made with ❤️ by Aymen Hamada

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published