BaseCommandOptions

@tsed/cli-core

Usage

import { BaseCommandOptions } from "@tsed/cli-core";

See /packages/cli-core/src/interfaces/CommandOptions.ts.

Overview

interface BaseCommandOptions<Input> {
    name: string;
    alias?: string;
    description: string;
    args?: {
        [key: string]: CommandArg;
    };
    inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>);
    options?: {
        [key: string]: CommandOpts;
    };
    allowUnknownOption?: boolean;
    enableFeatures?: string[];
    disableReadUpPkg?: boolean;
    renderMode?: TasksOptions["renderMode"];
}

name

name: string;

name commands

alias

alias?: string;

description

description: string;

CommandProvider description

args

args?: {
     [key: string]: CommandArg;
 };

CommandProvider arguments

inputSchema: JsonSchema

inputSchema?: JsonSchema<Input> | (() => JsonSchema<Input>);

options

options?: {
     [key: string]: CommandOpts;
 };

CommandProvider options

allowUnknownOption

allowUnknownOption?: boolean;

enableFeatures

enableFeatures?: string[];

disableReadUpPkg

disableReadUpPkg?: boolean;

renderMode

renderMode?: TasksOptions["renderMode"];