gittycat
v1.0.1
Published
A guided, interactive Git assistant that simplifies Git workflows
Readme
GittyCat
GittyCat is a friendly, guided, interactive CLI Git assistant. It simplifies Git workflows by using structured questions and menu-based navigation instead of requiring you to memorize Git commands.
Features ✨
- Interactive Menu: No more guessing commands. Just pick what you want to do from a clean list.
- Guided Workflows: Step-by-step prompts for Committing, Pushing, Pulling, and Branching.
- Beginner Mode 🎓: Toggle this on to get helpful explanations of what each Git action actually does under the hood.
- Safety First 🛡️: Recovery options like Soft and Hard resets with clear, explicit warnings to prevent accidental data loss.
- Fun Personality: A somewhat playful (but professional) cat-themed assistant to brighten your dev day!
Installation 📦
GittyCat requires Node.js (v18+ recommended).
To install globally so you can use it anywhere (run this from inside the GittyCat directory):
npm install -g .Usage 🚀
Navigate to any of your project directories (Git or non-Git) in your terminal and simply run:
gittycat
# or just the alias
gcIf the folder isn't a Git repository yet, GittyCat will politely ask if you'd like to initialize one!
Example Workflows 📋
The "Commit and Push" Flow:
- Run
gc - Select "Commit changes"
- Review the number of changed files found.
- Type your concise commit message.
- Select "Push project" to upload safely to GitHub.
The "Oops" Flow (Undo):
- Run
gc - Select "Undo / Recovery"
- Choose "Undo last commit (Keep files - Soft Reset)" to keep your work but undo the commit itself.
Tech Stack 🛠️
Node.jsinquirer: For beautiful, interactive command-line prompts.simple-git: For reliable, clean git operations.chalk: For adding purr-fect colors to the terminal.ora: For elegant loading spinners.conf: For remembering your Beginner Mode settings.
