crafter-station/petdex:README 来源编辑指南
基于 README、仓库元数据和许可证整理 crafter-station/petdex 的安装与核验路径。
项目定位
crafter-station/petdex 的 README 将项目描述为"The public gallery of animated pet for Codex, Claude Code, OpenCode y Gemini CLI"。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"README"下的说明是:The public gallery of animated companions for Codex. Browse, install, and submit pets with one command.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"For builders"和相关条目看,读者可以先判断它是否解决自己的具体问题:The pet package format. Every pet is a pet.json plus a spritesheet.{webp,png} rendered as an 8×9 grid of 192×208 frames.。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:The HTTP API. petdex.dev/api/manifest returns every approved pet with its slug, spritesheet URL, animation states, and metadata.。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"What is Petdex"等段落中。可确认的线索包括:Every pet is a folder. Every folder is a Pokédex entry. Every entry is one npx petdex install away.。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: crafter-station/petdex ├── src/ │ ├── app/[locale]/ Public site: gallery, /pets/<slug>, /collections, /built-with, /community, /create, /download, /submit, /u/<handle>, ... │ ├── app/api/cli/ CLI endpoints: OAuth config, submit (zip → presigned R2), dedup check, register │ ├── app/api/manifest/ Public manifest: every approved pet with its spritesheet URL │ ├── app/api/admin/ Admin review surface for submissions, edits, collection requests │ └── lib/db/sc 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"Quick start"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"Quick start"段落提到:Follow this checklist to get a pet installed, visible in Codex, and connected to the desktop app.。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:Submit a pet: petdex.dev/submit or npx petdex submit .。