Installation guide

Install a Codex Pet

Codex Pet Lab publishes a first-party npm installer and standard ZIP packages. Both methods write the same two files into your Codex pets directory.

Install one pet

npx codexpetlab add miso-byte

Install a collection

npx codexpetlab add-collection terminal-companions

Installation location

By default pets are installed below $HOME/.codex/pets. Set CODEX_HOME when Codex uses a different data directory.

CODEX_HOME=/custom/codex npx codexpetlab add miso-byte

Manual installation

Extract the package into a directory whose name matches the manifest id.

$HOME/.codex/pets/miso-byte/
├── pet.json
└── spritesheet.webp

Validate before installation

npx codexpetlab validate ./miso-byte.codex-pet.zip

Related resources