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

### Hierarchy

- ICommandExampleDefinition

## Index

### Properties

- description
- options
- prefix

## Properties

### description

description: string

- Defined in @zowe/imperative/src/cmd/src/doc/ICommandExampleDefinition.ts:23

The example description - what does it do?

### options

options: string

- Defined in @zowe/imperative/src/cmd/src/doc/ICommandExampleDefinition.ts:19

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

### Optional prefix

prefix: string

- Defined in @zowe/imperative/src/cmd/src/doc/ICommandExampleDefinition.ts:29

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

Generated using TypeDoc