Skip to main content

⚡ A terminal pet that lives in your CLI — feed it, play with it, watch it grow

Project description

bytepet-cli

A tiny terminal pet for your command line: feed it, play with it, let it sleep, and watch its mood change over time.

Watch bytepet-cli demo

  /\_____/\  
 (  ^   ^  ) 
 (  =^.^=  )        Pixel the Cat
 (--m-m----)        Level 3 · 245/300 XP

  Health     ██████████  100%
  Hunger     ███████░░░  70%
  Happiness  ████████░░  80%
  Energy     █████░░░░░  55%

  [f] Feed   [p] Play   [s] Sleep   [q] Quit

Install

npm install -g bytepet-cli

You can also install from PyPI if you prefer Python tooling:

pip install bytepet-cli

The PyPI package runs the same Node-powered terminal game, so Node.js still needs to be available on your machine.

Run

byte

The npm package also exposes:

bytepet

Helpful flags:

byte --help
byte --version
byte --status
byte --reset

What You Can Do

Bytepet is built around quick keyboard actions:

Key Action Effect
f Feed Hunger +30, happiness +5, XP +10
s Sleep Energy +40, health +5, XP +5
p Play Rock Paper Scissors, XP +5 to +15
q Quit Save and leave your pet for later

Your pet remembers you between sessions. Stats decay while you are away, so the next visit may find them hungry, tired, sad, or in need of care.

Save Management

byte --status prints your current pet stats without opening the interactive UI. byte --reset deletes your saved pet so you can adopt a new one on the next run.

Bytepet stores your pet locally in:

~/.byte-cli/pet.json

If the save file becomes unreadable, bytepet moves it aside as a .corrupt-...json backup and lets you adopt a fresh pet.

Pets And Moods

On first run, choose a cat, dog, or dragon and give it a name. Each pet has ASCII-art mood states driven by its stats:

Mood Trigger
Happy Stats are healthy
Hungry Hunger is low
Sleepy Energy is low
Sad Happiness is low
Sick Health is low

Progression

Feeding, sleeping, and playing all grant XP. Earn enough XP and your pet levels up, giving the little CLI companion a reason to keep living rent-free in your terminal.

Promo Video

The video/ folder contains the Remotion project used to render the promo:

cd video
npm install
npm run render

The rendered output lives at video/out/BytepetVideo.mp4.

License

MIT - Copyright (c) 2026 Muhammad Talha Khan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bytepet_cli-0.2.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bytepet_cli-0.2.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file bytepet_cli-0.2.0.tar.gz.

File metadata

  • Download URL: bytepet_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for bytepet_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9191814b7a7f4b17c819b0671de6ff33f98878c5ca31f4cb61257137c3f044e0
MD5 b3b341197bf56c6f92e55d6c60cd25f6
BLAKE2b-256 bd4e7ec719ce5b71e410204c84d6b13620bc930c929d26802ba8bd43e2c5f737

See more details on using hashes here.

File details

Details for the file bytepet_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: bytepet_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for bytepet_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ba13dd374d75edc2fbd71ed9659531c7087b30f3d170714455db63c260eb7a3
MD5 a5e2d3bd7a66213e5297835441924ee6
BLAKE2b-256 af10bb52ff4ade8339e2e3e1414cd839d274fd41586b762b81c40d90d8b3bc44

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page