diff --git a/docs/cli.md b/docs/cli.md index 70dac19c2..bfa323b89 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -81,23 +81,26 @@ resolve: Refer to the [Redocly docs](https://redocly.com/docs/cli/configuration/#resolve-non-public-or-non-remote-urls) for additional options. -## Options +## Flags -| Option | Alias | Default | Description | +The following flags are supported in the CLI: + +| Flag | Alias | Default | Description | | :------------------------ | :---- | :------: | :------------------------------------------------------------------------------------------------------------------ | | `--help` | | | Display inline help message and exit | | `--version` | | | Display this library’s version and exit | | `--output [location]` | `-o` | (stdout) | Where should the output file be saved? | | `--redoc [location]` | | | Path to a `redocly.yaml` file (see [Multiple schemas](#multiple-schemas)) | -| `--immutable` | | `false` | Generates immutable types (readonly properties and readonly array) | | `--additional-properties` | | `false` | Allow arbitrary properties for all schema objects without `additionalProperties: false` | -| `--empty-objects-unknown` | | `false` | Allow arbitrary properties for schema objects with no specified properties, and no specified `additionalProperties` | +| `--alphabetize` | | `false` | Sort types alphabetically | +| `--array-length` | | `false` | Generate tuples using array `minItems` / `maxItems` | | `--default-non-nullable` | | `false` | Treat schema objects with default values as non-nullable | +| `--empty-objects-unknown` | | `false` | Allow arbitrary properties for schema objects with no specified properties, and no specified `additionalProperties` | +| `--enum` | | `false` | Generate true [TS enums](https://www.typescriptlang.org/docs/handbook/enums.html) rather than string unions. | +| `--exclude-deprecated` | | `false` | Exclude deprecated fields from types | | `--export-type` | `-t` | `false` | Export `type` instead of `interface` | +| `--immutable` | | `false` | Generates immutable types (readonly properties and readonly array) | | `--path-params-as-types` | | `false` | Allow dynamic string lookups on the `paths` object | -| `--array-length` | | `false` | Generate tuples using array `minItems` / `maxItems` | -| `--alphabetize` | | `false` | Sort types alphabetically | -| `--exclude-deprecated` | | `false` | Exclude deprecated fields from types | ### pathParamsAsTypes