.. _doot.cmds._base:
  
===============
doot.cmds._base
===============
  


.. py:module:: doot.cmds._base

 






Type Aliases
------------

.. autoapisummary::

   doot.cmds._base.ListVal







Classes
-------
  


.. autoapisummary::

    doot.cmds._base.BaseCommand

Module Contents
===============

.. py:data:: ListVal
   :type:  TypeAlias
   :value: Maybe[str | Lambda | tuple[str, dict]]



.. _doot.cmds._base.BaseCommand:
  


.. py:class:: BaseCommand(name: jgdv.Maybe[str] = None)

 
   Generic implementations of command methods


   .. py:attribute:: build_param
      :type:  collections.abc.Callable

   .. py:attribute:: _help
      :type:  ClassVar[tuple[str, Ellipsis]]

   .. py:attribute:: _name
      :value: None


   .. py:property:: name
      :type: str


      get command name as used from command line

   .. py:property:: help
      :type: list[str]


   .. py:property:: helpline
      :type: str


      get just the first line of the help text

   
   .. py:method:: param_specs() -> list[jgdv.cli.ParamSpec_p]


      Provide parameter specs for parsing into doot.args.cmds



   
   .. py:method:: _print_text(text: collections.abc.Iterable[ListVal]) -> None


      Utility method to print text out at the user level



   
   .. py:method:: shutdown(tasks: jgdv.structs.chainguard.ChainGuard, plugins: jgdv.structs.chainguard.ChainGuard, errored: jgdv.Maybe[doot.errors.DootError] = None) -> None