gittu/README.md

Fast and simple git operations CLI tool for developers. Streamline your git workflow with powerful commands and intuitive interface.

# gittu 🚀

**Make git operations faster and easier with simplified commands**

A powerful CLI tool that streamlines your git workflow by combining multiple git operations into single, intuitive commands. Perfect for developers who want to speed up their daily git tasks with smart automation.

## ✨ Features

- **🚀 Quick Operations**: Add, commit, and push in one command
- **🤖 Smart Automation**: Auto-generated commit messages with file change detection
- **🌅 Daily Workflow**: Start your work day with latest updates
- **📁 Auto .gitignore**: Comprehensive .gitignore file generation
- **🔧 Easy Setup**: Initialize repositories with remote origin in seconds
- **🛡️ Safe Operations**: Checks for repository status before executing commands
- **↩️ Undo Support**: Easily undo commits while preserving changes

## 🛠️ Installation

### Global Installation (Recommended)
```bash
npm install -g gittu
```

### Local Installation
```bash
npm install gittu
```

## 🚀 Quick Start

```bash
# Initialize a new project
gittu init

# Add remote origin
gittu origin add https://github.com/username/repo.git

# Start your work day
gittu start

# Smart auto-commit
gittu auto

# Deploy changes
gittu deploy
```

## 📚 Commands

### Daily Workflow Commands
| Command | Description |
|---------|-------------|
| `gittu start` | Start your work day (pull latest + status) |
| `gittu auto` | Smart commit with auto-generated message |
| `gittu deploy` | Deploy changes (commit + push to remote) |
| `gittu update` | Update from remote (pull + auto-merge) |
| `gittu undo` | Undo the last commit (keeps changes) |

### Setup Commands
| Command | Description |
|---------|-------------|
| `gittu init` | Initialize git repository with comprehensive .gitignore |
| `gittu origin add <url>` | Add or update remote origin URL |

### Quick Operations
| Command | Description |
|---------|-------------|
| `gittu quick [message]` | Add + commit + push in one command |
| `gittu save [message]` | Add + commit (no push) in one command |
| `gittu push` | Push changes to remote repository |
| `gittu status` | Show detailed repository status |
| `gittu help` | Show detailed help and examples |

## 🤖 Smart Features

### Auto-Generated Commit Messages
When using `gittu auto` or commands without messages, gittu analyzes your changes and creates intelligent commit messages:

- **File analysis**: Detects added, modified, and deleted files
- **Smart counting**: Shows exactly what changed
- **Timestamps**: Includes current date for context

**Examples**:
```bash
gittu auto
# Creates: "Auto: 3 modified, 1 added - 2025-07-10"

gittu auto
# Creates: "Auto: 5 modified - 2025-07-10"
```

### Intelligent Workflow
- **Work detection**: Automatically saves uncommitted changes before updates
- **Branch awareness**: Handles upstream setup automatically
- **Conflict handling**: Graceful handling of merge conflicts
- **Safe operations**: Validates repository state before actions

## 💡 Usage Examples

### Daily Developer Workflow
```bash
# Morning routine
gittu start                    # Pull latest, check status

# During development
gittu auto                     # Quick smart commits
gittu save "WIP: new feature"  # Save work in progress

# End of day
gittu deploy                   # Deploy all changes

# If you made a mistake
gittu undo                     # Undo last commit
```

### Project Setup
```bash
# Start a new project
mkdir my-project && cd my-project
gittu init
gittu origin add https://github.com/username/my-project.git
```

### Smart Commits
```bash
# Auto-generated commit message based on changes
gittu auto

# Quick commit with custom message
gittu quick "feat: add user authentication"

# Save work without pushing
gittu save "WIP: working on feature"
```

## 🎯 Auto-generated .gitignore

When you run `gittu init`, it automatically creates a comprehensive .gitignore file:

| Category | Files Ignored |
|----------|---------------|
| **Node.js** | node_modules, npm logs, package-lock.json |
| **Build outputs** | dist, build directories |
| **IDE files** | .vscode, .idea, *.swp |
| **OS files** | .DS_Store, Thumbs.db |
| **Environment** | .env files |
| **Logs** | *.log files |
| **Temporary files** | tmp, temp directories |
| **Database files** | *.db, *.sqlite |
| **Archives** | *.zip, *.tar.gz |

## 📋 Requirements

| Requirement | Version |
|-------------|---------|
| **Node.js** | Version 14 or higher |
| **Git** | Must be installed and accessible via command line |
| **npm** | For package installation |

## 🌟 Why gittu?

- **Save Time**: Reduce 3-4 git commands to just one
- **Smart Automation**: Auto-generated commit messages based on actual changes
- **Reduce Errors**: Automated workflows prevent common mistakes
- **Better DX**: Focus on coding, not git command memorization
- **Consistent**: Same commands work across all projects
- **Beginner Friendly**: Simple commands with helpful feedback

## 📄 License

MIT License