mini_arcade.cli.command_protocol
================================

.. py:module:: mini_arcade.cli.command_protocol

.. autoapi-nested-parse::

   Base command module



Classes
-------

.. autoapisummary::

   mini_arcade.cli.command_protocol.CommandProtocol


Module Contents
---------------

.. py:class:: CommandProtocol

   Bases: :py:obj:`Protocol`


   :ivar name: Optional[str]: Command name (for registry); defaults to class name lowercased.
   :ivar aliases: Tuple[str, ...]: Optional command aliases.
   :ivar summary: Optional[str]: Short description of the command.
   :ivar epilog: Optional[str]: Additional help text for the command.
   :ivar args: Optional[List[ArgumentType]]: List of command arguments.
   :ivar abstract: bool: If True, the command is not registered (base class


   .. py:attribute:: name
      :type:  Optional[str]


   .. py:attribute:: aliases
      :type:  Tuple[str, Ellipsis]
      :value: ()



   .. py:attribute:: summary
      :type:  Optional[str]


   .. py:attribute:: epilog
      :type:  Optional[str]


   .. py:attribute:: args
      :type:  Optional[List[mini_arcade.cli.argument_type.ArgumentType]]


   .. py:attribute:: abstract
      :type:  bool
      :value: False



   .. py:method:: define_arguments() -> List[mini_arcade.cli.argument_type.ArgumentType]
      :classmethod:


      Return the list of ArgumentType for this command.

      :return: List of ArgumentType instances.
      :rtype: List[ArgumentType]



   .. py:method:: validate(**_kwargs)

      Optional argument validation hook.



   .. py:method:: execute(**kwargs)

      External command entrypoint.