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」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「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.。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「What is Petdex」など複数の箇所に分かれています。確認できる情報は次の通りです。Every pet is a folder. Every folder is a Pokédex entry. Every entry is one npx petdex install away.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は 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 実行可能なコマンドがない場合は手順を作らず、「Quick start」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「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 .ともあります。