JsonSchemaOptions
Options for JSON Schema generation.
Both generateSchema and generateInputSchema accept these options to control which parts of the CLI schema are included in the output.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:55
Signatures
ts
interface JsonSchemaOptions {}Members
Properties
includeHidden
Include commands marked as hidden.
When true (default), hidden commands appear in the output with hidden: true (definition schema) or as valid branches (input schema). When false, hidden commands and their entire subtrees are excluded.
ts
includeHidden?: boolean;includePrompts
Include prompt configuration on flags.
When false, prompt configs are omitted even if defined on flags. Useful for producing a schema focused on the non-interactive CLI surface only.
Only affects generateSchema output — prompt configs are never included in generateInputSchema output.
ts
includePrompts?: boolean;