🚀 GitGuru (gg)

An intelligent Git CLI powered by Google's Gemini AI to supercharge your Git workflow with smart insights and automated commit messages.

   ██████╗ ██╗████████╗ ██████╗ ██╗   ██╗██████╗ ██╗   ██╗
  ██╔════╝ ██║╚══██╔══╝██╔════╝ ██║   ██║██╔══██╗██║   ██║
  ██║  ███╗██║   ██║   ██║  ███╗██║   ██║██████╔╝██║   ██║
  ██║   ██║██║   ██║   ██║   ██║██║   ██║██╔══██╗██║   ██║
  ╚██████╔╝██║   ██║   ╚██████╔╝╚██████╔╝██║  ██║╚██████╔╝
   ╚═════╝ ╚═╝   ╚═╝    ╚═════╝  ╚═════╝ ╚═╝  ╚═╝ ╚═════╝ 

✨ Features

• 💬 Natural Language — Ask Git questions in plain English and get instant command suggestions
• 🤖 AI Commit Messages — Generate meaningful, conventional commit messages automatically
• 🛡️ Safety Analysis — Every suggestion includes safety indicators to prevent dangerous operations
• 📚 Interactive Learning — Learn Git concepts with AI explanations that adapt to your skill level
• 🎨 Beautiful Output — Syntax-highlighted output with intuitive status displays
• 📊 Repo Analysis — Get insights about repository health, patterns, and collaboration metrics

📦 Installation

npm install -g gitguru

Or using yarn:

yarn global add gitguru

Prerequisites

• Node.js 16+ — GitGuru requires Node.js version 16 or higher
• Git — Git must be installed and configured on your system
• Gemini API Key — A free API key from Google AI Studio

🚀 Quick Start

# 1. Add your Gemini API key
gg addkey YOUR_GEMINI_API_KEY

# 2. Verify installation
gg about

# 3. Ask your first question
gg ask "how do I create a new branch?"

💻 Basic Usage

# Ask questions in natural language
gg ask "undo last commit but keep changes"

# Generate AI-powered commit messages
gg commit --ai

# Learn Git concepts
gg explain "What is a rebase?"

# Enhanced status with visual indicators
gg status

📖 Documentation

For comprehensive documentation, visit gitguru-docs.vercel.app

| Resource | Description | |----------|-------------| | Getting Started | Installation and setup guide | | Commands Reference | All available commands | | AI Features | Understanding AI capabilities | | Configuration | Customizing GitGuru | | Workflows | Real-world usage examples | | Best Practices | Tips for effective usage |

🔑 Getting a Gemini API Key

1. Visit Google AI Studio
2. Sign in with your Google account
3. Click "Create API Key"
4. Copy the key and run gg addkey YOUR_KEY

🤝 Contributing

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

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

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

👨‍💻 Author

Parth Mongia

• GitHub: @Parth308
• Email: [email protected]

📮 Support

• 🐛 Report bugs
• 💡 Request features
• ⭐ Star on GitHub
• 📖 Documentation