petdex 0.3.5 → 0.3.6
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 -8
- package/dist/petdex.js +73 -73
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# petdex
|
|
2
2
|
|
|
3
|
-
The Petdex CLI
|
|
3
|
+
The Petdex CLI: browse, install, and submit animated pets for [OpenAI Codex](https://openai.com/codex) from your terminal.
|
|
4
4
|
|
|
5
5
|
- **Gallery & docs:** <https://petdex.crafter.run>
|
|
6
6
|
- **Repo:** <https://github.com/crafter-station/petdex>
|
|
@@ -51,14 +51,14 @@ The CLI accepts three input shapes:
|
|
|
51
51
|
```sh
|
|
52
52
|
petdex submit ~/.codex/pets/boba # single folder (must contain pet.json + spritesheet.{webp,png})
|
|
53
53
|
petdex submit ~/Downloads/boba.zip # single zip with the same root layout
|
|
54
|
-
petdex submit ~/.codex/pets # parent folder
|
|
54
|
+
petdex submit ~/.codex/pets # parent folder: every subfolder containing pet.json is submitted
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
Per submission the CLI:
|
|
58
58
|
|
|
59
59
|
1. Builds a clean zip in memory from `pet.json` + `spritesheet.{webp,png}`.
|
|
60
60
|
2. Calls `POST /api/cli/submit` with a Clerk OAuth bearer to get presigned R2 PUT URLs (60s TTL).
|
|
61
|
-
3. PUTs the three files to Cloudflare R2 directly
|
|
61
|
+
3. PUTs the three files to Cloudflare R2 directly. No body passes through Petdex servers.
|
|
62
62
|
4. Calls `POST /api/cli/submit/register` to record the submission as `pending`. Identity comes from the verified token, never from the body.
|
|
63
63
|
|
|
64
64
|
A spinner shows progress per pet; a summary lists failures with reasons. Slugs auto-deduplicate (`boba` → `boba-2` → `boba-3` → …) so submissions never rebote on collisions.
|
|
@@ -91,7 +91,7 @@ The flow uses the [`@clerk/cli-auth`](https://github.com/Railly/clerk-cli-auth-e
|
|
|
91
91
|
|
|
92
92
|
## How to make a pet (creation lives inside Codex)
|
|
93
93
|
|
|
94
|
-
This CLI distributes pets
|
|
94
|
+
This CLI distributes pets. It does not generate them. To create one:
|
|
95
95
|
|
|
96
96
|
1. Open the **Codex desktop app** (download at <https://openai.com/codex>).
|
|
97
97
|
2. Go to **Skills** in the top navbar → install **Hatch Pet**.
|
|
@@ -110,11 +110,11 @@ The full step-by-step (with tips on what makes a great pet) lives at <https://pe
|
|
|
110
110
|
| `presign 429` | 10/24h rate limit hit | Wait 24h or open a [submit-fallback issue](https://github.com/crafter-station/petdex/issues/new?labels=submit-fallback) |
|
|
111
111
|
| `register 400 invalid_spritesheet` | Sprite < 256×256 | Regenerate with bigger dims (recommend 1536×1872) |
|
|
112
112
|
| `register 400 missing_field` | Folder missing `pet.json` or `spritesheet.{webp,png}` | Inspect folder contents, re-export from Codex if needed |
|
|
113
|
-
| `R2 PUT 403` | Presigned URL expired (60s TTL) | Retry the failed submission
|
|
113
|
+
| `R2 PUT 403` | Presigned URL expired (60s TTL) | Retry the failed submission. CLI auto-presigns fresh URLs |
|
|
114
114
|
|
|
115
115
|
## Common install issues
|
|
116
116
|
|
|
117
|
-
The CLI is a single bundled JS file with no native dependencies
|
|
117
|
+
The CLI is a single bundled JS file with no native dependencies.
|
|
118
118
|
install path is just `fetch a JSON manifest, write two files to
|
|
119
119
|
~/.codex/pets/<slug>/`. Most "stuck" reports trace to one of these:
|
|
120
120
|
|
|
@@ -127,11 +127,11 @@ install path is just `fetch a JSON manifest, write two files to
|
|
|
127
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
128
|
|
|
129
129
|
The CLI bundles `@clack/prompts`, `picocolors`, and `jszip` into the
|
|
130
|
-
shipped JS
|
|
130
|
+
shipped JS. There is no separate dependency-install step on your
|
|
131
131
|
machine. If something appears to be stuck on "installing
|
|
132
132
|
dependencies", it's almost always npm's own progress bar for the
|
|
133
133
|
`petdex` package itself, not a sub-dependency tree.
|
|
134
134
|
|
|
135
135
|
## License
|
|
136
136
|
|
|
137
|
-
MIT
|
|
137
|
+
MIT, same as the [Petdex repo](https://github.com/crafter-station/petdex).
|