Codex Pet

インストールと有効化

Codex にペットを迎える

ギャラリーから選び、OS に合った方法でインストールして、Codex の設定で有効にします。

最短ルート

各詳細ページに正確なペット ID とインストール方法があります。

  1. 1. ペットを選ぶ

    詳細ページでアニメーションを確認します。

  2. 2. 方法を選ぶ

    ChatGPT、Bash、PowerShell、ローカル導入から選択します。

  3. 3. 有効にする

    Codex を再起動し、設定 → Pets で選択します。

OS に合った方法を選ぶ

インストーラーは pet.json と spritesheet.webp だけを取得し、マニフェストと SHA-256 を検証してから原子的に有効化します。

macOS / Linux

curl と bash が必要です。

curl -fsSL --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/legeling/awesome-codex-pet/main/scripts/install-pet.sh | bash -s -- --raw-base https://raw.githubusercontent.com/legeling/awesome-codex-pet/main <pet-slug--author-slug>
01

Confirm the pet id

Use the complete pet-slug--author-slug value. The author suffix lets different versions of the same character coexist.

02

Run as your own user

No sudo or administrator shell is needed. A custom CODEX_HOME is supported when your setup uses another location.

03

Verify the two runtime files

インストール後の pets/<pet-id>/ には pet.json と spritesheet.webp だけが残り、有効化前に SHA-256 と WebP ヘッダーを確認します。

Enable the pet in Codex

Installation places the files; Codex still needs to load and select the pet.

  1. 1

    Restart Codex

    If Codex was open during installation, quit and reopen it so the custom pet catalog refreshes.

  2. 2

    Open Settings → Pets

    Find the custom-pet section and confirm that the new id appears without an error badge.

  3. 3

    Select the pet

    Activate it, return to your workspace, and check idle, work, review, and movement states.

V1 and V2 install the same way

V1 pets contain nine standard action rows. V2 keeps those actions and adds 16 look directions. The atlas size and spriteVersionNumber differ, but the installer and destination do not.

Manage an installation

Default location
Pets are stored in ~/.codex/pets/<pet-id>/ on macOS and Linux, or %USERPROFILE%\.codex\pets\<pet-id> on Windows.
Custom Codex home
Set CODEX_HOME before the command, or pass --codex-home to the Bash and local Node.js installers.
Update or reinstall
同じ ID を再インストールする場合は --force(PowerShell は -Force)を指定してください。他のペットフォルダーは変更しません。
Uninstall
Quit Codex, remove only that pet's folder, then reopen Codex. No registry or system files are created.
Anonymous install count
Successful scripts send one anonymous install event. Set AWESOME_CODEX_PET_NO_STATS=1 to disable it.
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.

The pet does not appear after installation. What should I check?

Confirm both runtime files exist, verify that pet.json.id matches the folder name, restart Codex, then look under Settings → Pets again.

Can V1 and V2 pets coexist?

はい。異なる ID の V1/V2 ペットは共存でき、--force で再インストールしても対象フォルダーだけを原子的に更新します。