GitWise 🌳

The Ultimate AI-Powered Git Companion

GitWise revolutionizes your Git workflow with AI-driven insights and intelligent version control.

Key Features • Installation • Usage • Contributing

---

🚀 Overview

GitWise is your intelligent Git companion that brings the power of AI to your version control workflow. It understands your code changes, generates meaningful commit messages, and provides insightful summaries of your Git history.

✨ Why GitWise?

• 🤖 AI-Powered Understanding: Get intelligent summaries of code changes that focus on what matters
• 📝 Smart Commit Messages: Generate clear, concise, and meaningful commit messages automatically
• 🔍 Flexible Git Navigation: Work with any git reference - branches, commits, tags, or relative refs
• 🎯 Customizable Insights: Tailor AI analysis to focus on what you care about - security, performance, or API changes
• 🛠️ Developer-Friendly: Built in Rust for speed and reliability, with an intuitive CLI interface
• 🚀 Intelligent PRs: Create pull requests with AI-generated titles and descriptions

🎯 Perfect for:

• Teams wanting to maintain high-quality git history
• Developers reviewing large changes or complex PRs
• Code reviewers needing quick insights into changes
• Anyone wanting to understand code changes more efficiently

🌟 Key Benefits

• Save Time: Get instant, meaningful summaries of code changes
• Improve Quality: Generate consistent, well-formatted commit messages
• Better Understanding: Focus on the important changes with AI-powered insights
• Enhanced Collaboration: Make code reviews and history exploration more efficient
• Flexible Usage: Works with any Git workflow and supports all types of repositories

---

Current Features

🔍 AI-Powered Diff Summarization

• Get intelligent summaries of git differences
• Support for any git reference (branches, commits, tags)
• Understand complex changes at a glance
• Compare staged changes or between any two references

🤖 Smart Commit Messages

• Generate descriptive commit messages automatically
• Follows git commit message best practices
• AI-powered understanding of code changes
• Imperative mood and concise descriptions

🚀 Pull Request Creation

• Create PRs with AI-generated titles and descriptions
• Automatically generate comprehensive PR descriptions from your changes
• Support for custom base branches and remote repositories
• Override AI-generated content with custom titles and descriptions
• Seamless integration with GitHub through the GitHub CLI

📜 Advanced Git History

• Explore commit history with AI summaries
• Start from any git reference (branch, tag, or commit)
• Flexible reference syntax support
• Semantic understanding of code evolution

🎯 Git Reference Support

• Flexible reference resolution for all commands
• Supports:
  • Branch names (e.g., main, feature/new-feature)
  • Full commit hashes
  • Short commit hashes (minimum 4 characters)
  • Tags
  • Relative references (e.g., HEAD~1, HEAD^)

Planned Features

🔎 Smart Branch Comparison (Coming Soon)

• Compare any two branches with AI-powered summaries
• Get high-level insights about changes between branches
• Understand complex changes at a glance

📦 Smart Staging (Coming Soon)

• Automatically group staged changes by logical units
• Generate meaningful commit messages for each group
• Improve commit granularity without manual file selection

🔍 Semantic Git History Search (Coming Soon)

• Search through commit history using natural language
• Find related commits using semantic similarity
• Vector embedding powered search for better results

✨ History Rewriting (Coming Soon)

• Improve commit message quality across entire branches
• Safe defaults with new branch creation
• Integrity checks to ensure content preservation
• Interactive mode for fine-grained control

Installation

Prerequisites

• Rust (1.70 or later)
• Git
• OpenAI API key
• GitHub CLI (gh) - Required for PR creation
• Anthropic API key (Preferred)

Building from Source

# Clone the repository
git clone https://github.com/yourusername/gitwise.git
cd gitwise

# Create .env file and add your API keys
echo "ANTHROPIC_API_KEY=your_claude_api_key" > .env  # Preferred
echo "OPENAI_API_KEY=your_openai_api_key" >> .env     # Fallback

# Ensure GitHub CLI is installed and authenticated
gh auth login

# Build the project
cargo build --release

# The binary will be available at
./target/release/gitwise

AI Provider Support

GitWise supports multiple AI providers for enhanced reliability and flexibility:

1. Claude Sonnet (Preferred)

   • Provider: Anthropic
   • Model: claude-3-sonnet-20240229
   • Features: All core functionality
   • Setup: Add ANTHROPIC_API_KEY to .env

2. GPT-3.5 Turbo (Fallback)

   • Provider: OpenAI
   • Model: gpt-3.5-turbo
   • Features: All core functionality
   • Setup: Add OPENAI_API_KEY to .env

The system will automatically use Claude if available, falling back to OpenAI if needed.

Usage Examples

Intelligent Diff Analysis

# Compare branches with custom focus
gitwise diff main feature/new-feature --prompt "Focus on security changes"

# Analyze staged changes
gitwise diff --staged --prompt "List modified functions"

Smart Commit Messages

# Generate AI-powered commit message
gitwise commit

Pull Request Creation

# Create PR with AI-generated title and description
gitwise pr create

# Create PR with custom base branch
gitwise pr create --base develop

# Create PR with custom title (AI-generated description)
gitwise pr create --title "Add user authentication"

# Create PR with custom title and description
gitwise pr create --title "Add user authentication" --body "Implements JWT authentication"

History Analysis

# View recent changes with AI insights
gitwise history --count 5
gitwise history --reference feature/branch --prompt "Focus on API changes"

Development

Project Structure

src/
  ├── main.rs           # Entry point and CLI handling
  ├── ai/               # AI integration for summaries
  ├── cli/              # CLI interface (coming soon)
  ├── ui/               # TUI components (coming soon)
  ├── git/              # Git operations (coming soon)
  └── utils/            # Common utilities

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some 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.

Acknowledgments

• Built with Rust
• Git operations via git2-rs
• AI powered by OpenAI and Anthropic
• Terminal UI powered by Ratatui (coming soon)