pet-terminal

v1.0.2

Published

11 days ago

A virtual pet that lives in your terminal and VS Code. Grows as you code!

Pet Terminal

A virtual pet for your terminal AND VS Code status bar - earns rewards when you make Git commits!

A CLI virtual pet and gamified productivity companion for developers.

Features • Installation • Quick Start • Commands • Philosophy

If this project helps you, please give it a

Features

CLI & VS Code Hybrid

Choose your pet: Cat or Dog with unique ASCII art
Git integration: Earn coins and XP automatically when you make commits
Smart rewards: Bug fixes earn more than features - gamified motivation!
Shop system: Buy food, toys, medicine, and cleaning supplies
Level progression: Watch your pet grow stronger through care
One-click care: Busy? Run pet care to handle everything at once
Lenient decay: Stats decay slowly - your pet stays healthy for days!
Streak bonuses: Maintain daily commit streaks for extra rewards

🧩 VS Code Extension

Status Bar Monitor: See your pet's name, emoji, health, and level in the bottom-right corner
Side Panel Dashboard: Tamagotchi-style visual interface with retro ASCII art
Native Git Integration: Automatically rewards XP and Coins when you commit code using VS Code's Source Control
Interactive Commands: Feed, play, and release your pet via the Command Palette
Real-time Updates: Status bar refreshes every 3 seconds

Installation

CLI (Terminal)

npm install -g pet-terminal

Or use with npx without installing:

npx pet-terminal init

VS Code Extension

Option 1: Install from .vsix

Download the latest .vsix from Releases
In VS Code, go to Extensions → ... → Install from VSIX
Reload VS Code

Option 2: Build and Run (Development)

Clone the repo and run npm install
Press F5 in VS Code to launch the Extension Development Host

Quick Start

# Create your first pet
pet init

# Check on your pet
pet status

# After coding, collect rewards
pet git

# One-click care for busy developers
pet care

# See all commands
pet --help

Commands

| Command | Aliases | Description | |---------|---------|-------------| | pet init | - | Create a new pet | | pet status | - | Display your pet's status with ASCII art | | pet feed | - | Feed your pet from inventory | | pet play | - | Play with your pet | | pet clean | - | Clean your pet | | pet heal | - | Heal your pet with medicine | | pet sleep | - | Put pet to sleep / wake up | | pet care | auto, all | One-click care for all needs | | pet inventory | inv, items | Show your inventory | | pet shop | store | Visit the pet shop | | pet git | commits | Check for new Git commits & earn rewards | | pet sync | - | Sync time after being away | | pet release | - | Say goodbye to your pet forever | | pet tutorial | help, guide | Show the interactive tutorial |

Philosophy

"Writing code = being with your pet"

Pet Terminal isn't a chore - it's a companion. Unlike traditional virtual pets that demand attention, your pet gains stats automatically when you do what you already do: write code and commit.

This is a zero-burden companion designed to make your coding sessions more enjoyable, not another task on your todo list.

How It Works

Earning Rewards

Every Git commit earns you coins and XP based on the commit type:

