s41r4j
255 lines
7.3 KiB
Markdown
255 lines
7.3 KiB
Markdown
# 🚀 GIMS - Git Made Simple
|
|
|
|
<div align="center">
|
|
|
|
[](https://npmjs.org/package/gims)
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://nodejs.org/)
|
|
[](https://github.com/yourusername/gims)
|
|
|
|
**The AI-powered Git CLI that writes your commit messages for you**
|
|
|
|
*Because life's too short for "fix stuff" commits* 🎯
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## ✨ What is GIMS?
|
|
|
|
GIMS is a revolutionary Git CLI tool that uses AI to automatically generate meaningful commit messages from your code changes. Say goodbye to generic "update code" commits and hello to descriptive, professional commit messages that actually tell a story.
|
|
|
|
### 🎬 See It In Action
|
|
|
|
```bash
|
|
# Traditional Git workflow 😴
|
|
git add .
|
|
git commit -m "update stuff" # 🤦♂️
|
|
git push
|
|
|
|
# GIMS workflow ⚡
|
|
g o # AI analyzes changes, commits with perfect message, and pushes!
|
|
```
|
|
|
|
## 🌟 Features
|
|
|
|
### 🤖 **AI-Powered Commit Messages**
|
|
- **OpenAI GPT-4** integration for intelligent commit message generation
|
|
- **Google Gemini** support for lightning-fast analysis
|
|
- Smart diff analysis that understands your code changes
|
|
- Handles large codebases with intelligent summarization
|
|
|
|
### ⚡ **Lightning Fast Workflow**
|
|
- **One command commits**: `g o` - analyze, commit, and push in seconds
|
|
- **Smart suggestions**: `g s` - get AI-generated messages copied to clipboard
|
|
- **Local commits**: `g l` - commit locally with AI messages
|
|
- **Instant setup**: `g i` - initialize repos in a flash
|
|
|
|
### 🧠 **Intelligent Code Analysis**
|
|
- Analyzes actual code changes, not just file names
|
|
- Understands context from function changes, imports, and logic
|
|
- Handles everything from bug fixes to feature additions
|
|
- Graceful fallbacks for extremely large changesets
|
|
|
|
### 🛠️ **Developer-Friendly**
|
|
- **Numbered commit history**: Easy navigation with `g ls`
|
|
- **Smart branching**: `g b 5` creates branch from commit #5
|
|
- **Safe operations**: Built-in error handling and validation
|
|
- **Clean interface**: Intuitive commands that just make sense
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
npm install -g gims
|
|
```
|
|
|
|
### Setup AI (Choose One)
|
|
|
|
**Option 1: OpenAI (Recommended)**
|
|
```bash
|
|
export OPENAI_API_KEY="your-api-key-here"
|
|
```
|
|
|
|
**Option 2: Google Gemini (Faster)**
|
|
```bash
|
|
export GEMINI_API_KEY="your-api-key-here"
|
|
```
|
|
|
|
### Your First AI Commit
|
|
|
|
```bash
|
|
# Make some changes to your code
|
|
echo "console.log('Hello GIMS!');" > hello.js
|
|
|
|
# Let AI commit it for you
|
|
g o
|
|
# Output: Committed & pushed: "Add hello world console log"
|
|
```
|
|
|
|
## 📖 Commands Reference
|
|
|
|
| Command | Alias | Description | Example |
|
|
|---------|-------|-------------|---------|
|
|
| `gims init` | `g i` | Initialize new Git repo | `g i` |
|
|
| `gims clone <repo>` | `g c` | Clone repository | `g c https://github.com/user/repo` |
|
|
| `gims suggest` | `g s` | Generate & copy commit message | `g s` |
|
|
| `gims local` | `g l` | AI commit locally | `g l` |
|
|
| `gims online` | `g o` | AI commit + push | `g o` |
|
|
| `gims pull` | `g p` | Pull latest changes | `g p` |
|
|
| `gims list` | `g ls` | Show numbered commit history | `g ls` |
|
|
| `gims largelist` | `g ll` | Detailed commit history | `g ll` |
|
|
| `gims branch <n>` | `g b` | Branch from commit #n | `g b 3 feature-x` |
|
|
| `gims reset <n>` | `g r` | Reset to commit #n | `g r 5 --hard` |
|
|
| `gims revert <n>` | `g rv` | Safely revert commit #n | `g rv 2` |
|
|
|
|
## 💡 Real-World Examples
|
|
|
|
### 🔧 Bug Fix
|
|
```bash
|
|
# You fix a null pointer exception
|
|
g o
|
|
# AI generates: "Fix null pointer exception in user authentication"
|
|
```
|
|
|
|
### ✨ New Feature
|
|
```bash
|
|
# You add a search function
|
|
g o
|
|
# AI generates: "Add search functionality with pagination support"
|
|
```
|
|
|
|
### 📚 Documentation
|
|
```bash
|
|
# You update README and add comments
|
|
g o
|
|
# AI generates: "Update documentation and add inline code comments"
|
|
```
|
|
|
|
### 🎨 Refactoring
|
|
```bash
|
|
# You clean up code structure
|
|
g o
|
|
# AI generates: "Refactor authentication module for better maintainability"
|
|
```
|
|
|
|
## 🔥 Pro Tips
|
|
|
|
### 🎯 **Perfect Workflow**
|
|
```bash
|
|
# Daily development cycle
|
|
g p # Pull latest changes
|
|
# ... code your features ...
|
|
g s # Preview AI suggestion
|
|
g l # Commit locally first
|
|
# ... test your changes ...
|
|
g push # Push when ready
|
|
```
|
|
|
|
### 🧠 **Smart Branching**
|
|
```bash
|
|
g ls # See numbered history
|
|
g b 5 hotfix # Branch from commit #5
|
|
g l # Make changes and commit
|
|
g checkout main && g pull # Back to main
|
|
```
|
|
|
|
### 🛡️ **Safe Experimentation**
|
|
```bash
|
|
g l # Commit your experiment
|
|
# ... code breaks something ...
|
|
g r 1 --soft # Soft reset to previous commit
|
|
# ... fix and try again ...
|
|
```
|
|
|
|
## ⚙️ Configuration
|
|
|
|
### Environment Variables
|
|
|
|
| Variable | Purpose | Required |
|
|
|----------|---------|----------|
|
|
| `OPENAI_API_KEY` | OpenAI API access | One of these |
|
|
| `GEMINI_API_KEY` | Google Gemini API access | One of these |
|
|
|
|
### Smart Fallbacks
|
|
|
|
GIMS handles edge cases gracefully:
|
|
|
|
- **🔄 Large diffs**: Automatically switches to file summary mode
|
|
- **📊 Massive changes**: Falls back to status-based analysis
|
|
- **🛜 No API key**: Uses sensible default messages
|
|
- **⚠️ API failures**: Graceful degradation with helpful errors
|
|
|
|
## 🤝 Contributing
|
|
|
|
We love contributions! Here's how to get involved:
|
|
|
|
1. **🍴 Fork** the repository
|
|
2. **🌿 Create** your feature branch: `git checkout -b amazing-feature`
|
|
3. **💻 Code** your improvements
|
|
4. **🧪 Test** thoroughly
|
|
5. **📝 Commit** with GIMS: `g l` (dogfooding!)
|
|
6. **🚀 Push** and create a Pull Request
|
|
|
|
### 🐛 Found a Bug?
|
|
|
|
1. Check [existing issues](https://github.com/yourusername/gims/issues)
|
|
2. Create a [new issue](https://github.com/yourusername/gims/issues/new) with:
|
|
- Clear description
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Your environment details
|
|
|
|
## 📊 Why GIMS?
|
|
|
|
### Before GIMS 😫
|
|
```bash
|
|
git log --oneline
|
|
abc1234 fix
|
|
def5678 update
|
|
ghi9012 changes
|
|
jkl3456 stuff
|
|
mno7890 final fix
|
|
```
|
|
|
|
### After GIMS ✨
|
|
```bash
|
|
git log --oneline
|
|
abc1234 Fix authentication timeout in user login service
|
|
def5678 Add responsive design for mobile navigation menu
|
|
ghi9012 Refactor database connection pool for better performance
|
|
jkl3456 Update API documentation with new endpoint examples
|
|
mno7890 Fix memory leak in image processing pipeline
|
|
```
|
|
|
|
## 📈 Stats
|
|
|
|
- ⚡ **10x faster** commits than traditional Git workflow
|
|
- 🎯 **95%+ accuracy** in commit message relevance
|
|
- 📚 **Zero learning curve** - if you know Git, you know GIMS
|
|
- 🌍 **Works everywhere** - Mac, Windows, Linux, WSL
|
|
|
|
## 🗺️ Roadmap
|
|
|
|
- [ ] 🔌 Plugin system for custom AI providers
|
|
- [ ] 📊 Commit message templates and customization
|
|
- [ ] 🌐 Multi-language commit message support
|
|
- [ ] 🔄 Integration with popular Git GUIs
|
|
- [ ] 📱 Mobile companion app
|
|
|
|
## 📄 License
|
|
|
|
MIT © [Your Name](https://github.com/yourusername)
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
|
|
**⭐ Star this repo if GIMS makes your Git workflow awesome!**
|
|
|
|
[Report Bug](https://github.com/yourusername/gims/issues) • [Request Feature](https://github.com/yourusername/gims/issues) • [Documentation](https://github.com/yourusername/gims/wiki)
|
|
|
|
*Made with ❤️ by developers who hate writing commit messages*
|
|
|
|
</div> |