=====================
container-tools Usage
=====================

Basic Usage
===========

container-tools has a command wrapper script, so you can invoke the command by the main :program:`container` script. Here we use the alias :program:`cnt`. The man page :manpage:`container(1)` shows all available container commands.

Create a new container
----------------------

.. code-block:: bash

   cnt create -n CONTAINER

.. Note:: always use FQDN as container name.

Start an existing container
---------------------------

.. code-block:: bash

   cnt start -n CONTAINER

Attach console to a started container
-------------------------------------

.. code-block:: bash

   cnt console -n CONTAINER

Stop an existing container
--------------------------

.. code-block:: bash

   cnt stop -n CONTAINER

Delete an existing container
----------------------------

.. code-block:: bash

   cnt remove -n CONTAINER

You may have to stop the container first.

List existing containers on the system
--------------------------------------

List all started and stopped containers of the local system::

   cnt list

List all started and stopped containers of the local system as a machine-readable list::

   cnt list -f short

List all started and other containers::

   cnt list -s -o

Show status of an container
---------------------------

Show detailed status of container foo.bar.org::

   cnt status -n foo.bar.org