# datamodel-code-generator CLI Options Consultation

## Current CLI Options

```
--input schema.json
```

## Options by Category

### Base Options
- `--emit-model-metadata`: Write a separate JSON map from source schema references to the final generated models...
- `--encoding`: Specify character encoding for input and output files.
- `--external-ref-mapping`: Map external `$ref` files to Python packages.
- `--input`: Specify the input schema file path.
- `--input-file-type`: Specify the input file type for code generation.
- `--input-model`: Import a Python type or dict schema from a module or Python file.
- `--input-model-ref-strategy`: Strategy for referenced types when using --input-model.
- `--output`: Specify the destination path for generated Python code.
- `--preset`: Apply an immutable built-in option preset.
- `--schema-version`: Schema version to use for parsing.
- `--schema-version-mode`: Schema version validation mode.
- `--url`: Fetch schema from URL with custom HTTP headers.

### Typing Customization
- `--allof-class-hierarchy`: Controls how allOf schemas are represented in the generated class hierarchy.
- `--allof-merge-mode`: Merge constraints from root model references in allOf schemas.
- `--disable-future-imports`: Prevent automatic addition of __future__ imports in generated code.
- `--enum-field-as-literal`: Convert all enum fields to Literal types instead of Enum classes.
- `--enum-field-as-literal-map`: Override enum/literal generation per-field via JSON mapping.
- `--ignore-enum-constraints`: Ignore enum constraints and use base string type instead of Enum classes.
- `--no-use-annotated`
- `--no-use-closed-typed-dict`: Disable PEP 728 TypedDict closed/extra_items generation.
- `--no-use-specialized-enum`: Disable specialized Enum classes for Python 3.11+ code generation.
- `--no-use-standard-collections`: Use typing.Dict/List instead of built-in dict/list for container types.
- `--no-use-standard-primitive-types`
- `--no-use-union-operator`: Use Union[X, Y] / Optional[X] instead of X | Y union operator.
- `--output-date-class`: Specify date class type for date schema fields.
- `--output-datetime-class`: Specify datetime class type for date-time schema fields.
- `--strict-types`: Enable strict type validation for specified Python types.
- `--type-mappings`: Override default type mappings for schema formats.
- `--type-overrides`: Replace schema model types with custom Python types via JSON mapping.
- `--use-annotated`: Use typing.Annotated for Field() with constraints.
- `--use-closed-typed-dict`: Generate TypedDict with PEP 728 closed/extra_items (default: enabled).
- `--use-decimal-for-multiple-of`: Generate Decimal types for fields with multipleOf constraint.
- `--use-generic-container-types`: Use generic container types (Sequence, Mapping) for type hinting.
- `--use-non-positive-negative-number-constrained-types`: Use NonPositive/NonNegative types for number constraints.
- `--use-object-type`: Use object instead of Any for unspecified object and array values.
- `--use-pendulum`: Use pendulum types for date, time, and duration fields.
- `--use-root-model-type-alias`: Generate RootModel as type alias format for better mypy support.
- `--use-specialized-enum`: Generate StrEnum/IntEnum for string/integer enums (Python 3.11+).
- `--use-standard-collections`: Use built-in dict/list instead of typing.Dict/List.
- `--use-standard-primitive-types`: Use Python standard library types for string formats instead of str.
- `--use-tuple-for-fixed-items`: Generate tuple types for arrays with items array syntax.
- `--use-type-alias`: Use TypeAlias instead of root models for type definitions (experimental).
- `--use-union-operator`: Use | operator for Union types (PEP 604).
- `--use-unique-items-as-set`: Generate set types for arrays with uniqueItems constraint.

