interface UsageExample

A usage example for a SubCommand to be used in help output.

Properties

readonly
exampleArguments: string

The example arguments used to generate an example invocation.

This should not include the CLI or command name.

readonly
optional
description: string

Optional description of the command example.

readonly
optional
output: ReadonlyArray<string>

Optional output result of executing the example command.

Usage

import type UsageExample from ".";