Guides

CodexPetHub guides for OpenAI Codex pets

Three short guides for OpenAI Codex pets: install, publish, and the package format. Each one lives at a stable URL and ships a markdown alternate so Codex and other agents can read it directly.

All guides

  • Install an OpenAI Codex pet with Codex

    2 min read · updated

    Run npx --yes codexpethub install <slug> (or paste it into Codex), then refresh Codex Settings → Appearance → Pets. The CLI downloads the manifest, verifies every SHA-256, and writes pet.json + spritesheet.webp.

    Read guide Markdown

  • Publish an OpenAI Codex pet with Codex

    3 min read · updated

    CodexPetHub does not accept browser uploads. Publish an OpenAI Codex pet through Codex via a short-lived publish intent or a trusted-agent HMAC API key. The codexpethub skill is required only for publishing — installing pets uses the npx --yes codexpethub install CLI.

    Read guide Markdown

  • The OpenAI Codex pet package format

    2 min read · updated

    An OpenAI Codex pet is a pet.json metadata file plus a spritesheet.webp animation atlas. This guide documents the canonical shape, dimensions, license policy, and validation rules.

    Read guide Markdown

# Guides

Each guide is short on purpose. The shortest path to install or publish lives at the top, the safety rules live in the middle, and reference data lives at the bottom.

  • Install with Codex — copy a prompt, paste into Codex, refresh. Two minutes.
  • Publish with Codex — request a publish intent, hand the prompt to Codex, watch the submission go through.
  • Pet format — the pet.json and spritesheet.webp shape your package must follow before it can be installed.

# Agent resources

Every guide has a markdown alternate for agents. Codex prefers these over scraping HTML.

  • /docs/install-with-codex.md
  • /docs/publish-with-codex.md
  • /docs/pet-format.md
  • /llms.txt — short site index Codex fetches first
  • /api.md — Markdown reference for /api/v1/*