### Field Customization
- `--aliases`: Apply custom field and class name aliases via inline JSON or a JSON file path.
- `--capitalize-enum-members`: Capitalize enum member names to UPPER_CASE format.
- `--default-values`: Override field default values via inline JSON or a JSON file path.
- `--empty-enum-field-name`: Name for empty string enum field values.
- `--extra-fields`: Configure how generated models handle extra fields not defined in schema.
- `--field-constraints`: Generate Field() with validation constraints from schema.
- `--field-extra-keys`: Include specific extra keys in Field() definitions.
- `--field-extra-keys-without-x-prefix`: Include schema extension keys in Field() without requiring 'x-' prefix.
- `--field-include-all-keys`: Include all schema keys in Field() json_schema_extra.
- `--field-type-collision-strategy`: Rename type class instead of field when names collide (Pydantic v2 only).
- `--infer-union-variant-names`: Infer names for inline oneOf/anyOf object variants from literal fields.
- `--no-alias`: Disable Field alias generation for non-Python-safe property names.
- `--no-snake-case-field`
- `--original-field-name-delimiter`: Specify delimiter for original field names when using snake-case conversion.
- `--remove-special-field-name-prefix`: Remove the special prefix from field names.
- `--serialization-aliases`: Apply custom Pydantic v2 serialization aliases via inline JSON or a JSON file path.
- `--set-default-enum-member`: Set the first enum member as the default value for enum fields.
- `--snake-case-field`: Convert field names to snake_case format.
- `--special-field-name-prefix`: Prefix to add to special field names (like reserved keywords).
- `--use-attribute-docstrings`: Generate field descriptions as attribute docstrings instead of Field descriptions.
- `--use-enum-values-in-discriminator`: Use enum values in discriminator mappings for union types.
- `--use-field-description`: Include schema descriptions as Field docstrings.
- `--use-field-description-example`: Add field examples to docstrings.
- `--use-inline-field-description`: Add field descriptions as inline comments.
- `--use-schema-description`: Use schema description as class docstring.
- `--use-serialization-alias`: Use serialization_alias instead of alias for field aliasing (Pydantic v2 only).
- `--use-single-line-docstring`: Emit short docstrings on a single line.
- `--use-title-as-name`: Use schema title as the generated class name.

### Model Customization
- `--alias-generator`: Use a Pydantic v2 alias generator in model_config.
- `--allow-extra-fields`: Allow extra fields in generated Pydantic models (extra='allow').
- `--allow-leading-underscore-class-name`: Allow an explicitly specified root class name to start with an unders...
- `--allow-population-by-field-name`: Allow Pydantic model population by field name (not just alias).
- `--base-class`: Specify a custom base class for generated models.
- `--base-class-map`: Specify different base classes for specific models via JSON mapping.
- `--class-name`: Override the auto-generated class name with a custom name.
- `--class-name-affix-scope`: Control which classes receive the prefix/suffix.
- `--class-name-prefix`: Add a prefix to all generated class names.
- `--class-name-suffix`: Add a suffix to all generated class names.
- `--collapse-reuse-models`: Collapse duplicate models by replacing references instead of inheritance.
- `--collapse-root-models`: Inline root model definitions instead of creating separate wrapper classes.
- `--collapse-root-models-name-strategy`: Select which name to keep when collapsing root models with object refe...
- `--dataclass-arguments`: Customize dataclass decorator arguments via JSON dictionary.
- `--duplicate-name-suffix`: Customize suffix for duplicate model names.
- `--enable-faux-immutability`: Enable faux immutability in Pydantic models (frozen=True).
- `--force-optional`: Force all fields to be Optional regardless of required status.
- `--frozen-dataclasses`: Generate frozen dataclasses with optional keyword-only fields.
- `--keep-model-order`: Keep generated model order deterministic while respecting dependency constraints.
- `--keyword-only`: Generate dataclasses with keyword-only fields (Python 3.10+).
- `--model-extra-keys`: Add model-level schema extensions to ConfigDict json_schema_extra.
- `--model-extra-keys-without-x-prefix`: Strip x- prefix from model-level schema extensions and add to ConfigDic...
- `--model-name-map`: Rename generated model classes from a JSON mapping.
- `--naming-strategy`: Use parent-prefixed naming strategy for duplicate model names.
- `--no-allow-population-by-field-name`
- `--no-collapse-root-models`
- `--no-use-frozen-field`
- `--output-model-type`: Generate models from GraphQL with different output model types.
- `--parent-scoped-naming`: Namespace models by their parent scope to avoid naming conflicts.
- `--reuse-model`: Reuse identical model definitions instead of generating duplicates.
- `--reuse-scope`: Scope for model reuse detection (root or tree).
- `--skip-root-model`: Skip generation of root model when schema contains nested definitions.
- `--strict-nullable`: Treat default field as a non-nullable field.
- `--strip-default-none`: Remove fields with None as default value from generated models.
- `--target-pydantic-version`: Target Pydantic version for generated code compatibility.
- `--target-python-version`: Target Python version for generated code syntax and imports.
- `--union-mode`: Union mode for combining anyOf/oneOf schemas (smart or left_to_right).
- `--use-default`: Use default values from schema in generated models.
- `--use-default-factory-for-optional-nested-models`: Generate default_factory for optional nested model fields.
- `--use-default-kwarg`: Use default= keyword argument instead of positional argument for fields with defaults.
- `--use-frozen-field`: Generate frozen (immutable) field definitions for readOnly properties.
- `--use-generic-base-class`: Generate a shared base class with model configuration to avoid repetition (DRY).
- `--use-missing-sentinel`: Use Pydantic's MISSING sentinel for optional fields without defaults.
- `--use-one-literal-as-default`: Use single literal value as default when enum has only one option.
- `--use-root-model-sequence-interface`: Make non-null sequence-like Pydantic v2 RootModel classes implement col...
- `--use-serialize-as-any`: Wrap fields with subtypes in Pydantic's SerializeAsAny.
- `--use-subclass-enum`: Generate typed Enum subclasses for enums with specific field types.

