Docs

Install and package format

Compatibility

CodingPets.dev currently supports Codex custom pets only. Each ready pack is a Codex-compatible ZIP with pet.json, spritesheet.webp, and install metadata.

Not a generic desktop mascot or VS Code extension.

CLI install

Ready packs expose install metadata at /api/install/:jobId. The result page copies the same command consumed by the published npm CLI, which installs the pack, selects it in Codex, and asks Codex to show it.

$ npx codingpets install cp_example

ZIP contents

Downloads include pet.json, spritesheet.webp,install.json, and a short README for manual install.

{
  "id": "cp_example",
  "displayName": "Example Pixel Pet",
  "description": "A custom Codex pet.",
  "spritesheetPath": "spritesheet.webp"
}

Manual install

Download the ZIP, extract it, and copy pet.json plus spritesheet.webp into your Codex pets folder, then select it from Codex settings. The CLI path remains the preferred install flow.

During early access, Download ZIP remains the backup path. The public npm CLI is available as npx codingpets install <job-id>.