Whiz

Whiz (/wɪz/) is a modern DAG/tasks runner for multi-platform monorepos. It provides convenient live reloading, env management, pipes, and more in a tabbed view.

Whiz is part of the Metatype ecosystem. Consider checking out how this component integrates with the whole ecosystem and browse the documentation to see more examples.

Getting started

You can download the binary executable from releases page on GitHub, make it executable and add it to your $PATH or use the method below to automate those steps.

curl -fsSL https://raw.githubusercontent.com/zifeo/whiz/main/installer.sh | bash

# via cargo
cargo install whiz --locked 
cargo install --git https://github.com/zifeo/whiz --locked

# create your tasks file, see https://github.com/zifeo/whiz/blob/main/whiz.yaml for an example
touch whiz.yaml

# run
whiz

# upgrade
whiz upgrade

Usage

Configuration file

Environment variables for all tasks can be defined in the env section at root level. You can use Lade loaders when loading secrets (e.g. infisical://DOMAIN/PROJECT_NAME/ENV_NAME/SECRET_NAME).

env:
    [key]: [value]

All other root level keys are considered as tasks. Each time a dependency is load, the dependent task is also reloaded.

[task]:
    workdir: [working directory, by default .]
    command: [command]
    watch: [file or list of files]
    env:
        [key]: [value]
    env_file: [file or list of env files]
    depends_on: [task or list of task names for dependencies]
    pipes: # see https://github.com/zifeo/whiz/blob/main/whiz.yaml
        [regex]: [destination]

See this file for a complete example.

CLI options

See whiz --help for more information.

Key bindings

Development

cargo run --