petdex 0.1.1 → 0.2.0

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.
Files changed (3) hide show
  1. package/README.md +20 -0
  2. package/dist/petdex.js +180 -44
  3. package/package.json +8 -5
package/README.md CHANGED
@@ -112,6 +112,26 @@ The full step-by-step (with tips on what makes a great pet) lives at <https://pe
112
112
  | `register 400 missing_field` | Folder missing `pet.json` or `spritesheet.{webp,png}` | Inspect folder contents, re-export from Codex if needed |
113
113
  | `R2 PUT 403` | Presigned URL expired (60s TTL) | Retry the failed submission — CLI auto-presigns fresh URLs |
114
114
 
115
+ ## Common install issues
116
+
117
+ The CLI is a single bundled JS file with no native dependencies — the
118
+ install path is just `fetch a JSON manifest, write two files to
119
+ ~/.codex/pets/<slug>/`. Most "stuck" reports trace to one of these:
120
+
121
+ | Symptom | Cause | Fix |
122
+ | --- | --- | --- |
123
+ | 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
+ | `npm ERR! engine Unsupported engine` | Node < 18 | Upgrade Node to 18+ (`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>` |
126
+ | `EACCES: permission denied … ~/.codex/pets/` | Pets dir owned by another user | `sudo chown -R "$USER" ~/.codex` or remove the dir and retry |
127
+ | 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
+
129
+ The CLI bundles `@clack/prompts`, `picocolors`, and `jszip` into the
130
+ shipped JS — there is no separate dependency-install step on your
131
+ machine. If something appears to be stuck on "installing
132
+ dependencies", it's almost always npm's own progress bar for the
133
+ `petdex` package itself, not a sub-dependency tree.
134
+
115
135
  ## License
116
136
 
117
137
  MIT — same as the [Petdex repo](https://github.com/crafter-station/petdex).