:py:mod:`dissect.target.plugins.child.colima`
=============================================

.. py:module:: dissect.target.plugins.child.colima




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.child.colima.ColimaChildTargetPlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.child.colima.find_vms



.. py:function:: find_vms(path: pathlib.Path) -> collections.abc.Iterator[tuple[str, pathlib.Path, pathlib.Path]]

   Find the Lima VMs from Colima and yield the name, Colima configuration path and Lima VM path.

   .. rubric:: References

   - https://github.com/abiosoft/colima/blob/5ddf1e0dc67772f6e28f84c7c7b32f2343ad4bfb/config/profile.go#L19-L39


.. py:class:: ColimaChildTargetPlugin(target: dissect.target.Target)

   Bases: :py:obj:`dissect.target.plugin.ChildTargetPlugin`


   Child target plugin that yields Colima VMs.

   Colima is a container runtime for macOS and Linux.

   .. rubric:: References

   - https://github.com/abiosoft/colima


   .. py:attribute:: __type__
      :value: 'colima'



   .. py:attribute:: paths
      :value: []



   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with the current target (``self.target``).
      For example, check if a certain file exists. Otherwise it should raise an
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: list_children() -> collections.abc.Iterator[dissect.target.helpers.record.ChildTargetRecord]

      Yield :class:`~dissect.target.helpers.record.ChildTargetRecord` records of all
      possible child targets on this target.