Interface: Command<Name, Parameters, Flags>

Defined in: packages/core/src/types/command.ts:23

Extends

• CommandOptions<Parameters, Flags>

Type Parameters

Name

Name extends string = string

Parameters

Parameters extends readonly string[] = readonly string[]

Flags

Flags extends ClercFlagsDefinition = ClercFlagsDefinition

Properties

alias?

optional alias: MaybeArray<string>;

Defined in: packages/core/src/types/command.ts:13

Inherited from

CommandOptions.alias

---

completions?

optional completions: object;

Defined in: packages/plugin-completions/src/index.ts:12

Completions options for the command.

show?

optional show: boolean;

Whether to show the command in completions output.

Default

true;

Inherited from

CommandOptions.completions

---

description

description: string;

Defined in: packages/core/src/types/command.ts:29

---

flags?

optional flags: Flags;

Defined in: packages/core/src/types/command.ts:15

Inherited from

CommandOptions.flags

---

help?

optional help: CommandHelpOptions;

Defined in: packages/plugin-help/src/index.ts:43

Help options for the command.

Inherited from

CommandOptions.help

---

ignore?

optional ignore: IgnoreFunction;

Defined in: packages/core/src/types/command.ts:20

A callback function to conditionally stop parsing. When it returns true, parsing stops and remaining arguments are preserved in ignored.

Inherited from

CommandOptions.ignore

---

name

name: Name;

Defined in: packages/core/src/types/command.ts:28

---

parameters?

optional parameters: Parameters;

Defined in: packages/core/src/types/command.ts:14

Inherited from

CommandOptions.parameters