gitglow

v1.0.0

Published

7 days ago

Make your git history beautiful - emoji commits, pretty logs, and aesthetic workflows

0High
0Medium
0Low

nirholas

git emoji commits pretty cli gitmoji conventional-commits developer-tools beautify workflow

✨ gitpretty

Make your git history beautiful

git log --oneline

Before: 😴

a1b2c3d Update stuff
e4f5g6h Fix thing
i7j8k9l Add feature

After: ✨

a1b2c3d ✨ Add user authentication
e4f5g6h 🐛 Fix login validation  
i7j8k9l 📝 Update documentation

🚀 Quick Start

# Clone gitpretty
git clone https://github.com/nirholas/gitpretty.git

# Make your repo beautiful
./gitpretty/emoji-file-commits.sh /path/to/your-repo

# Push and admire on GitHub ✨
cd /path/to/your-repo && git push

Result: Every file shows a unique emoji in GitHub's file browser!

🛠️ Tools

Core Scripts

| Script | Description | |--------|-------------| | emoji-file-commits.sh | Add emojis visible in GitHub | | emoji-commits.sh | Safe mode (empty commits) |

Git Workflow

| Script | Example | |--------|---------| | emoji-commit.sh | "add auth" → ✨ Add auth | | emoji-branch.sh | feature login → feature/login | | emoji-merge.sh | feature/auth → ✨ Merge feature: auth | | emoji-stash.sh | save wip "testing" → 🚧 testing | | emoji-log.sh | graph / today / week | | emoji-tag.sh | v1.0.0 minor → ✨ v1.0.0 | | emoji-hooks.sh | Auto-emoji all commits |

GitHub Actions

| Workflow | Trigger | |----------|---------| | emoji-commits.yml | Auto-beautify on push | | commit-lint.yml | Validate PR commits | | changelog.yml | Auto changelog on release |

💬 Smart Commits

./scripts/emoji-commit.sh "add dashboard"
# → ✨ Add dashboard

./scripts/emoji-commit.sh "fix login bug"
# → 🐛 Fix login bug

./scripts/emoji-commit.sh "update readme"
# → 📝 Update readme

Auto-detection: | Keyword | Emoji | Keyword | Emoji | |---------|-------|---------|-------| | add, feat | ✨ | fix, bug | 🐛 | | docs | 📝 | style | 💄 | | refactor | ♻️ | test | ✅ | | config | ⚙️ | security | 🔐 | | deploy | 🚀 | remove | 🗑️ |

🪝 Auto-Emoji Hooks

# Install once
./scripts/emoji-hooks.sh install

# Every commit gets auto-emoji!
git commit -m "add feature"
# 🪝 Auto-added: ✨
# ✨ Add feature

📜 Pretty Logs

./scripts/emoji-log.sh graph    # ASCII graph
./scripts/emoji-log.sh today    # Today's commits
./scripts/emoji-log.sh week     # This week by day
./scripts/emoji-log.sh author   # Group by author

📦 Stash Management

./scripts/emoji-stash.sh save wip "working on auth"
# → 🚧 working on auth

./scripts/emoji-stash.sh list
# Beautiful stash list with emojis

| Type | Emoji | Type | Emoji | |------|-------|------|-------| | wip | 🚧 | experiment | 🧪 | | temp | ⏳ | backup | 🔐 | | idea | 💡 | debug | 🔍 |

⚙️ Git Aliases

Add to ~/.gitconfig:

[alias]
    pretty = "!~/.gitpretty/scripts/emoji-commit.sh"
    pl = "!~/.gitpretty/scripts/emoji-log.sh"
    ps = "!~/.gitpretty/scripts/emoji-stash.sh"

Usage:

git pretty "add feature"  # ✨ Add feature
git pl graph              # Pretty log graph
git ps list               # Pretty stash list

📚 Docs

📄 License

MIT