CODEX PETS · OPEN-SOURCE PIXEL PETS

How to Install Codex Pets

Two ways to add a Codex pet: one command, or a manual copy into ~/.codex/pets/. Both take under a minute.

One-line install
Copy brief
npx clipets install <pet>

Option 1 — one command

Run npx clipets install <pet> (for example npx clipets install homelander). It downloads the pet into ~/.codex/pets/<pet>/ for you. Requires Node.js.

Option 2 — manual install

Download spritesheet.webp and pet.json from any pet's page, create the folder ~/.codex/pets/<name>/, and drop both files inside. The folder name is the pet name.

Enable it in Codex

Fully restart Codex, then open Settings → Appearance → Pets and select your pet. Type /pet in a chat to wake it. That's it.

The pet file format

Every Codex pet is a folder with two files: spritesheet.webp (8×9 grid, 192×208 per cell, 9 actions) and pet.json (name + metadata). This is the official Codex pet sprite contract.

FAQ

Where do Codex pets go?

Into ~/.codex/pets/<name>/ — one folder per pet, each with spritesheet.webp and pet.json.

Do I need anything installed?

The one-command install needs Node.js (node -v should print a version). Manual install needs nothing extra.

It doesn't show up — why?

Check the path and exact file names, fully restart Codex, and update to the latest Codex. See our guide for the full checklist.

Can I install Petdex pets too?

Yes — use npx petdex@latest install <slug>, or browse the Petdex catalog right here on CliPets.

Browse pets to install →
Pet Generator →Petdex Alternative →

CliPets uses only essential browser storage (login, language and an anonymous ID) to make the site work. We don't use third-party advertising or tracking cookies. Learn more ↗

Got it