//#region src/core/json-schema/meta-descriptions.generated.d.ts /** * Generated definition meta-schema descriptions from normalized TypeDoc output. * * @module */ declare const definitionMetaSchemaDescriptions: { readonly root: { readonly description: "Runtime descriptor for the CLI program.\n\nStores the program name, version, description, and registered commands.\\\nBuilt incrementally by CLIBuilder."; readonly properties: { readonly name: { readonly description: "Program name (used in help text, usage lines, and completion scripts)."; }; readonly version: { readonly description: "Program version (shown by `--version`)."; }; readonly description: { readonly description: "Program description (shown in root help)."; }; readonly defaultCommand: { readonly description: "Default command dispatched when no subcommand matches.\n\nWhen set, the CLI root behaves like a hybrid command group: subcommands\ndispatch by name as usual, but empty argv or flags-only argv falls\nthrough to this command instead of showing root help.\n\nSet via the .default() builder method."; }; readonly commands: { readonly description: "Registered commands (type-erased for heterogeneous storage)."; }; }; }; readonly defs: { readonly command: { readonly description: "Runtime descriptor produced by CommandBuilder.\n\nConsumers (parser, help generator, CLI dispatcher) read this to\nunderstand the command's shape — flags, args, aliases, subcommands,\nmiddleware, and interactive resolver."; readonly properties: { readonly name: { readonly description: "The command name (used for dispatch, e.g. `'deploy'`)."; }; readonly description: { readonly description: "Human-readable description for help text."; }; readonly aliases: { readonly description: "Alternative names for this command."; }; readonly hidden: { readonly description: "Whether this command is hidden from help listings."; }; readonly examples: { readonly description: "Usage examples for help text."; }; readonly flags: { readonly description: "Named flag schemas, keyed by flag name."; }; readonly args: { readonly description: "Ordered positional arg entries (name + schema)."; }; readonly commands: { readonly description: "Nested subcommand schemas (for help rendering and completion).\n\nPure data — no execution closures. Populated by `.command()` on\n`CommandBuilder`. Empty for leaf commands."; }; }; }; readonly flag: { readonly description: "The runtime descriptor stored inside every FlagBuilder. Consumers (parser,\nhelp generator, resolution chain) read this to understand the flag's shape\nwithout touching generics."; readonly properties: { readonly kind: { readonly description: "What kind of value this flag accepts."; }; readonly presence: { readonly description: "Presence describes whether a flag value is guaranteed to exist when the\naction handler runs:\n\n- `'optional'` — not required; unresolved value follows the kind-specific\n optional fallback (`undefined` for most flags, `[]` for arrays)\n- `'required'` — must be supplied; error if missing\n- `'defaulted'` — always present (falls back to default value)"; }; readonly defaultValue: { readonly description: "Runtime default value (if any)."; }; readonly aliases: { readonly description: "Short/long aliases (e.g. `[{ name: 'f', hidden: false }]` for `--force`)."; }; readonly envVar: { readonly description: "Environment variable name for v0.2+ resolution."; }; readonly configPath: { readonly description: "Dotted config path for v0.2+ resolution (e.g. `'deploy.region'`)."; }; readonly description: { readonly description: "Human-readable description for help text."; }; readonly enumValues: { readonly description: "Allowed literal values when `kind === 'enum'`."; }; readonly elementSchema: { readonly description: "Element schema when `kind === 'array'`."; }; readonly prompt: { readonly description: "Interactive prompt configuration for v0.3+ resolution."; }; readonly deprecated: { readonly description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated flag is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: ]`."; }; readonly propagate: { readonly description: "Whether this flag propagates to subcommands in nested command trees.\n\nWhen `true`, the flag is automatically available to all descendant\ncommands. A child command that defines a flag with the same name\nshadows the propagated parent flag.\n\nDefault: `false`"; }; readonly negation: { readonly description: "Negation settings when `kind === 'boolean'` and `.negatable()` was\ncalled (`undefined` otherwise). See FlagNegation."; }; readonly duplicates: { readonly description: "How repeated CLI occurrences of a singleton flag combine.\n\n- `'last'` — last occurrence wins (matches historic behavior)\n- `'first'` — first occurrence wins; later ones parse but are ignored\n- `'error'` — a second occurrence is a `ParseError` (`DUPLICATE_FLAG`)\n\nApplies to CLI token occurrences only — env/config/prompt/default\nresolution keeps its precedence semantics and never raises duplicates.\nOccurrences are counted per *logical* flag: aliases and the negated\nspelling all count toward the same flag.\n\nDefault: `'last'`"; }; }; }; readonly negation: { readonly description: "Negation settings for a boolean flag (set by `.negatable()`).\n\nThe negated spelling and the positive form are two spellings of ONE\nlogical flag: they share duplicate policy, and the last CLI occurrence\nwins across both. The negated spelling is presence-only — `--no-foo=x`\nis rejected."; readonly properties: { readonly alias: { readonly description: "Explicit negated spelling without the `--` prefix (e.g. `'no-sandbox'`).\n`undefined` synthesizes `no-` wherever the flag name is known."; }; readonly hidden: { readonly description: "Hide the negated spelling from help, completions, and suggestions."; }; }; }; readonly arg: { readonly description: "The runtime descriptor stored inside every ArgBuilder. Consumers (parser,\nhelp generator) read this to understand the arg's shape without touching\ngenerics."; readonly properties: { readonly name: { readonly description: "A named positional argument entry in the command schema.\n\nPairs a user-facing arg name with its ArgSchema descriptor.\nThe array ordering in CommandSchema.args determines CLI position."; }; readonly kind: { readonly description: "What kind of value this arg accepts."; }; readonly presence: { readonly description: "Presence describes whether a positional arg is guaranteed to exist when the\naction handler runs:\n\n- `'required'` — must be supplied; error if missing (default)\n- `'optional'` — may be `undefined` if not supplied\n- `'defaulted'` — always present (falls back to default value)"; }; readonly variadic: { readonly description: "Whether this arg consumes all remaining positionals."; }; readonly stdinMode: { readonly description: "Whether this arg may read from stdin during resolution.\n\nDefault: `false`"; }; readonly defaultValue: { readonly description: "Runtime default value (if any)."; }; readonly description: { readonly description: "Human-readable description for help text."; }; readonly envVar: { readonly description: "Environment variable name for env resolution.\n\nWhen set and the CLI value is absent, the resolver reads this env var\nand coerces the string to the arg's declared kind."; }; readonly enumValues: { readonly description: "Allowed literal values when `kind === 'enum'`."; }; readonly deprecated: { readonly description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated arg is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: ]`."; }; }; }; readonly prompt: { readonly description: "Discriminated union of all prompt configurations.\n\nUse the `kind` field to narrow:\n```ts\nif (config.kind === 'select') {\n config.choices // readonly SelectChoice[] | undefined\n}\n```"; readonly properties: { readonly kind: { readonly description: "The kind of interactive prompt to present.\n\n- `'confirm'` — yes/no boolean question\n- `'input'` — free-text string input\n- `'select'` — single selection from a list\n- `'multiselect'` — multiple selections from a list"; }; readonly message: { readonly description: "The question displayed to the user."; }; readonly placeholder: { readonly description: "Placeholder text shown before user types (informational only)."; }; readonly choices: { readonly description: "Available choices. When omitted for `enum` flags, the enum values\nfrom the flag schema are used automatically."; }; readonly min: { readonly description: "Minimum number of selections required.\n\nDefault: `0`"; }; readonly max: { readonly description: "Maximum number of selections allowed.\n\nDefault: `Infinity`"; }; }; }; readonly choice: { readonly description: "A selectable option for SelectPromptConfig and MultiselectPromptConfig prompts."; readonly properties: { readonly value: { readonly description: "The value returned when this choice is selected."; }; readonly label: { readonly description: "Display label shown to the user.\n\nDefault: value"; }; readonly description: { readonly description: "Optional description shown alongside the choice."; }; }; }; readonly example: { readonly description: "A single usage example shown in help text."; readonly properties: { readonly command: { readonly description: "The command invocation (e.g. `'deploy production --force'`)."; }; readonly description: { readonly description: "Optional description of what this example does."; }; }; }; }; }; //#endregion export { definitionMetaSchemaDescriptions };