termi-gotchi
v1.0.0
Published
A CLI Tamagotchi that eats your code commits
Maintainers
Readme
Termi-Gotchi
A CLI Tamagotchi that lives in your terminal and eats your code commits!
Installation
# Clone the repository
git clone <repo-url>
cd termi-gotchi
# Install dependencies
npm install
# Build the project
npm run build
# Link globally (optional, but recommended for CLI usage)
npm linkUsage
1. Initialize Git Hook
Run this in any git repository where you want your pet to live:
termi-gotchi initThis installs a post-commit hook that will feed your pet automatically.
2. Feed Your Pet
Just commit code!
git commit -m "Fix bug"Your pet will appear briefly, eat the commit, and gain XP based on lines added/deleted. Refactoring (deleting lines) gives more XP!
3. Check Status manually
You can check on your pet anytime:
termi-gotchiFeatures
- Hunger System: Your pet gets hungry if you don't commit for 4 hours.
- Level Up: Gain XP to level up your pet.
- Moods: Happy, Hungry, Sleeping.
Technologies
- Ink (React for CLI)
conffor state persistencesimple-gitfor git integration
