Class Command

Source: command.ts

Defines a shell command, including its execution logic, arguments requirements, and manual page.

Constructors

Constructor

new Command(): Command

Returns

Command

Properties

options

options: Option[] = []

---

manual?

optional manual?: Manual

---

requireArgs?

optional requireArgs?: boolean

---

requireOptions?

optional requireOptions?: boolean

---

execute

execute: Execute

The core logic to run when the command is invoked.

Methods

setName()

setName(name?: string): Command

Sets the command name and initializes the default usage string if not already set.

Parameters

name?

string

Returns

Command

---

setExecute()

setExecute(execute: Execute): Command

Parameters

execute

Execute

Returns

Command

---

setRequireArgs()

setRequireArgs(value: boolean): Command

Parameters

value

boolean

Returns

Command

---

setRequireOptions()

setRequireOptions(value: boolean): Command

Parameters

value

boolean

Returns

Command

---

setManual()

setManual(__namedParameters: Manual): Command

Parameters

__namedParameters

Manual

Returns

Command

---

addOption()

addOption(__namedParameters: Omit<Option, "isInput"> & { isInput?: boolean; }): Command

Registers a new option/flag for this command.

Parameters

__namedParameters

Omit<Option, "isInput"> & { isInput?: boolean; }

Returns

Command

---

getOption()

getOption(key: string): Option | undefined

Retrieves an option definition by either its short or long name.

Parameters

key

string

Returns

Option | undefined

Accessors

name

Get Signature

get name(): string

Returns

string