interface Command

Common interface for all command types.

Properties

readonly
name: string

Name of the command.

Must consist of alphanumeric non-whitespace ASCII or _ and - characters. Cannot start with -.

readonly
optional
description: string

Optional description of the command.

readonly
optional
enableConfiguration: boolean

Optionally enable support for populating argument values via configuration. If this is true then default argument values may be sourced using a configuration source provided by the CLI runtime.

Usage

import type Command from ".";