### Template Customization
- `--additional-imports`: Add custom imports to generated output files.
- `--class-decorators`: Add custom decorators to generated model classes.
- `--custom-file-header`: Add custom header text to the generated file.
- `--custom-file-header-path`: Add custom header content from file to generated code.
- `--custom-formatters`: Apply custom Python code formatters to generated output.
- `--custom-formatters-kwargs`: Pass custom arguments to custom formatters via inline JSON or a JSON file path.
- `--custom-template-dir`: Use custom Jinja2 templates for model generation.
- `--disable-appending-item-suffix`: Disable appending 'Item' suffix to array item types.
- `--disable-timestamp`: Disable timestamp in generated file header for reproducible output.
- `--enable-command-header`: Include command-line options in file header for reproducibility.
- `--enable-generated-header-marker`: Include the @generated marker in file header for generated-code tooling.
- `--enable-version-header`: Include tool version information in file header.
- `--extra-template-data`: Pass custom template variables via inline JSON or a JSON file path.
- `--formatters`: Specify code formatters to apply to generated output.
- `--generate-schema-validators`: Generate experimental Pydantic v2 model validators for JSON Schema runtime rules.
- `--no-treat-dot-as-module`: Keep dots in schema names as underscores for flat output.
- `--no-use-type-checking-imports`: Keep generated model imports available at runtime when using Ruff fixes.
- `--schema-validator-base-class-name`: Set the generated shared Pydantic v2 schema runtime validator base class...
- `--schema-validator-type`: Select the schema-derived runtime validator backend.
- `--use-double-quotes`: Use double quotes for string literals in generated code.
- `--use-exact-imports`: Import exact types instead of modules.
- `--use-type-checking-imports`: Allow Ruff to move typing-only imports into TYPE_CHECKING blocks.
- `--validators`: Add custom field validators to generated Pydantic v2 models.
- `--wrap-string-literal`: Wrap long string literals across multiple lines.

### OpenAPI-only Options
- `--include-path-parameters`: Include OpenAPI path parameters in generated parameter models.
- `--openapi-include-info-version`: Emit OpenAPI info.version as a generated constant.
- `--openapi-include-paths`: Filter OpenAPI paths to include in model generation.
- `--openapi-scopes`: Specify OpenAPI scopes to generate (schemas, paths, parameters).
- `--read-only-write-only-model-type`: Generate separate request and response models for readOnly/writeOnly fields.
- `--use-operation-id-as-name`: Use OpenAPI operationId as the generated function/class name.
- `--use-status-code-in-response-name`: Include HTTP status code in response model names.
- `--validation`: Enable validation constraints (deprecated, use --field-constraints).

### GraphQL-only Options
- `--graphql-no-typename`: Exclude __typename field from generated GraphQL models.

