walnut

README

walnut - the O² workflow administration and linting utility

The O² workflow administration and linting utility is a command line program for workflow configuration and import validation.

Configuration file

You can check the local walnut configuration with

$ walnut about

Using walnut

At any step, you can type $ walnut help <subcommand> to get information on what you can do and how, for example:

$ walnut help 
walnut is a command line program for interacting with the O² Workflow Administration and Linting Utility.

For more information on the available commands, see the individual documentation for each command.

Usage:
  walnut [command]

Available Commands:
  check       check the file passed against a specified schema.
  convert     Converts a DPL Dump to the required formats.
  help        Help about any command

Flags:
      --config string   optional configuration file for walnut (default $HOME/.config/walnut/settings.yaml)
  -h, --help            help for walnut

Use "walnut [command] --help" for more information about a command.

Validating a file

To check if a file conforms to the pre-defined schemas, run the check command:

$ walnut check

Example usage:

$ walnut check dump.json --format workflow 

A successful validation will return no output while any errors will cause the program to exit.

SEE ALSO

• walnut check

Converting a DPL Dump to Task/Workflow Templates

The goal of walnut is to convert O²/DPL generated dumps to the required number of task templates and workflow templates. The command used is convert:

$ walnut convert

Convert can also receive optional arguments to specify which modules to consider while generating task templates.

Example usage:

$ walnut convert dump.json --modules "TestValue1 TestValue2 TestValue3"

A successful validation will return no output while any errors will cause the program to exit.

SEE ALSO

• walnut convert