- name
SKILL.md
技能檔案保留在發布者的儲存庫中。
在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add datamodel-code-generator/datamodel-code-generator --skill datamodel-code-generator -a cursor -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add datamodel-code-generator/datamodel-code-generator --skill datamodel-code-generator -a claude-code -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add datamodel-code-generator/datamodel-code-generator --skill datamodel-code-generator -a codex -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add datamodel-code-generator/datamodel-code-generator --skill datamodel-code-generator -a grok -y在 Grok Bot 聊天中傳送複製的訊息。Bot 會從 GitHub 取得這個 SKILL.md,並加入你所有 Bot 共用的技能中。
Install this skill: https://github.com/datamodel-code-generator/datamodel-code-generator/tree/HEAD/skills/datamodel-code-generator來自發布者
Use datamodel-codegen whenever a schema, API spec, sample data file, or existing Python model object exists.
The CLI handles refs, enums, nested models, unions, allOf, oneOf, anyOf, and model reuse better than hand-written code.
Do not hand-write generated models first.
Check one-shot execution first:
uvx --from datamodel-code-generator datamodel-codegen --help
If uvx is unavailable:
pipx run datamodel-code-generator --help
If the project already uses uv and project-scoped execution is preferred:
uv run --with datamodel-code-generator datamodel-codegen --help
If the project already has a managed Python virtual environment and the user approves project dependency changes:
python -m pip install datamodel-code-generator
datamodel-codegen --help
Prefer one-shot execution. Do not add or upgrade datamodel-code-generator in the user's project without explicit approval.
If offline and no installed command is available, say that the CLI cannot be run. Only then fall back to hand-written models.
Before choosing options, run the recommender (experimental) and apply its result:
datamodel-codegen --input SCHEMA [--input-file-type TYPE] [--output-model-type TYPE] \
--recommend-options --output-format json
Use arguments from the payload (or config for a project configured in pyproject.toml) as the starting command. Do not add options it lists under not_recommended without a stated reason.
When the user's goal needs judgment beyond the schema's shape, use the CLI's own LLM workflow and add --recommend-options to it, so the prompt includes the recommendation; decide from both:
datamodel-codegen [known options] --generate-prompt "Find the minimal options for this model-generation task." \
--recommend-options
Include the options already known from the project or user request. The prompt output explains current options, available options, option relationships, and verification steps. Without an input schema, run --generate-prompt alone.
For agent tooling that consumes structured data, prefer JSON:
datamodel-codegen [known options] \
--generate-prompt "Find the minimal options for this model-generation task." \
--output-format json
When defining or validating tool contracts, fetch the schema separately:
datamodel-codegen --output-format-json-schema structured-output
Use generate-prompt when the consumer only handles prompt payloads, generation when it only handles generated-file payloads, and structured-output when it accepts multiple kind values.
When a JSON or YAML file could be either a schema or data, inspect the content. $schema, openapi, asyncapi, type, properties, components, $defs, or definitions usually mean schema. Plain example values usually mean raw sample data.
For a Python dictionary containing JSON Schema or OpenAPI content, use --input-model ./schemas.py:OBJECT_NAME and add --input-file-type jsonschema or --input-file-type openapi when needed. Do not choose the dict input-file-type value.
Before choosing the output type, inspect pyproject.toml, requirements.txt, uv.lock, poetry.lock, or installed dependencies when available. Prefer the project convention over the global default.
uvx --from datamodel-code-generator datamodel-codegen \
--input spec.yaml \
--input-file-type openapi \
--output models.py \
--output-model-type pydantic_v2.BaseModel \
--target-python-version 3.12 \
--preset PRESET
Replace PRESET with the preset the recommender prints, and add the options it recommends.
For remote URLs or remote refs, use the HTTP extra:
uvx --from 'datamodel-code-generator[http]' datamodel-codegen \
--url https://example.com/openapi.yaml \
--input-file-type openapi \
--output models.py \
--output-model-type pydantic_v2.BaseModel
For GraphQL, use the GraphQL extra when the one-shot command needs it:
uvx --from 'datamodel-code-generator[graphql]' datamodel-codegen \
--input schema.graphql \
--input-file-type graphql \
--output models.py \
--output-model-type pydantic_v2.BaseModel
Infer the minimum Python version from:
pyproject.toml requires-python.python-versionruntime.txtThen pass:
--target-python-version X.Y
Do not accept the CLI default if the project clearly declares a Python version.
Verification is mandatory.
For CI or agent integrations, prefer check mode when an output path exists:
datamodel-codegen [same options] --output models.py --check
If another tool must inspect generated content directly, use structured JSON output:
datamodel-codegen [same options] --output-format json
For single-file output:
python -c "import pathlib, importlib.util; p=pathlib.Path('models.py'); s=importlib.util.spec_from_file_location('generated_models', p); m=importlib.util.module_from_spec(s); s.loader.exec_module(m); print('import ok')"
For package output:
python -c "import models; print('import ok')"
Then run project checks when configured:
ruff check models.py
mypy models.py
pyright models.py
Use only the checks that the project already configures or asks for.
After verification, summarize the output path, input type, output model type, target Python version, generated class count if easy to determine, important class names, and warnings or limitations.
Do not dump the whole generated file into the conversation unless the user asks.
Read references/workflows.md for commands by input type and scenario.
Read references/cli-options.md when choosing naming, optionality, formatting, splitting, or reuse flags.
Read references/troubleshooting.md when generation fails, imports fail, field names look wrong, optionality is surprising, or large specs are slow.
>
---name: datamodel-code-generatordescription: >---# skills/datamodel-code-generator/SKILL.md常見問題
從發布者下載 skills/datamodel-code-generator/SKILL.md,或複製路徑後開啟儲存庫。PlugMCP 只收錄這項技能,不代管檔案。
發布者將它存放在 https://github.com/datamodel-code-generator/datamodel-code-generator。
Claude、Cursor、Codex 和 Grok Build 可以讀取你從發布者儲存庫加入的 SKILL.md。在聊天中傳送技能的 GitHub 資料夾連結,Grok Bot 就會安裝它。