hatchery-pet
v0.2.0
Published
Install Codex pets from hatchery.pet.
Readme
hatchery-pet
Install Codex pets from your terminal. Pets ship from hatchery.pet.
npx hatchery-pet install clawThe first time you run an install, the CLI opens your browser, you sign in with Google, and then your terminal continues. After that, every install is one command — the sign-in is remembered on your machine.
Commands
npx hatchery-pet install <slug> # install a pet
npx hatchery-pet list # show the launch catalog
npx hatchery-pet uninstall <slug> # remove an installed pet
npx hatchery-pet login # sign in (explicit)
npx hatchery-pet logout # forget the stored sign-in
npx hatchery-pet --help # show help
npx hatchery-pet --version # show versionSign-in
install will prompt for sign-in the first time. You can also run login ahead of time:
npx hatchery-pet loginThis opens hatchery.pet/cli/auth?session=… in your browser, you sign in with Google, and the terminal continues once the browser confirms.
The stored token lives at:
- macOS / Linux —
${XDG_CONFIG_HOME:-~/.config}/hatchery-pet/auth.json(mode0600) - Windows —
%APPDATA%\hatchery-pet\auth.json
To sign out, run npx hatchery-pet logout. This deletes the local config file. The next install will prompt for sign-in again.
Where pets land
Pets install to ${CODEX_HOME:-~/.codex}/pets/<slug>/ on macOS, Linux, and Windows. Codex auto-discovers any pet in that directory.
Each pet is two files:
<slug>/
├── pet.json # manifest
└── spritesheet.webp # 1536×1872 sprite atlasEnvironment
CODEX_HOME— override the Codex home directory. Defaults to~/.codex.HATCHERY_API_BASE— override the hatchery.pet API origin. Defaults tohttps://www.hatchery.pet.XDG_CONFIG_HOME— override the config-file directory on POSIX. Defaults to~/.config.
Other ways to install
This CLI is one of two install paths:
- Inside Codex — install the hatchery.pet skill from the Codex Plugins directory for a one-click experience.
- This CLI — install pets from the terminal without leaving your shell.
License
MIT. See LICENSE.
