Interface: Command<Name, Parameters, Flags>

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

Extends

• CommandOptions<Parameters, Flags>

Type Parameters

Type Parameter	Default type
Name extends string	string
Parameters extends readonly ParameterDefinitionValue[]	readonly ParameterDefinitionValue[]
Flags extends ClercFlagsDefinition	ClercFlagsDefinition

Properties

Property	Type	Description	Inherited from	Defined in
alias?	MaybeArray<string>	‐	CommandOptions.alias	packages/core/src/types/command.ts:15
completions?	object	Completions options for the command.	CommandOptions.completions	packages/plugin-completions/src/index.ts:17
completions.handler?	(command) => void	Handler to provide custom completions for the command.	‐	packages/plugin-completions/src/index.ts:27
completions.show?	boolean	Whether to show the command in completions output. Default true;	‐	packages/plugin-completions/src/index.ts:23
description?	string	‐	‐	packages/core/src/types/command.ts:33
flags?	Flags	‐	CommandOptions.flags	packages/core/src/types/command.ts:17
help?	CommandHelpOptions	Help options for the command.	CommandOptions.help	packages/plugin-help/src/index.ts:47
ignore?	IgnoreFunction	A callback function to conditionally stop parsing. When it returns true, parsing stops and remaining arguments are preserved in ignored.	CommandOptions.ignore	packages/core/src/types/command.ts:23
name	Name	‐	‐	packages/core/src/types/command.ts:32
parameters?	Parameters	‐	CommandOptions.parameters	packages/core/src/types/command.ts:16