### General Options
- `--all-exports-collision-strategy`: Handle name collisions when exporting recursive module hierarchies.
- `--all-exports-scope`: Generate __all__ exports for child modules in __init__.py files.
- `--allow-private-network`: Allow HTTP requests to private network schema endpoints.
- `--allow-remote-refs`: Enable fetching of `$ref` targets over HTTP/HTTPS.
- `--check`: Verify generated code matches existing output without modifying files.
- `--disable-warnings`: Suppress warning messages during code generation.
- `--generate-cli-command`: Generate CLI command from pyproject.toml configuration.
- `--generate-pyproject-config`: Generate pyproject.toml configuration from CLI arguments.
- `--http-headers`: Fetch schema from URL with custom HTTP headers.
- `--http-ignore-tls`: Disable TLS certificate verification for HTTPS requests.
- `--http-local-ref-path`: Resolve HTTP references from local schema files.
- `--http-query-parameters`: Add query parameters to HTTP requests for remote schemas.
- `--http-timeout`: Set timeout for HTTP requests to remote hosts.
- `--ignore-pyproject`: Ignore pyproject.toml configuration file.
- `--module-split-mode`: Split generated models into separate files, one per model class.
- `--no-allow-private-network`
- `--no-allow-remote-refs`
- `--shared-module-name`: Customize the name of the shared module for deduplicated models.
- `--watch`: Watch input file(s) for changes and regenerate output automatically.
- `--watch-delay`: Set debounce delay in seconds for watch mode.

## All Available Options (Full Help)

```
HELP
```

## Agent Task

Recommend a final CLI command for the user's schema and target runtime. Include:
- Final `datamodel-codegen` command in a shell code block.
- Brief explanation for each selected option.
- Rejected alternatives with the reason they do not fit.
- Verification command, such as `datamodel-codegen ... --output models.py --check` (`--check` requires `--output`) or a diff against expected output.

## Decision Checklist

- Input type: auto-detected schema/data, OpenAPI, AsyncAPI, JSON Schema, MCP tools, XML Schema, Protocol Buffers, Avro, GraphQL, CSV, Python input model, or raw JSON/YAML/dict data.
- Output model type: `pydantic_v2.BaseModel`, `pydantic_v2.dataclass`, `dataclasses.dataclass`, `typing.TypedDict`, or `msgspec.Struct`.
- Python/Pydantic version: align `--target-python-version`, `--output-model-type`, and `--target-pydantic-version` when generating Pydantic v2 models.
- Strictness: choose `--strict-types` values, `--strict-nullable`, `--field-constraints`, and `--extra-fields`.
- Aliases/naming: decide between API-compatible aliases and normalized names such as `--snake-case-field`.
- Module layout: choose one file or an output directory with `--module-split-mode` and reuse options.
- Structured output: use `--output-format json` for machine-readable prompt or generation output, `--emit-model-metadata` for generated model maps, and `--output-format-json-schema` when a tool needs a validation schema.
- Runtime model base: use `--base-class` for a custom base class; it is separate from `--output-model-type`.
- Validation constraints: prefer `--field-constraints`; add `--use-annotated` for Pydantic v2.

## Common Recipes

- Strict Pydantic v2: `--output-model-type pydantic_v2.BaseModel --target-pydantic-version 2.11 --use-annotated --field-constraints`, plus needed `--strict-types` values.
- OpenAPI request/response models: `--input-file-type openapi --openapi-scopes schemas paths --read-only-write-only-model-type request-response`.
- TypedDict modern syntax: `--output-model-type typing.TypedDict --target-python-version 3.12 --use-standard-collections --use-union-operator`.
- Multi-module OpenAPI output: set `--output` to a directory and use `--module-split-mode single --all-exports-scope recursive --use-exact-imports`.
- Machine-readable agent flow: run `--generate-prompt --output-format json` first, then validate tool integration with `--output-format-json-schema generate-prompt` or `structured-output`.

## Important Option Relationships

- `--use-annotated` also enables `--field-constraints`; prefer it for constrained Pydantic v2 fields.
- `--openapi-include-paths` only has an effect when `--openapi-scopes paths` is included.
- `--strict-types` requires one or more values: `str`, `int`, `float`, `bool`, or `bytes`.
- `--use-specialized-enum` requires `--target-python-version >= 3.11`.
- `--output-format json` is supported for generation, `--generate-prompt`, and `--check`; not for `--watch`.
- `--output-format-json-schema` accepts `config`, `generate-prompt`, `generation`, `model-metadata`, or `structured-output`; use `config` for JSON configuration schemas.
- `--validation` is deprecated; use `--field-constraints` for generated Field constraints.

## Instructions

Based on the above information, propose the smallest datamodel-codegen
command that satisfies the question or use case. Preserve current options
unless they conflict with the goal or another option. Include:

1. Final CLI command to run
2. Reasons for each non-obvious added or changed option
3. Current options that should remain unchanged
4. Options considered but rejected, with a short reason
5. Verification command that validates the generated CLI or output