homiedex

CLI for installing Homiedex pets — Black & African American pop culture as pixel companions for Codex.

Quick start

npx homiedex install mlk

That's it. Drops the pet pack into ~/.codex/pets/mlk/ (Windows: %USERPROFILE%\.codex\pets\mlk\), then activate it inside Codex via Settings → Appearance → Pets → Custom pets.

Commands

npx homiedex install <slug>            # install a pet
npx homiedex install <slug> --dest .   # install to custom directory
npx homiedex list                      # list available pets
npx homiedex --help
npx homiedex --version

Options

| Flag | Description | |---|---| | --dest <path> | Override the default install directory. | | --registry <url> | Override the registry URL. Default: https://homiedex.vercel.app. Useful for testing against a local dev server. |

The HOMIEDEX_REGISTRY env var works the same as --registry.

Activate in Codex

1. Open Codex → Settings → Appearance → Pets.
2. Find the pet under Custom pets and click Select.
3. Use /pet inside Codex to wake the homie or tuck them away.

Browse the roster

The full lineup lives at homiedex.vercel.app. The CLI installs whatever is currently shipped — pets without finished sprites can still be installed as metadata only (with a confirmation prompt).

Development

cd packages/cli
bun install
bun run build
node dist/index.js install biggie --registry http://localhost:3000

Publishing (maintainer notes)

cd packages/cli
npm view homiedex                    # confirm name is available
npm login                            # authenticate
npm publish --access public          # first-time publish

For subsequent releases, bump version in package.json and re-run npm publish.

License

MIT