Interface UsageExample

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

interface UsageExample {
    description?: string;
    exampleArguments: string;
    output?: readonly string[];
}

Properties

description?: string

Optional description of the command example.

exampleArguments: string

The example arguments used to generate an example invocation.

This should not include the CLI or command name.

output?: readonly string[]

Optional output result of executing the example command.