Usage¶

This page will give you an overview on how to use kiara via its command-line interface.

For a more walk-through introduction, have a look at the Getting started page.

Subcommands¶

Sub-command specific information can be found on the following pages:

run: run a workflow from the command-line
module: get information about modules and pipelines
data: get information about data in the kiara data store

Getting help¶

To get information for the kiara command itself use the --help flag:

kiara --help

[1m                                                                                [0m
[1m [0m[1;33mUsage: [0m[1mkiara [[0m[1;36mOPTIONS[0m[1m] [0m[1;36mCOMMAND[0m[1m [[0m[1;36mARGS[0m[1m]...[0m[1m                                      [0m[1m [0m
[1m                                                                                [0m
 [1;3mkiara[0m ia a data-orchestration framework; this is the command-line frontend for 
 it.                                                                            
 [2mFor more information, visit the [0m[1;2;3mkiara[0m[2;3m homepage[0m[2m: [0m                               
 [2mhttps://dharpa.org/kiara.documentation .[0m                                       

[2m╭─[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-config[0m     [1;32m-cnf[0m     [1;33mTEXT[0m  [1;36mA[0m kiara config file (or folder containing one    [2m│[0m
[2m│[0m                             named 'kiara.config').                           [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-context[0m    [1;32m-ctx[0m,[1;32m-c[0m  [1;33mTEXT[0m  The name of the kiara context to use (or the     [2m│[0m
[2m│[0m                             path to a context file).                         [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-pipelines[0m  [1;32m-p[0m       [1;33mTEXT[0m  File(s) and folder(s) that contain extra         [2m│[0m
[2m│[0m                             pipeline definitions.                            [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-plugin[0m     [1;32m-[0m[1;36mP[0m       [1;33mTEXT[0m  Ensure the provided plugin package(s) are        [2m│[0m
[2m│[0m                             installed in the virtual environment.            [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m       [1;32m-h[0m       [1;33m    [0m  Show this message and exit.                      [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2m╭─[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36mconfig         [0m[1;36m [0m Kiara config related sub-commands.                          [2m│[0m
[2m│[0m [1;36mcontext        [0m[1;36m [0m Kiara context related sub-commands.                         [2m│[0m
[2m│[0m [1;36mdata           [0m[1;36m [0m Data-related sub-commands.                                  [2m│[0m
[2m│[0m [1;36mdata-type      [0m[1;36m [0m Information about available data types.                     [2m│[0m
[2m│[0m [1;36mdoc            [0m[1;36m [0m Documentation helpers.                                      [2m│[0m
[2m│[0m [1;36mmodule         [0m[1;36m [0m Module-related sub-commands.                                [2m│[0m
[2m│[0m [1;36moperation      [0m[1;36m [0m Operation-related sub-commands.                             [2m│[0m
[2m│[0m [1;36mpipeline       [0m[1;36m [0m Pipeline-related sub-commands.                              [2m│[0m
[2m│[0m [1;36mrender         [0m[1;36m [0m Rendering-related sub-commands.                             [2m│[0m
[2m│[0m [1;36mrun            [0m[1;36m [0m Run a kiara operation.                                      [2m│[0m
[2m│[0m [1;36mworkflow       [0m[1;36m [0m Workflow-related sub-commands.                              [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m

The same goes for any of the sub (or sub-sub...) commands:

kiara module --help

[1m                                                                                [0m
[1m [0m[1;33mUsage: [0m[1mkiara module [[0m[1;36mOPTIONS[0m[1m] [0m[1;36mCOMMAND[0m[1m [[0m[1;36mARGS[0m[1m]...[0m[1m                               [0m[1m [0m
[1m                                                                                [0m
 Module-related sub-commands.                                                   

[2m╭─[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m  [1;32m-h[0m    Show this message and exit.                                    [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2m╭─[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36mexplain                  [0m[1;36m [0m Print details of a module type.                   [2m│[0m
[2m│[0m [1;36mexplain-instance         [0m[1;36m [0m Describe a module instance.                       [2m│[0m
[2m│[0m [1;36mlist                     [0m[1;36m [0m List available module data_types.                 [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m

Complex inputs¶

TBD