Ix runner

The Ix runner is installed with the package. It is the entry point to use Ix. To run a task type:

ix my_task

Arguments and Flags

Command line arguments and flags are passed to tasks as args and kwargs to the task.

An example and the equivilant call in python.

ix my_task arg1 arg2 --flag --two=2

my_task('arg1', 'arg2', flag=True, two=2)

Builtin options

All tasks have a set of built in options.

--force

Run the task regardless of whether checkers determine the task is complete.

--force-all

Run the full dependency tree regardless of completion state.

--clean

Clean up task artifacts before running the task. This implies --force

--clean-all

Clean up all dependencies before running the dependencies. This implies --force-all.

--show

Display the dependency tree including which tasks pass their checks.

Builtin help

A list of available commands is available by calling ix or ix --help.

Access built-in help for any task by calling ix help my_task. Builtin help should display how to use the task, enumerate any relevent environment variables, and display the status of any checks.

Ixian.py location

By default ix will look for ixian.py in the current working directory. This may be changed at runtime by setting IXIAN_CONFIG.

IXIAN_CONFIG=/path/to/a/different/file.py ix my_task