mini_arcade.cli.command_protocol

Base command module

Classes

CommandProtocol

Module Contents

class mini_arcade.cli.command_protocol.CommandProtocol

Bases: Protocol

Variables:

• name – Optional[str]: Command name (for registry); defaults to class name lowercased.

• aliases – Tuple[str, …]: Optional command aliases.

• summary – Optional[str]: Short description of the command.

• epilog – Optional[str]: Additional help text for the command.

• args – Optional[List[ArgumentType]]: List of command arguments.

• abstract – bool: If True, the command is not registered (base class

name: str | None

aliases: Tuple[str, Ellipsis] = ()

summary: str | None

epilog: str | None

args: List[mini_arcade.cli.argument_type.ArgumentType] | None

abstract: bool = False

classmethod define_arguments() → List[mini_arcade.cli.argument_type.ArgumentType]

Return the list of ArgumentType for this command.

Returns:

List of ArgumentType instances.

Return type:

List[ArgumentType]

validate(**_kwargs)

Optional argument validation hook.

execute(**kwargs)

External command entrypoint.