.. _doot.cmds._interface:
  
====================
doot.cmds._interface
====================
  


.. py:module:: doot.cmds._interface

 









Protocols
---------

.. autoapisummary::

   doot.cmds._interface.AcceptsSubcmds_p
   doot.cmds._interface.Command_p





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


.. _doot.cmds._interface.AcceptsSubcmds_p:
  


.. py:class:: AcceptsSubcmds_p

   Bases: :py:obj:`Protocol` 
  
   Protocol for marking cmds as able to allow subcmds in cli parsing


   
   .. py:method:: _accept_subcmds() -> Literal[True]



 

.. _doot.cmds._interface.Command_p:
  


.. py:class:: Command_p

   Bases: :py:obj:`jgdv.cli._interface.CLIParamProvider_p`, :py:obj:`Protocol` 
  
   Holds command information and performs it


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


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


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


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


      A Handler called on doot shutting down. only the triggered cmd's shutdown gets called