Skip to main content

Flag

Hierarchy

  • Omit<Option<boolean>, format | validate>
    • Flag

Index

Properties

Properties

optionalcategory

category?: string

A unique key to group options within categories. Couples with the Category type.

optionaldefault

default?: boolean

optionaldeprecated

deprecated?: boolean

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

description

description: string

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

optionalhidden

hidden?: boolean

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

optionalshort

short?: ShortOptionName

Single character used as a the short option alias.

type

type: boolean

Expected type of the provided value. When a value is captured from the command line, it will be type casted.