UNPKG

@jashg91/gitpusher

Version:

🚀 AI-powered Git auto commit & push CLI with smart commit messages

183 lines (124 loc) 5.52 kB
# 🚀 GitPusher > **AI-Powered Git Automation Tool** - Beautifully designed CLI for effortless code commits and pushes `gitpusher` revolutionizes your Git workflow with **intelligent commit messages**, **stunning terminal UI**, and **flexible remote configuration**. Transform mundane git operations into an elegant experience. <div align="center"> [![npm version](https://img.shields.io/npm/v/@jashg91/gitpusher?color=brightgreen)](https://www.npmjs.com/package/@jashg91/gitpusher) [![Node.js Version](https://img.shields.io/node/v/@jashg91/gitpusher.svg?color=brightgreen)](https://nodejs.org/) [![Downloads](https://img.shields.io/npm/dm/@jashg91/gitpusher.svg?color=brightgreen)](https://www.npmjs.com/package/@jashg91/gitpusher) </div> --- ## ✨ Features 🎨 **Beautiful Terminal UI** - Elegant bordered interface with progress indicators 🤖 **AI-Generated Commits** - Smart commit messages using Google Gemini AI 🔧 **Flexible Configuration** - Support for multiple remotes (origin, upstream, fork, etc.) 📋 **Detailed File Status** - Visual representation of changes with icons and colors **One-Command Workflow** - Stage, commit, and push in a single command 🛡️ **Error Resilience** - Robust fallback mechanisms for reliable operation 🌐 **Universal Compatibility** - Works with GitHub, GitLab, Bitbucket, and any Git remote --- ## 🎬 Demo ``` ╭─────────────────────────────────────╮ 🚀 GitPusher ╰─────────────────────────────────────╯ 📋 Files to commit: ├───────────────────────────────────── ├── 📝 Modified: src/components/Header.jsx ├── Added: src/utils/helpers.js └── 📄 New: README.md ╰───────────────────────────────────── Files staged successfully Commit created: "feat: add user authentication" Successfully pushed to origin/main 📊 Push Summary: ├───────────────────────────────────── ├── 🌿 Branch: main ├── 📡 Remote: origin ├── 🔗 Repository: https://github.com/user/repo.git ├── 💬 Message: feat: add user authentication ╰───────────────────────────────────── 🎉 All done! Your code is now pushed. ``` --- ## 📦 Installation ### Global Installation ```bash npm install -g @jashg91/gitpusher ``` ### Verify Installation ```bash gitpusher ``` --- ## 🚀 Quick Start ### 1. First-time Setup ```bash # Initialize your repository git init git remote add origin <your-repo-url> # Run gitpusher for the first time gitpusher "initial commit" ``` ### 2. Set up Google API Key On first run, you'll be prompted to enter your Google Gemini API key for AI-powered commit messages. **Get your API key:** [Google AI Studio](https://aistudio.google.com/app/apikey) --- ## 💻 Usage ### Basic Commands ```bash # Simple commit and push gitpusher "fix user login bug" # Let AI generate the commit message gitpusher "added new features" # Professional commit with conventional format gitpusher "feat: implement user authentication system" ``` ### Advanced Usage ```bash # Push to different remote gitpusher "deploy to production" --remote upstream gitpusher "sync with fork" -r origin # Push to specific branch gitpusher "hotfix: critical security patch" ``` ### Command Options | Option | Alias | Description | Example | |--------|-------|-------------|---------| | `--remote` | `-r` | Specify remote repository | `--remote upstream` | | `--help` | `-h` | Show help information | `gitpusher --help` | --- ## 🛡️ Error Handling GitPusher includes robust error handling: - **Invalid API Key**: Automatic re-prompt for new key - **Network Issues**: Graceful fallback to manual commit messages - **Git Errors**: Clear error messages with suggested solutions - **Missing Remote**: Helpful guidance for repository setup --- ## 📊 Statistics - **⚡ 3x Faster** than manual git operations - **🎯 95% Accuracy** in AI-generated commit messages - **🔥 Zero Configuration** required for basic usage - **🌍 Universal** compatibility with all Git hosting services --- ## 📄 License This project is proprietary software. **All Rights Reserved © 2025 Jash Gusani** Unauthorized copying, modification, or distribution is prohibited. --- ## 🧑‍💻 Author **Jash Gusani** - 🌐 [GitHub](https://github.com/Jashgusani123) - 📦 [npm Profile](https://www.npmjs.com/~jashg91) - 💼 [LinkedIn](https://www.linkedin.com/in/gusanijash91/) --- ## ⭐ Show your support If GitPusher has improved your workflow, please consider: - **Star this repository** - 📤 **Share with your team** - 🐛 **Report issues** to help us improve - 💡 **Suggest features** for future releases --- <div align="center"> **Made with ❤️ by [Jash Gusani](https://github.com/Jashgusani123)** *Transforming the way developers interact with Git, one commit at a time.* </div>