createCLISchema

Generated reference page for the createCLISchema function export.

• Import: @kjanat/dreamcli
• Export kind: function
• Declared in: src/core/cli/index.ts
• Source link: src/core/cli/index.ts:663

Signatures

function createCLISchema(definition: CLIDefinition): CLISchema;

Parameter	Type	Description
definition	CLIDefinition	Program name plus optional metadata and commands.

Members

Members

createCLISchema

Create a CLISchema from a plain definition object.

Most consumers should prefer cli(), which returns a CLIBuilder carrying the execution graph. createCLISchema() builds a description only: it normalizes commands recursively through createCommandSchema, so handlers and execution steps are not part of the result and the schema cannot be executed.

Feeding a built schema back in produces a deep-equal schema.

(definition: CLIDefinition): CLISchema;

Examples

const schema = createCLISchema({
  name: 'mycli',
  version: '1.0.0',
  commands: [{ name: 'deploy', flags: { force: { kind: 'boolean' } } }],
});

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli