Command

Hierarchy

• Config
  • Command

Index

Properties

• category
• deprecated
• description
• hidden
• usage

Properties

optionalcategory

category?: string

The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category.

optionaldeprecated

deprecated?: boolean

Inherited from Config.deprecated

Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to false.

description

description: string

Inherited from Config.description

A description of what the object is and does. Supports basic markdown for bold, italics, and underline.

optionalhidden

hidden?: boolean

Inherited from Config.hidden

Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to false.

optionalusage

usage?: string | string[]

Define one or many usage examples to display in the help menu.