About zod
zod is a documentation lookup skill for coding agents working with Zod. It maps tasks to reference categories and then to specific pages, covering API usage, configuration, advanced topics, and migration guidance.
Key features
- 01Locate documentation by task category
- 02Find parsing and type inference guidance
- 03Look up APIs and error handling
- 04Browse advanced topics and ecosystem resources
- 05Find migration guides and examples
Use cases
- 01Check how to create and parse Zod schemas
- 02Find ways to customize error messages
- 03Explore JSON Schema conversion or AOT compilation
- 04Consult Zod version migration guidance
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ fandhe-ai/ agent-reference-skills --skill zodAfter installing, type/zodin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/advanced/codecs.mdcompile.mdjson-schema.mdmetadata.mdREADME.mdreferences/api/collections.mdenums-and-literals.mdnumbers.mdobjects.mdprimitives.mdREADME.mdspecial-types.mdstrings.mdtransforms-and-refinements.mdunions-and-intersections.mdreferences/ecosystem/ecosystem.mdlibrary-authors.mdREADME.mdreferences/errors/error-customization.mderror-formatting.mdREADME.mdreferences/getting-started/basic-usage.mdintroduction.mdREADME.mdreferences/migration/README.mdv4-migration-guide.mdv4-release-notes.mdv4-versioning.mdreferences/packages/core.mdmini.mdDetails
From the project READMEZod リファレンス
Zod 公式ドキュメントの全 API を網羅したスキル。 ユーザーのタスクに応じて適切な README.md を読み、そこから個別ファイルへ辿ること。
対象: Zod v4.6.7(GitHub tag v4.6.7 / zod.dev, 2026-10-16 取得)
ディレクトリ構成
skills/zod/
SKILL.md
references/
getting-started/
README.md
introduction.md
basic-usage.md
api/
README.md
primitives.md
strings.md
numbers.md
enums-and-literals.md
objects.md
collections.md
unions-and-intersections.md
special-types.md
transforms-and-refinements.md
errors/
README.md
error-customization.md
error-formatting.md
advanced/
README.md
metadata.md
json-schema.md
codecs.md
compile.md
ecosystem/
README.md
ecosystem.md
library-authors.md
migration/
README.md
v4-release-notes.md
v4-migration-guide.md
v4-versioning.md
packages/
README.md
zod.md
mini.md
core.md
samples/
README.md
basic-schema.md
safe-parse.md
string-validation.md
object-composition.md
transform-and-default.md
custom-refinement.md
discriminated-union.md
error-formatting.md
error-customization.md
recursive-schema.md
aot-compile.md
scripts/
README.md
install.md
imports.md
parse.md
json-schema.md
migrate-v3-to-v4.md
compile.md
探索手順
タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:
- 下記マッピング表でタスクに対応するカテゴリを探す
- そのカテゴリの
references/{category}/README.mdを参照して目的のページを特定する - 該当ページの
.mdを Read して詳細を確認する
タスク → カテゴリ マッピング
| タスク | カテゴリ | 参照 README |
|---|---|---|
| インストール・基本的な使い方を知りたい | getting-started | references/getting-started/README.md |
| parse / safeParse / z.infer で型推論したい | getting-started | references/getting-started/README.md |
| z.string / z.number / z.boolean 等のプリミティブ型を使いたい | api | references/api/README.md |
| z.object / z.array / z.record / z.tuple を使いたい | api | references/api/README.md |
| z.union / z.discriminatedUnion / z.intersection を使いたい | api | references/api/README.md |
| refine / superRefine / transform / pipe / default を使いたい | api | references/api/README.md |
| ZodError のメッセージをカスタマイズ・フォーマットしたい | errors | references/errors/README.md |
| i18n・グローバルエラー設定を変更したい | errors | references/errors/README.md |
| JSON Schema への変換・OpenAPI 連携をしたい | advanced | references/advanced/README.md |
| レジストリ・メタデータ・コーデックを使いたい | advanced | references/advanced/README.md |
| AOT コンパイル(z.compile / zod/compile)・高速 boolean 検証(validate)をしたい | advanced | references/advanced/README.md |
| 既存 TypeScript 型にスキーマを一致させたい(z.toZod) | getting-started | references/getting-started/README.md |
| サードパーティ連携・エコシステムを知りたい | ecosystem | references/ecosystem/README.md |
| Zod を使うライブラリを開発したい | ecosystem | references/ecosystem/README.md |
| Zod 3 から Zod 4 に移行したい | migration | references/migration/README.md |
| Zod 4 の新機能・破壊的変更を確認したい | migration | references/migration/README.md |
| zod/v4 などサブパスの版管理・import 書き換えを知りたい | migration | references/migration/README.md |
| Zod / Zod Mini / Zod Core の違いを知りたい | packages | references/packages/README.md |
| バンドルサイズを削減したい(tree-shaking) | packages | references/packages/README.md |
| 典型的な使い方のサンプルを見たい | samples | samples/README.md |
| インストール・import・CLI コマンドを知りたい | scripts | scripts/README.md |
Comments
Markdown supported