petdex 0.4.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -5
- package/dist/petdex.js +122 -121
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,13 +24,15 @@ Requires Node.js 20+ (also runs on Bun).
|
|
|
24
24
|
petdex login # opens browser, OAuth + PKCE via Clerk
|
|
25
25
|
petdex list # browse approved pets
|
|
26
26
|
petdex install boba # drops boba into ~/.codex/pets/boba/
|
|
27
|
+
petdex select # pick active mascot from installed pets (interactive)
|
|
28
|
+
petdex select boba # set active mascot directly
|
|
27
29
|
petdex submit ~/.codex/pets/boba # share a single pet
|
|
28
30
|
petdex submit ~/.codex/pets # bulk submit every subfolder
|
|
29
31
|
petdex whoami # confirm signed-in identity
|
|
30
32
|
petdex logout # clear stored credentials
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
After installing a pet,
|
|
35
|
+
After installing a pet, set it as active with `petdex select` or inside Codex: **Settings → Appearance → Pets → Select**. Use `/pet` inside Codex to wake or tuck it away.
|
|
34
36
|
|
|
35
37
|
## Commands
|
|
36
38
|
|
|
@@ -40,7 +42,8 @@ After installing a pet, activate it inside Codex: **Settings → Appearance →
|
|
|
40
42
|
| `petdex logout` | Clear local credentials. |
|
|
41
43
|
| `petdex whoami` | Print the signed-in user's identity. |
|
|
42
44
|
| `petdex list` | List approved pets in the gallery. |
|
|
43
|
-
| `petdex install <slug>` | Install a pet into `~/.codex/pets/<slug>/`. |
|
|
45
|
+
| `petdex install <slug>` | Install a pet into `~/.codex/pets/<slug>/` and `~/.petdex/pets/<slug>/`. |
|
|
46
|
+
| `petdex select [slug]` | Set the active pet shown by Petdex Desktop. No args = interactive picker; pass a slug to skip the prompt. |
|
|
44
47
|
| `petdex submit <path>` | Submit a pet folder, zip, or parent of pets (bulk). |
|
|
45
48
|
| `petdex --version` | Print the CLI version. |
|
|
46
49
|
|
|
@@ -115,14 +118,14 @@ The full step-by-step (with tips on what makes a great pet) lives at <https://pe
|
|
|
115
118
|
## Common install issues
|
|
116
119
|
|
|
117
120
|
The CLI is a single bundled JS file with no native dependencies.
|
|
118
|
-
install path is just `fetch
|
|
119
|
-
~/.codex/pets/<slug>/`. Most "stuck" reports trace to one of these:
|
|
121
|
+
install path is just `fetch the static manifest snapshot, write two
|
|
122
|
+
files to ~/.codex/pets/<slug>/`. Most "stuck" reports trace to one of these:
|
|
120
123
|
|
|
121
124
|
| Symptom | Cause | Fix |
|
|
122
125
|
| --- | --- | --- |
|
|
123
126
|
| Hangs at `Need to install the following packages: petdex@x` | `npx`'s own confirmation prompt, not a hang. Press `y` or auto-confirm | `npx -y petdex install <slug>` |
|
|
124
127
|
| `npm ERR! engine Unsupported engine` | Node < 20 | Upgrade Node to 20+ (`nvm install 20` is the easiest path) |
|
|
125
|
-
| `manifest fetch 5xx` / network timeout | Slow connection or corporate/national firewall blocking `petdex.crafter.run` | Set a proxy: `HTTPS_PROXY=http://your.proxy:port npx petdex install <slug>` |
|
|
128
|
+
| `manifest fetch 5xx` / network timeout | Slow connection or corporate/national firewall blocking `assets.petdex.dev` / `petdex.crafter.run` | Set a proxy: `HTTPS_PROXY=http://your.proxy:port npx petdex install <slug>` |
|
|
126
129
|
| `EACCES: permission denied … ~/.codex/pets/` | Pets dir owned by another user | `sudo chown -R "$USER" ~/.codex` or remove the dir and retry |
|
|
127
130
|
| Windows: `'sh' is not recognized` | CLI version older than 0.1.1 piped through `curl … \| sh` | Upgrade: `npm i -g petdex@latest` or `npx petdex@latest install <slug>` |
|
|
128
131
|
|