the hatchery

docs · updated 2026-05-03

Install the first pet

Install Kernel from the shared Hatchery manifest.

Check local requirements

Install Codex, sign in to the Codex App, and confirm the terminal or IDE uses the same Codex home. The App is where the pet renders; the terminal is where this quickstart will install it after launch.

Preview Kernel

This command runs from any terminal with Codex access. The install writes the pet into the local Codex home used by the App.

bashterminal
npx the-hatchery install kernel

Wake the overlay

Open the Codex App, refresh custom pets from Appearance settings if needed, then wake the pet overlay from the composer or command menu.

bashcodex
# works as of 2026-05-03
/pet

Try /hatch locally

Use /hatch when you want Codex to generate a local experiment. Use The Hatchery when you want a creator-made pet with a stable install ID.

bashcodex
# works as of 2026-05-03
/hatch create a small yolk pet for review sessions