🖥️ CLI Reference¶
This documentation is auto-generated from test cases.
🔍 Quick Reference - All options on one page for Ctrl+F search
📂 Categories¶
| Category | Options | Description |
|---|---|---|
| 📁 Base Options | 12 | Input/output configuration |
| 🔧 Typing Customization | 30 | Type annotation and import behavior |
| 🏷️ Field Customization | 27 | Field naming and docstring behavior |
| 🏗️ Model Customization | 44 | Model generation behavior |
| 🎨 Template Customization | 25 | Output formatting and custom rendering |
| 📘 OpenAPI-only Options | 8 | OpenAPI-specific features |
| 📋 GraphQL-only Options | 1 | |
| ⚙️ General Options | 18 | Utilities and meta options |
| 📝 Utility Options | 10 | Help, version, debug options |
🎯 Focused Topics¶
Use these pages when you know the workflow area but not the exact option name.
| Topic | Options | Groups |
|---|---|---|
| Model Customization | 23 | Model Naming, Model Reuse, Model Shape, Root Model |
| Template Customization | 19 | Custom Templates, Generated Output, Imports, Output Formatting |
| Typing Customization | 20 | Imports, Collection Types, Type Alias, Type Mapping, Type Syntax |
| OpenAPI | 7 | OpenAPI Naming, OpenAPI Paths, OpenAPI Scopes, Read Only Write Only |
🔗 Option Relationships¶
These links are generated from CLI option metadata and summarize options that imply, require, or conflict with other options.
| Source | Kind | Condition | Target | Note |
|---|---|---|---|---|
--use-annotated |
Implies | Always | --field-constraints enabled |
- |
--use-specialized-enum |
Requires | Always | --target-python-version = 3.11+ |
--use-specialized-enum requires --target-python-version 3.11 or higher. |
--original-field-name-delimiter |
Requires | Always | --snake-case-field enabled |
--original-field-name-delimiter can not be used without --snake-case-field. |
--allow-extra-fields |
Implies | Always | --extra-fields = allow |
- |
--collapse-root-models-name-strategy |
Requires | Always | --collapse-root-models enabled |
--collapse-root-models-name-strategy requires --collapse-root-models. |
--keyword-only |
Requires | Always | --target-python-version = 3.10+ |
--keyword-only requires --target-python-version 3.10 or higher for dataclasses. |
--output-model-type |
Implies | --output-model-type = msgspec.Struct |
--use-annotated enabled |
- |
--parent-scoped-naming |
Implies | Always | --naming-strategy = parent-prefixed |
- |
--reuse-scope |
Requires | --reuse-scope = tree |
--reuse-model enabled |
--reuse-scope=tree has no effect without --reuse-model. |
--union-mode |
Requires | Always | --output-model-type = pydantic_v2.BaseModel |
--union-mode is only supported for --output-model-type pydantic_v2.BaseModel. |
--use-missing-sentinel |
Implies | Always | --target-pydantic-version = 2.12 |
- |
--use-missing-sentinel |
Requires | Always | --output-model-type = pydantic_v2.BaseModel |
--use-missing-sentinel is only supported for --output-model-type pydantic_v2.BaseModel. |
--custom-file-header |
Conflicts | Always | --custom-file-header-path |
--custom-file-header can not be used with --custom-file-header-path. |
--custom-file-header-path |
Conflicts | Always | --custom-file-header |
--custom-file-header-path can not be used with --custom-file-header. |
--all-exports-collision-strategy |
Requires | Always | --all-exports-scope = recursive |
--all-exports-collision-strategy can only be used with --all-exports-scope=recursive. |
All Options¶
Jump to: A · B · C · D · E · F · G · H · I · K · L · M · N · O · P · R · S · T · U · V · W
A¶
--additional-imports--alias-generator--aliases--all-exports-collision-strategy--all-exports-scope--allof-class-hierarchy--allof-merge-mode--allow-extra-fields--allow-leading-underscore-class-name--allow-population-by-field-name--allow-private-network--allow-remote-refs
B¶
C¶
--capitalize-enum-members--check--class-decorators--class-name--class-name-affix-scope--class-name-prefix--class-name-suffix--collapse-reuse-models--collapse-root-models--collapse-root-models-name-strategy--custom-file-header--custom-file-header-path--custom-formatters--custom-formatters-kwargs--custom-template-dir
D¶
--dataclass-arguments--debug--default-values--disable-appending-item-suffix--disable-future-imports--disable-timestamp--disable-warnings--duplicate-name-suffix
E¶
--emit-model-metadata--empty-enum-field-name--enable-command-header--enable-faux-immutability--enable-generated-header-marker--enable-version-header--encoding--enum-field-as-literal--enum-field-as-literal-map--external-ref-mapping--extra-fields--extra-template-data
F¶
--field-constraints--field-extra-keys--field-extra-keys-without-x-prefix--field-include-all-keys--field-type-collision-strategy--force-optional--formatters--frozen-dataclasses
G¶
--generate-cli-command--generate-prompt--generate-pyproject-config--generate-schema-validators--graphql-no-typename
H¶
--help--http-headers--http-ignore-tls--http-local-ref-path--http-query-parameters--http-timeout
I¶
--ignore-enum-constraints--ignore-pyproject--include-path-parameters--infer-union-variant-names--input--input-file-type--input-model--input-model-ref-strategy
K¶
L¶
M¶
N¶
--naming-strategy--no-alias--no-color--no-treat-dot-as-module--no-use-closed-typed-dict--no-use-specialized-enum--no-use-standard-collections--no-use-type-checking-imports--no-use-union-operator
O¶
--openapi-include-info-version--openapi-include-paths--openapi-scopes--original-field-name-delimiter--output--output-date-class--output-datetime-class--output-format--output-format-json-schema--output-model-type
P¶
R¶
S¶
--schema-validator-base-class-name--schema-validator-type--schema-version--schema-version-mode--serialization-aliases--set-default-enum-member--shared-module-name--skip-root-model--snake-case-field--special-field-name-prefix--strict-nullable--strict-types--strip-default-none
T¶
--target-pydantic-version--target-python-version--treat-dot-as-module--type-mappings--type-overrides
U¶
--union-mode--url--use-annotated--use-attribute-docstrings--use-closed-typed-dict--use-decimal-for-multiple-of--use-default--use-default-factory-for-optional-nested-models--use-default-kwarg--use-double-quotes--use-enum-values-in-discriminator--use-exact-imports--use-field-description--use-field-description-example--use-frozen-field--use-generic-base-class--use-generic-container-types--use-inline-field-description--use-missing-sentinel--use-non-positive-negative-number-constrained-types--use-object-type--use-one-literal-as-default--use-operation-id-as-name--use-pendulum--use-root-model-sequence-interface--use-root-model-type-alias--use-schema-description--use-serialization-alias--use-serialize-as-any--use-single-line-docstring--use-specialized-enum--use-standard-collections--use-standard-primitive-types--use-status-code-in-response-name--use-subclass-enum--use-title-as-name--use-tuple-for-fixed-items--use-type-alias--use-type-checking-imports--use-union-operator--use-unique-items-as-set