Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICommandExampleDefinition

Example command definition - used on command definitions to present examples for the user in the help.

Hierarchy

  • ICommandExampleDefinition

Index

Properties

description

description: string

The example description - what does it do?

options

options: string

Options for the example command - should be copy/paste-able - besides variable data - i.e. user name

Optional prefix

prefix: string

Text to prepend to the command and options in the example. Useful for commands that read stdin e.g. "echo hello |"

Generated using TypeDoc