| Commit Type | Prefix Examples | Coins | XP | |-------------|-----------------|-------|-----| | Bug Fix | fix:, bug:, fix( | +10 | +20 | | Feature | feat:, add:, feat( | +8 | +15 | | Refactor | refactor:, refactor( | +6 | +12 | | Normal | any other | +5 | +10 |

Stat Bonuses

Every commit also gives automatic stat boosts:

Hunger +15: Your pet feels fed seeing you work
Happiness +10: Your pet is happy you're here

Stat Decay

Stats decay slowly over real-time:

| Stat | Decay Rate | Time to Empty (from 100%) | |------|-----------|--------------------------| | Hunger | -3/hour | ~33 hours | | Happiness | -0.67/hour | ~150 hours (~6 days) | | Cleanliness | -0.125/hour | ~800 hours (~33 days) | | Energy | -2/hour (awake) | ~50 hours |

The decay is intentionally lenient - your pet stays healthy for days without attention!

Streak Bonuses

Maintain a daily commit streak for bonus rewards:

3+ days: +2 stat bonus per commit
7+ days: +5 stat bonus per commit, +10 daily coins
30+ days: +5 stat bonus per commit, +50 daily coins

Screenshots

Pet Status

╔══════════════════════════════════════════╗
║         SPARKY THE CAT                   ║
╚══════════════════════════════════════════╝

   /\_/\           Status: ⚡ Awake
  ( o.o )
   > ^ <    Mood: 😊 HAPPY - Sparky is feeling wonderful!

──────────────────────────────────────────
Hunger        ███████████████░░░░  80%
Happiness     ████████████████░░░░  85%
Health        ███████████████████░  95%
Cleanliness   ████████████░░░░░░░░  70%
Energy        ██████████████████░░  90%
──────────────────────────────────────────

Level: 5 ████████████████░░░░ 85/100 XP

Coins: 150 🪙   |   Git Streak: 5 days

Git Rewards

╔══════════════════════════════════════════╗
║              GIT COMMITS                 ║
╚══════════════════════════════════════════╝

Current Streak: 5 days   |   Total Rewarded: 42 commits

Found 3 new commit(s)!

94b2b6e - feat: add new authentication system
  [Feature] +8 🪙 +15 XP  📦 Large Commit Bonus!

a1b2c3d - fix: resolve memory leak in parser
  [Bug Fix] +10 🪙 +20 XP

d4e5f6g - refactor: simplify database queries
  [Refactor] +6 🪙 +12 XP

──────────────────────────────────────────
Total: +24 🪙  +47 XP  🔥 Streak Bonus! +5 🪙

Configuration

Optional config file at ~/.pet-terminal/config.json:

{
  "decayRate": 1.0,
  "autoCare": {
    "enabled": false,
    "thresholds": {
      "hunger": 70,
      "happiness": 60,
      "cleanliness": 60,
      "health": 70
    }
  }
}

| Option | Type | Default | Description | |--------|------|---------|-------------| | decayRate | number | 1.0 | Global decay multiplier (0.5-2.0) | | autoCare.enabled | boolean | false | Enable auto-purchase alerts | | autoCare.thresholds | object | - | Stat thresholds for care reminders |

Pet Species

| Species | Description | Special Trait | |---------|-------------|---------------| | 🐱 Cat | Independent and graceful | Higher happiness cap | | 🐕 Dog | Loyal and energetic | Faster energy recovery |

Tips & Tricks

Forgot about your pet? Run pet sync to catch up on time passed
Low on supplies? Use pet care to see what you need
Want quick coins? Make some commits and run pet git
Pet sleeping? Let them sleep to restore energy
Stats low? Use pet care for one-click care of all needs

Contributing

Contributions of all kinds are welcome! Whether you're a seasoned developer or just getting started, there are many ways to help make Pet Terminal better:

Ways to contribute:

🐛 Fix bugs and issues
🎨 Design new pets or improve ASCII art
✨ Add new features (new items, mini-games, stat systems, etc.)
📝 Improve documentation
🌍 Add translations/Internationalization support
💡 Share ideas and suggestions

Getting Started:

Fork the repository
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'feat: add amazing feature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Please check CONTRIBUTING.md for detailed guidelines, CHANGELOG.md for version history, and CODE_OF_CONDUCT.md for community guidelines.

Thank you for considering contributing! Every contribution helps make Pet Terminal more enjoyable for everyone. 🐾

License

MIT License - see LICENSE file for details

🧩 VS Code Extension

Pet Terminal is a hybrid CLI + VS Code extension. Use either interface or both!

Available Commands

Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and search for:

Pet: Feed - Feed your pet from inventory
Pet: Play - Play with your pet
Pet: Release / Say Goodbye - Delete your pet permanently

Usage

Create a pet using the CLI: pet init
Open any folder in VS Code
Your pet appears in the status bar (bottom-right) and Activity Bar (side panel)
Make Git commits and watch the rewards flow in!

Credits

Built with:

Commander.js - CLI framework
Chalk - Terminal styling
Inquirer - Interactive prompts
lowdb - JSON database

Made with 💜 for developers who love their terminal pets

If you enjoy Pet Terminal, please give it a

GitHub • npm

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Pet Terminal

Features

CLI & VS Code Hybrid

🧩 VS Code Extension

Installation

CLI (Terminal)

VS Code Extension

Quick Start

Commands

Philosophy

How It Works

Earning Rewards

Stat Bonuses

Stat Decay

Streak Bonuses

Screenshots

Pet Status

Git Rewards

Configuration

Pet Species

Tips & Tricks

Contributing

License

🧩 VS Code Extension

Available Commands

Usage

Credits