Awesome Codex Pet

Install a pet in seconds

Pick the pet slug from the gallery and run one of the commands below. No need to clone the repository.

  1. 1. Find a pet

    Open the gallery, hit the pet you like, and copy the slug shown on its detail page.

  2. 2. Run the install command

    Pick the script for your shell and replace {slug} with your chosen pet slug.

  3. 3. Restart Codex

    Codex will pick up the new pet from your local pets directory automatically.

macOS / Linux
Requires curl and bash.
curl -fsSL https://raw.githubusercontent.com/legeling/awesome-codex-pet/main/scripts/install-pet.sh | bash -s -- <pet-slug--author-slug>
Windows PowerShell
Run as a normal user, no admin rights needed.
powershell -NoProfile -ExecutionPolicy Bypass -Command "iwr -UseB https://raw.githubusercontent.com/legeling/awesome-codex-pet/main/scripts/install-pet.ps1 | iex; Install-CodexPet <pet-slug--author-slug>"
Run with Node.js
Works anywhere npx is available.
npx awesome-codex-pet <pet-slug--author-slug>

FAQ

Where are pets installed?

Each pet lands in your Codex home (default ~/.codex) under pets/<pet-id>/.

Can I uninstall a pet?

Delete the pet folder. Nothing else is touched.

Is sudo required?

No. Installs are scoped to your user directory.

Open gallery