Skip to main content

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 --stats
byte --play
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 Opens the mini-game menu
q Quit Save and leave your pet for later

Mini-games currently include:

Game Reward
Rock Paper Scissors XP +5 to +15 per round
Number Guess XP +5 or +15 per round
Coin Flip XP +4 or +12 per round

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.

byte --stats prints lifetime mini-game totals, including wins, losses, draws, XP earned from games, and per-game breakdowns. byte --play jumps directly into the mini-game menu.

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

Metadata

Release files for bytepet-cli 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bytepet-cli 0.3.0
File Size Uploaded
bytepet_cli-0.3.0.tar.gz 14.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bytepet-cli 0.3.0
File Interpreter ABI Platform
bytepet_cli-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 29.2 kB

Release files / bytepet_cli-0.3.0.tar.gz

Download URL bytepet_cli-0.3.0.tar.gz
Size 14.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e82c5357c0258466bf9fd37c2061cf2336b23f6e597058709c4ce3e987cf90d8
BLAKE2b-256 checksum
How to use checksums
a2c55208e4462ec4efc9206cc6dd265ec54765f10b56d8d81b91ea10f70f487c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release files / bytepet_cli-0.3.0-py3-none-any.whl

Download URL bytepet_cli-0.3.0-py3-none-any.whl
Size 14.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
123d0c563b87e800b81f65bcae56cbd0eae00ee10693a8a71894fdebdf2627ca
BLAKE2b-256 checksum
How to use checksums
f893fb5bb676d55375c4bd0fb6e02d5c94a364f41e3497c2aa3b2ebbcc364252
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page