Skip to main content

Type Alias: CommandItemObject

CommandItemObject = ExtensionProperties & object

A command or command group, including arguments, flags, and examples.

Type Declaration​

summary?​

optional summary?: string

description?​

optional description?: string

aliases?​

optional aliases?: string[]

args?​

optional args?: ArgumentItemObject[]

flags?​

optional flags?: FlagItemObject[]

hidden?​

optional hidden?: boolean

kind?​

optional kind?: "action" | "group"

exitCodes?​

optional exitCodes?: ExitCodeObject[]

examples?​

optional examples?: CommandExampleObject[]