qu

Qu

Qu is a CLI tool designed to simplify workflows to make them easy to share, replicate, and automate.

Why not use a script?

• Qu was designed to be simple and quick to design workflows that work together and serve some benefits over traditional scripts.
  • Flexible: Qu takes the workflow file and creates a file at $HOME/.qu that is loaded before every task. If you are running long jobs you can add and edit the YAML file without stopping execution.
  • Fast & Low Complexity: simple YAML format allows a transferable workflow that can be hosted in Docker or ran locally without needing to understand the ins and out of the code leading to quicker modifications.
  • Consistent Templates: Because they are stored as YAML files, qu files can be created as task templates that can be shared and stored easily. Templates can be created for workflows then reused with substituting variables as env variables durring execution.
  • Pretty CLI: Output to CLI is always organized without needing to create functions to print neatly.

Getting Started

1. Install qu

• go install -v github.com/jakewnuk/qu@latest

1. Prepare your workflow as a YAML file

• environment:
   bar: foo
   burr: ito
   foo: bar
  command:
  - echo $foo
  - echo $burr
  - echo $bar
  

1. Run qu

•  qu sample.yaml run
  
   Environmental Variables:
   foo=bar
   bar=foo
   burr=ito
  
   Task Queue:
   [0] echo $foo
   [1] echo $burr
   [2] echo $bar
  
   Running Tasks:
   [Aug 14 20:02:56] echo $foo                                               [ OK ]
   [Aug 14 20:02:56] echo $burr                                              [ OK ]
   [Aug 14 20:02:56] echo $bar                                               [ OK ]
  

Install

go install -v github.com/jakewnuk/qu@latest