🖥️ 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 | 19 | Input/output configuration |
| 🔧 Typing Customization | 55 | Type annotation and import behavior |
| 🏷️ Field Customization | 38 | Field naming and docstring behavior |
| 🏗️ Model Customization | 72 | Model generation behavior |
| 🎨 Template Customization | 30 | Output formatting and custom rendering |
| 📘 OpenAPI-only Options | 15 | OpenAPI-specific features |
| 📋 GraphQL-only Options | 1 | |
| ⚙️ General Options | 25 | Utilities and meta options |
| 🚀 Target Generation Options | 25 | Server and client generation with the models (experimental) |
| 📝 Utility Options | 15 | 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 | 35 | Model Naming, Model Reuse, Model Shape, Root Model |
| Template Customization | 23 | Custom Templates, Generated Output, Imports, Output Formatting |
| Typing Customization | 36 | Imports, Collection Types, Type Alias, Type Mapping, Type Syntax |
| OpenAPI | 14 | 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 |
|---|---|---|---|---|
--intersect-combined-schema-keywords |
Implies | Always | --intersect-allof-keywords enabled |
- |
--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. |
--use-type-alias-type |
Implies | Always | --use-type-alias enabled |
- |
--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 |
--use-missing-sentinel is only supported for --output-model-type pydantic_v2.BaseModel or pydantic_v2.dataclass. |
--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. |
--diff-against |
Requires | Always | --input |
--diff-against requires --input with the current local schema path. |
--diff-against |
Requires | Always | --output |
--diff-against requires --output to select file or directory output layout. |
--diff-against |
Conflicts | Always | --check |
- |
--diff-against |
Conflicts | Always | --watch |
- |
--diff-against |
Conflicts | Always | --url |
- |
--diff-against |
Conflicts | Always | --input-model |
- |
--diff-against |
Conflicts | Always | --emit-model-metadata |
- |
--diff-against |
Conflicts | Always | --fail-on-multi-module-stdout |
- |
--diff-against |
Conflicts | Always | --job |
--diff-against compares one profile or input and cannot run named jobs. |
--diff-against |
Conflicts | Always | --all-jobs |
--diff-against compares one profile or input and cannot run named jobs. |
--locked |
Conflicts | Always | --update-lock |
- |
--update-lock |
Conflicts | Always | --locked |
- |
--client-body-arguments |
Requires | Always | --generate-client |
--client-body-arguments requires --generate-client httpx2. |
--client-default-base-url |
Requires | Always | --generate-client |
--client-default-base-url requires --generate-client httpx2. |
--client-model-package |
Requires | Always | --generate-client |
--client-model-package requires --generate-client httpx2. |
--client-operations |
Requires | Always | --generate-client |
--client-operations requires --generate-client httpx2. |
--client-output |
Requires | Always | --generate-client |
--client-output requires --generate-client httpx2. |
--client-package |
Requires | Always | --generate-client |
--client-package requires --generate-client httpx2. |
--client-protocols |
Requires | Always | --generate-client |
--client-protocols requires --generate-client httpx2. |
--client-resource-names |
Requires | Always | --generate-client |
--client-resource-names requires --generate-client httpx2. |
--client-server-base-url |
Requires | Always | --generate-client |
--client-server-base-url requires --generate-client httpx2. |
--client-signature-style |
Requires | Always | --generate-client |
--client-signature-style requires --generate-client httpx2. |
--generate-client |
Requires | Always | --client-output |
--generate-client requires --client-output. |
--generate-client |
Requires | Always | --client-package |
--generate-client requires --client-package. |
--generate-client |
Requires | Always | --client-model-package |
--generate-client requires --client-model-package. |
--generate-client |
Requires | Always | --input-file-type = openapi |
--generate-client requires --input-file-type openapi. |
--generate-client |
Conflicts | Always | --generate-server |
--generate-client can not be used with --generate-server. |
--generate-server |
Requires | Always | --server-output |
--generate-server requires --server-output. |
--generate-server |
Requires | Always | --server-package |
--generate-server requires --server-package. |
--generate-server |
Requires | Always | --server-model-package |
--generate-server requires --server-model-package. |
--generate-server |
Requires | Always | --input-file-type = openapi |
--generate-server requires --input-file-type openapi. |
--generate-server |
Conflicts | Always | --generate-client |
--generate-server can not be used with --generate-client. |
--server-body-mode |
Requires | Always | --generate-server |
--server-body-mode requires --generate-server fastapi. |
--server-body-modes |
Requires | Always | --generate-server |
--server-body-modes requires --generate-server fastapi. |
--server-handler-mode |
Requires | Always | --generate-server |
--server-handler-mode requires --generate-server fastapi. |
--server-handler-modes |
Requires | Always | --generate-server |
--server-handler-modes requires --generate-server fastapi. |
--server-include-request |
Requires | Always | --generate-server |
--server-include-request requires --generate-server fastapi. |
--server-layout |
Requires | Always | --generate-server |
--server-layout requires --generate-server fastapi. |
--server-model-package |
Requires | Always | --generate-server |
--server-model-package requires --generate-server fastapi. |
--server-operation-names |
Requires | Always | --generate-server |
--server-operation-names requires --generate-server fastapi. |
--server-output |
Requires | Always | --generate-server |
--server-output requires --generate-server fastapi. |
--server-package |
Requires | Always | --generate-server |
--server-package requires --generate-server fastapi. |
--server-parameter-names |
Requires | Always | --generate-server |
--server-parameter-names requires --generate-server fastapi. |
--server-primary-responses |
Requires | Always | --generate-server |
--server-primary-responses requires --generate-server fastapi. |
--server-router-names |
Requires | Always | --generate-server |
--server-router-names requires --generate-server fastapi. |
All Options¶
Jump to: A · B · C · D · E · F · G · H · I · J · 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--all-jobs--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--apply-field-options-to-every-field
B¶
C¶
--capitalize-enum-members--capitalize-numbered-enum-members--check--check-pattern-maps-strictly--class-decorators--class-name--class-name-affix-scope--class-name-prefix--class-name-suffix--client-body-arguments--client-default-base-url--client-model-package--client-operations--client-output--client-package--client-protocols--client-resource-names--client-server-base-url--client-signature-style--collapse-constrained-root-models-as-annotated--collapse-reuse-models--collapse-root-models--collapse-root-models-name-strategy--collapse-shared-parent-wrappers--custom-file-header--custom-file-header-mode--custom-file-header-path--custom-formatters--custom-formatters-kwargs--custom-template-dir
D¶
--dataclass-arguments--debug--dedupe-numbered-request-response-variants--dedupe-request-response-variants--default-values--deserialize-default-values--diff-against--disable-appending-item-suffix--disable-future-imports--disable-timestamp--disable-warnings--distribute-allof-over-unions--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¶
--fail-on-multi-module-stdout--field-constraints--field-extra-keys--field-extra-keys-without-x-prefix--field-include-all-keys--field-type-collision-strategy--filter-literal-values--force-optional--formatters--frozen-dataclasses
G¶
--generate-cli-command--generate-client--generate-prompt--generate-pyproject-config--generate-schema-validators--generate-server--graphql-no-typename
H¶
--help--http-backend--http-headers--http-ignore-tls--http-local-ref-path--http-query-parameters--http-timeout
I¶
--ignore-enum-constraints--ignore-pyproject--ignore-ref-siblings-by-schema-version--import-overrides--include-path-parameters--infer-union-variant-names--input--input-file-type--input-model--input-model-ref-strategy--install-skill--intersect-allof-keywords--intersect-combined-schema-keywords
J¶
K¶
--keep-constrained-root-models-in-every-container--keep-content-parameter-refs--keep-defaults-of-inherited-required-fields--keep-enum-literal-aliases--keep-enum-member-values--keep-false-dataclass-arguments--keep-field-defaults-off-branch-roots--keep-first-character-of-path-keys--keep-model-order--keep-reference-null-on-collapsed-root-models--keep-reference-null-on-merged-models--keep-self-referencing-array-items--keep-shared-members-on-collapsed-root-models--keyword-only
L¶
M¶
--merge-message-trait-headers--merge-shared-variant-tags--model-extra-keys--model-extra-keys-without-x-prefix--model-name-map--module-split-mode
N¶
--name-allof-union-members-after-branches--name-converted-payloads-by-message--naming-strategy--no-alias--no-color--no-deserialize-default-values--no-formatters--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¶
--omit-incomplete-model-defaults--omit-redundant-constraints--omit-redundant-reference-null--openapi-as-definitions--openapi-include-info-version--openapi-include-paths--openapi-scopes--order-constructor-fields-by--original-field-name-delimiter--output--output-date-class--output-datetime-class--output-format--output-format-json-schema--output-model-type--overwrite-skill
P¶
R¶
--read-allof-parents-in-mro-order--read-const-beside-enum--read-dynamic-anchors-in-document-order--read-escaped-ref-pointers--read-input-model-dataclass-fields-by-alias--read-length-keywords-by-type--read-msgspec-union-bounds-exactly--read-nullable-beside-type-list--read-only-write-only-model-type--read-schema-version-per-document--read-unevaluated-properties--recommend-options--remove-special-field-name-prefix--remove-unused-models-beside-type-overrides--rename-submodules-hidden-by-classes--reuse-every-reached-input-model-type--reuse-model--reuse-scope
S¶
--schema-validator-base-class-name--schema-validator-type--schema-version--schema-version-mode--serialization-aliases--server-body-mode--server-body-modes--server-handler-mode--server-handler-modes--server-include-request--server-layout--server-model-package--server-operation-names--server-output--server-package--server-parameter-names--server-primary-responses--server-router-names--set-default-enum-member--shared-module-name--singularize-last-word-of-item-names--skill-scope--skip-path-extension-keys--skip-root-model--snake-case-field--special-field-name-prefix--strict-dotted-module-names--strict-nullable--strict-refs--strict-types--strip-default-none
T¶
--tag-msgspec-by-payload-name--target-pydantic-version--target-python-version--treat-dot-as-module--type-mappings--type-overrides--type-overrides-replace-whole-type
U¶
--union-mode--update-lock--url--use-annotated--use-attribute-docstrings--use-bytes-for-content-media-type--use-closed-typed-dict--use-decimal-for-multiple-of--use-decimal-in-field-forms--use-default--use-default-factory-for-optional-nested-models--use-default-kwarg--use-double-quotes--use-duplicate-name-suffix-for-every-collision--use-encoded-str-for-constrained-base64--use-enum-field-as-literal-in-operations--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-msgspec-forbid-unknown-fields--use-msgspec-meta-for-map-keys--use-msgspec-nullable-enum-alias--use-msgspec-tagged-unions--use-non-positive-negative-number-constrained-types--use-object-type--use-one-literal-as-default--use-one-model-per-ref-site--use-operation-id-as-name--use-pendulum--use-plain-alias-for-recursive-models--use-root-model-sequence-interface--use-root-model-type-alias--use-schema-description--use-serialization-alias--use-serialize-as-any--use-serialize-as-any-for-every-subclass--use-single-dict-for-object-maps--use-single-line-docstring--use-single-value-enum-as-const--use-site-models-for-constrained-refs--use-specialized-enum--use-standard-collections--use-standard-primitive-types--use-status-code-in-response-name--use-strict-str-for-base64--use-subclass-enum--use-tag-as-union-variant-name--use-title-as-name--use-total-false-for-typed-dict--use-tuple-for-closed-arrays--use-tuple-for-fixed-items--use-tuple-for-fixed-length-arrays--use-type-alias--use-type-alias-type--use-type-checking-imports--use-typed-map-values-beside-other-types--use-typed-nullable-map-values--use-union-operator--use-unique-items-as-set--use-unique-items-as-set-by-value--use-x-python-type-as-written