Install
=======


There are two install options:

Download the binary
-------------------

Binaries are available for Linux, OSX, and Windows. Download a binary from
`github.com/dnephin/dobi/releases <https://github.com/dnephin/dobi/releases>`_

Chocolatey
----------

For Windows, you can install via the `Chocolatey package <https://chocolatey.org/packages/dobi>`_

.. code:: sh

    choco install dobi


Install from source
-------------------

.. code:: sh

    git clone git@github.com:dnephin/dobi && cd dobi
    docker run -ti --rm -w $(pwd) -v $(pwd):$(pwd) -e DOCKER_HOST \
        -v /var/run/docker.sock:/var/run/docker.sock \
        dnephin/dobi:0.13.0 deps binary

The binaries will be in ``./dist/bin``

Overview
--------

To run a task use the name of the resource from the ``dobi.yml`` config. For
example to run a ``job=test`` resource:

.. code:: sh

    dobi test

Each resources has a default action which creates the resource, and multiple
actions to manage and remove the resource. To remove a resource use the ``:rm``
action:

.. code:: sh

    dobi test:rm


Usage
-----

.. literalinclude:: ../gen/usage.txt