zrb

Documentation

🤖 Zrb: Your Automation Powerhouse

Zrb allows you to write your automation tasks in Python and declaratively:

# Filename: zrb_init.py
from zrb import cli, Task, Group, IntInput

math = cli.add_group(Group("math", description="Math tools"))
math.add_task(Task(
    name="add",
    input=[
        IntInput("a", description="First number"),
        IntInput("b", description="Second number")
    ],
    action=lambda ctx: ctx.input.a + ctx.input.b
))

Once defined, you will be able to access your automation tasks from the CLI, Web Interface, or via HTTP API.

For more complex scenario, you can also defined Task dependencies (upstreams) and retry mechanisms. You can also make a scheduled tasks, just like in Apache Airflow.

Furthermore, Zrb has some builtin tasks to manage monorepo, generate FastAPI application, or play around with LLM.

See the getting started guide for more information. Or just watch the demo:

🫰 Installing Zrb

You can install Zrb as a pip package by invoking the following command:

pip install --pre zrb

Alternatively, you can also use our installation script to install Zrb along with some prerequisites:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/refs/heads/1.0.0/install.sh)"
# bash -c "$(curl -fsSL https://raw.githubusercontent.com/state-alchemists/zrb/main/install.sh)"

🐞 Bug Report + Feature Request

You can submit bug reports and feature requests by creating a new issue on Zrb's GitHub Repositories. When reporting a bug or requesting a feature, please be sure to:

• Include the version of Zrb you are using (i.e., zrb version)
• Tell us what you have tried
• Tell us what you expect
• Tell us what you get

We will also welcome your pull requests and contributions.

☕ Donation

Help Red Skull to click the donation button:

🎉 Fun Fact

Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. (Garo Wiki | Fandom)