generateSchema
Generated reference page for the generateSchema function export.
- Import:
@kjanat/dreamcli - Export kind: function
- Declared in:
src/core/json-schema/index.ts - Source link:
src/core/json-schema/index.ts:130
Signatures
ts
function generateSchema(schema: CLISchema, options?: JsonSchemaOptions, meta?: ExampleMeta): Record<string, unknown>;| Parameter | Type | Description |
|---|---|---|
schema | CLISchema | The CLI schema from CLIBuilder.schema. |
options | JsonSchemaOptions | undefined | Generation options. |
meta | ExampleMeta | undefined | Program name/version for function-form examples; defaults to the CLI schema's own name/version. |
Members
Members
generateSchema
Generate a definition metadata document describing the CLI's structure.
Walks the full command tree and produces a plain JSON-serializable object representing all commands, subcommands, flags, args, and metadata. Non-serializable runtime values (parse functions, interactive resolvers) are omitted.
ts
(schema: CLISchema, options?: JsonSchemaOptions, meta?: ExampleMeta): Record<string, unknown>;Examples
ts
const app = cli('myapp').version('1.0.0').command(deploy);
const definition = generateSchema(app.schema);
writeFileSync('cli-schema.json', JSON.stringify(definition, null, 2));