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

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.

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.1.2.tar.gz (10.7 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.1.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bytepet_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 10.7 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.1.2.tar.gz
Algorithm Hash digest
SHA256 15da161489a3a77a8258abb7a4523cc893456f7d8b83e73cda4d6d53c51e0d10
MD5 7cb83e692b40cce350d40018a9925822
BLAKE2b-256 02b4cd61521ab75548f3c61c55de94041436033bb6f973b7c45eec28469b6823

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bytepet_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.8 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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 29f988e10705d10ff583a952ac94a36d5db68437f1639ce8c7bb2170451981df
MD5 c9ae031fb532d5233e06b26a47b76d44
BLAKE2b-256 273a2221aad2ee231bae18cf625bf6193f4fc4b5788872a8aca6378a81def01c

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