Tutorials

Welcome to the Cloacina tutorials. These guides will help you get started with Cloacina by walking you through specific tasks step by step.

Prerequisites

Before starting any tutorial, ensure you have the following installed:

Git
Docker Compose
Angreal (pip install angreal)

Available Tutorials

How to Use These Tutorials

Each tutorial is designed to be followed in sequence. They build upon each other to give you a complete understanding of how to use Cloacina effectively.

Running Tutorials with Angreal

To get started with a tutorial:

Clone the repository:

git clone https://github.com/colliery-io/cloacina.git
cd cloacina

The tutorials are stored in the docs/content/tutorials directory, with their corresponding implementations in the examples directory. Each tutorial is a separate markdown file that you can also read directly, and its implementation can be found in a matching directory under examples.
Run the tutorial using angreal:

angreal tutorial <tutorial-number>

For example, to run the “First Task” tutorial:

angreal tutorial 01

Tip

You can run the tutorials from any directory - you don’t need to be in the cloned repository. The angreal command will handle everything for you.

The tutorial number corresponds to the order in the table of contents above.