@kjanat/dreamcli/json-schema

Definition documents and input JSON Schema generation. --help --json loads this module on demand; import it directly to emit documents from build scripts and tooling.

import {
  generateSchema,
  generateCommandSchema,
  generateInputSchema,
  definitionMetaSchema,
  DEFINITION_SCHEMA_URL,
  DEFINITION_SCHEMA_VERSION,
} from '@kjanat/dreamcli/json-schema';
import type { DefinitionDocument, InputSchemaDocument } from '@kjanat/dreamcli/json-schema';

The document types (DefinitionDocument, CommandDefinitionDocument, every *FragmentV1, and InputSchemaDocument) are also exported from the root entry, so code that only names the shapes does not need this subpath. The same goes for DEFINITION_SCHEMA_URL and DEFINITION_SCHEMA_VERSION: importing them from this subpath also evaluates the generators, so take the root copies when the constants are all you need.

generateSchema(schema, options?, meta?)

Generate a definition metadata document describing the CLI's structure.

• schema: CLISchema from cli.schema
• options.includeHidden?: include hidden commands (default: true)
• options.includePrompts?: include prompt config on flags (default: true)
• meta?: ExampleMeta ({ name, version }) used to resolve function-form examples; defaults to the schema's own name and version

import { cli, command } from '@kjanat/dreamcli';
import { generateSchema } from '@kjanat/dreamcli/json-schema';

const myCli = cli('mycli').command(command('deploy'));

const definition = generateSchema(myCli.schema);

generateInputSchema(schema, options?)

Generate a JSON Schema (draft 2020-12) for validating CLI input as JSON.

• schema: CLISchema or CommandSchema
• options.includeHidden?: include hidden commands (default: true)

Accepts a full CLISchema (discriminated union across commands) or a single CommandSchema (flat object schema).

import { cli, command } from '@kjanat/dreamcli';
import { generateInputSchema } from '@kjanat/dreamcli/json-schema';

const myCli = cli('mycli').command(command('deploy'));

const inputSchema = generateInputSchema(myCli.schema);

generateCommandSchema(schema, options?, meta?)

Generate a standalone definition document for one CommandSchema. --help --json on a command serializes through it. options and meta match generateSchema(); meta defaults to the command name with no version.

definitionMetaSchema

The definition meta-schema as a value, identical to the bytes of @kjanat/dreamcli/schema and the hosted copy at DEFINITION_SCHEMA_URL.

DEFINITION_SCHEMA_URL and DEFINITION_SCHEMA_VERSION

The $schema URL every definition document carries and the format version it reports as schemaVersion. Both constants are also exported from the root entry.