@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface GlobalCommand

    Interface for a global command.

    interface GlobalCommand {
        argument?: GlobalCommandArgument;
        description?: string;
        disableGenericHelpDisplay?: boolean;
        enableConfiguration?: boolean;
        name: string;
        shortAlias?: string;
        execute(
            context: Context,
            argumentValue?: ArgumentSingleValueType,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    argument? description? disableGenericHelpDisplay? enableConfiguration? name shortAlias?
    execute
    argument?: GlobalCommandArgument

    Optional GlobalCommandArgument for the command.

    description?: string

    Optional description of the command.

    disableGenericHelpDisplay?: boolean

    Optionally hide the command from generic help listings. The command remains registered and executable, and its own usage help (help <command>) is still shown if explicitly requested.

    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.

    name: string

    Name of the command.

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

    shortAlias?: string

    Optional short alias for the global command.

    Must consist of a single alphanumeric non-whitespace ASCII character.

    • Execute the command.

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods