PetPet CLI

A cute 8-bit pixel bunny that lives in your terminal! Feed, pet, play, unlock achievements, and share with your partner.

    ▄▀▄▀▄
    █▀█▀█
  ▄▀███▀▀▀▄▄
  ██████▀▀▀▀▀▄▄▄
  ▀▀▀█▀▀█▀▀█▀▀▀█
    ▄▀▀▀▀▀▀▀▀▀▀█
  ▄▄▀▀▀▄▄▄▀▀▀▀▀▀
  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀

Features

• 8-bit Pixel Style - Beautiful pixel bunny art
• Interactive Animations - Feeding, petting, and playing all have animations
• Weather System - Weather changes based on real time
• Achievement System - 14 achievements to unlock
• Couple Mode - Share your bunny with your partner and leave messages
• State Persistence - Your bunny's state is saved between sessions

Installation

Quick Install (Recommended)

curl -fsSL https://raw.githubusercontent.com/noahatfin/petpet/main/install.sh | bash

Via npm

npm install -g petpet-cli

Manual Installation

git clone https://github.com/noahatfin/petpet.git
cd petpet
npm install
node index.js

Basic Usage

petpet              # View your bunny
petpet feed         # Feed your bunny
petpet pet          # Pet your bunny
petpet play         # Play with your bunny
petpet status       # View detailed status
petpet name Fluffy  # Rename your bunny
petpet weather      # Check weather
petpet achievements # View achievements
petpet update       # Check for updates
petpet help         # Show help

Shortcuts

Command	Shortcut
view	v
feed	f
pet	p
play	w
status	s
achievements	a

---

Couple Mode

Share your bunny with your partner! Visit each other's bunnies and leave messages.

Setup (For the person creating the home)

Step 1: Create a GitHub Personal Access Token

1. Go to GitHub Token Settings
2. Give it a name (e.g., "petpet")
3. Select only the gist scope
4. Click "Generate token"
5. Copy the token (you won't see it again!)

Your token looks like: ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Step 2: Create the Couple Home

petpet pair ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

This will output a pair code like:

PETPET-eyJ0IjoiZ2hwX3h4eHh4eHh4eHh4eCIsImciOiJhYmNkMTIzNCJ9

Step 3: Share the Pair Code

Send the pair code to your partner (via message, email, etc.)

---

Setup (For the partner joining)

Your partner only needs to run ONE command:

petpet join PETPET-eyJ0IjoiZ2hwX2luYUwwQUdGemRFdERoVG5zUGo2NnMxaUZHVnlXNDQyZDRFYyIsImciOiI5MTM1MjkzYmQ2MTg3MGU2NzZiZDljMGEzYjBmZTdiZCJ9

That's it! No GitHub account or token needed.

---

Couple Commands

petpet partner      # Visit your partner's bunny
petpet bf           # Same as partner (boyfriend shortcut)
petpet gf           # Same as partner (girlfriend shortcut)
petpet say Hello!   # Leave a message for your partner
petpet messages     # View the message board
petpet unpair       # Leave the couple home

Example

# You
$ petpet say Good morning! Have a great day 💕

  💌 Message sent!
  "Good morning! Have a great day 💕"

# Your partner
$ petpet messages

  💌 Message Board

  [1/10 9:30]   Bunny: Good morning! Have a great day 💕

---

Weather System

Weather changes based on real time:

• Sunny - During daytime
• Cloudy - Random during daytime
• Rainy - Random during daytime
• Night - Between 8 PM and 6 AM

Achievements

Achievement	Description
First Meal	Feed your bunny for the first time
First Pet	Pet your bunny for the first time
First Play	Play with your bunny for the first time
Food Lover	Feed 10 times
Master Chef	Feed 50 times
Gentle Touch	Pet 10 times
Massage Expert	Pet 50 times
Playmate	Play 10 times
Best Playmate	Play 50 times
Three Day Bond	Care for 3 consecutive days
Week of Care	Care for 7 consecutive days
Monthly Friend	Care for 30 consecutive days
Full Happiness	Reach 100% happiness
Weather Watcher	Experience all weather types

Data Storage

File	Purpose
~/.petpet-state.json	Your bunny's state (hunger, happiness, achievements, etc.)
~/.petpet-config.json	Couple mode config (token, gist ID, etc.)

Requirements

• Node.js 18.0.0 or higher (for native fetch support)

License

MIT

---

Made with love for your terminal!