Skip to content

DefinitionDocumentV1 ​

A whole-CLI definition document, version 1.

Produced by generateSchema. Validated by definitionMetaSchema and served at DEFINITION_SCHEMA_URL.

Signatures ​

ts
type DefinitionDocumentV1 = { $schema: string; schemaVersion: 1; name: string; version?: string; description?: string; envPrefix?: string; groupOrder?: readonly string[]; defaultCommand?: CommandDefinitionFragmentV1; commands: readonly CommandDefinitionFragmentV1[]; };

Members ​

Members ​

$schema ​

ts
$schema: string;

schemaVersion ​

ts
schemaVersion: 1;

name ​

ts
name: string;

version ​

ts
version?: string;

description ​

ts
description?: string;

envPrefix ​

CLI-wide env namespace. Each relative envVar, and each count and template of a relative envIndexed, reads with this prefix prepended; a fragment marked envAbsolute reads its names as written.

ts
envPrefix?: string;

groupOrder ​

Named help groups to display first, in order.

ts
groupOrder?: readonly string[];

defaultCommand ​

ts
defaultCommand?: CommandDefinitionFragmentV1;

commands ​

ts
commands: readonly CommandDefinitionFragmentV1[];

See Also ​

Released under the MIT License.